Skip to content

Commit

Permalink
Added documentation for the update XPTBriefings behaviour.
Browse files Browse the repository at this point in the history
Bumped the version number to 0.4.3.
  • Loading branch information
Superxpdude committed Jun 17, 2019
1 parent b33f006 commit 0ccb146
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
16 changes: 12 additions & 4 deletions config/XPTBriefings.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,19 @@
entryName = "Title"; // Briefing title. This is usually something like "Situation", "Mission", "Assets", etc.
entryText = "Text"; // Briefing text. Formatted as structured text, contains the contents of your briefing.
onStart = 1; // Briefing on start. Determines if the briefing should be created upon mission start. Set to 0 to disable.
sides[] = {0,1,2,3}; // Briefing sides. Determines which sides will receive the briefing message on mission start. Good for TvTs.
sides[] = {-1,0,1,2,3,4}; // Briefing sides. Determines which sides will receive the briefing message on mission start. Good for TvTs.
};
Briefings will appear ordered from bottom to top as they're listed here.
This is because the game adds new briefings to the top of the list, and the template adds the briefings from top to bottom.
The "sides" array is used to limit the briefing to specific players, details are below:
(-1): All players, regardless of side
(0): BLUFOR players
(1): OPFOR players
(2): INDEPENDENT players
(3): CIVILIAN players
(4): LOGIC players (zeus units mostly)
*/

class briefings
Expand All @@ -27,23 +35,23 @@ class briefings
entryName = "Assets";
entryText = "Example Assets List. REPLACE BEFORE RUNNING THE MISSION.<br/> - 1x Car<br/> - 1x Tank<br/> - 1x Boat<br/> - 1x Plane";
onStart = 1;
sides[] = {0,1,2,3};
sides[] = {-1};
};
class mission // Example mission briefing. Should include a brief overview of the player's tasks.
{
category = "Diary";
entryName = "Mission";
entryText = "Example Mission Briefing. REPLACE BEFORE RUNNING THE MISSION<br/>. We need to get the bad guy.";
onStart = 1;
sides[] = {0,1,2,3};
sides[] = {-1};
};
class situation // Example situation briefing. Should include a bit of backstory to your mission.
{
category = "Diary";
entryName = "Situation";
entryText = "Example Situation. REPLACE BEFORE RUNNING THE MISSION<br/>. The bad guy did a bad thing. We need to stop him!";
onStart = 1;
sides[] = {0,1,2,3};
sides[] = {-1};
};
*/
};
2 changes: 1 addition & 1 deletion template/version.hpp
Original file line number Diff line number Diff line change
@@ -1 +1 @@
#define __XPTVERSION__ "0.4.2"
#define __XPTVERSION__ "0.4.3"

0 comments on commit 0ccb146

Please sign in to comment.