Briefing – Arma 2

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[ *((ftp|http)s?:\/\/[^ ]+)([^{])=([^}])([^ ]+)" to "[$1$3{{=}}$4$5")
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The briefing is an essential part of any mission. It usually displays a synopsis of what to do to complete the mission, as well as objectives.
The briefing is an essential part of any mission. It usually displays a synopsis of what to do to complete the mission, as well as objectives.


Prior to Arma 2, briefings were constructed via a [[Briefing.html]] file.
Prior to {{arma2}}, briefings were constructed through a [[Briefing.html]] file.


== Briefings in Arma 2 ==
{{Feature|arma3|For {{arma3}} briefing, see [[Arma 3: Briefing]].}}
 
 
== Briefings ==


=== Adding Notes ===
=== Adding Notes ===
Example:
Example:
[[player]] [[createDiaryRecord]] ["Diary", ["Situation", "Things are looking bad."]];
<sqf>player createDiaryRecord ["Diary", ["Situation", "Things are looking bad."]];</sqf>


This adds a note called 'Situation', and when you click on that a bigger message screen comes up with the message 'Things are looking bad.'
This adds a note called 'Situation', and when you click on that a bigger message screen comes up with the message 'Things are looking bad.'


=== Adding Tasks in Arma 2 ===
=== Adding Tasks ===
 
See [[Tasks]].
See [[Tasks]].
Example:
Example:
tskExample1 = [[player]] [[createSimpleTask]] ["Task Message"];
<sqf>
tskExample1 [[setSimpleTaskDescription]] ["Task Message", "Task Title", "Task HUD Title"];
tskExample1 = player createSimpleTask ["Task Message"];
tskExample1 [[setSimpleTaskDestination]] ([[getMarkerPos]] "mkrObj1");
tskExample1 setSimpleTaskDescription ["Task Message", "Task Title", "Task HUD Title"];
{{codecomment|// Make sure you have an empty marker called 'mkrObj1'
// and you'll see a semi-transparant circular marker which will light up when you set the task as active.}}


// Make sure you have an empty marker called 'mkrObj1'
// and you will see a semi-transparant circular marker which will light up when you set the task as active.
tskExample1 setSimpleTaskDestination (getMarkerPos "mkrObj1");
</sqf>


In your diary, "Task Title" is displayed for each task you set, and when you click on each task, it's "Task Message" appears. And "Task HUD Title" is what gets shown on the HUD.
In your diary, "Task Title" is displayed for each task you set, and when you click on each task, it is "Task Message" appears. And "Task HUD Title" is what gets shown on the HUD.


We force a task upon a player by executing this on his machine:
We force a task upon a player by executing this on his machine:
[[player]] [[setCurrentTask]] tskExample1; {{codecomment|// This will highlight the objective marker, and show him the through the HUD where the objective is.}}
<sqf>player setCurrentTask tskExample1; // This will highlight the objective marker, and show him the through the HUD where the objective is.</sqf>


We alter the task status during the mission by the following options:
We alter the task status during the mission by the following options:
tskExample1 [[setTaskState]] "SUCCEEDED"; {{codecomment|// Makes the checkbox green}}
<sqf>
tskExample1 [[setTaskState]] "FAILED";   {{codecomment|// Puts a red cross in the checkbox}}
tskExample1 setTaskState "SUCCEEDED"; // Makes the checkbox green
tskExample1 [[setTaskState]] "CANCELED"; {{codecomment|// Puts a grey diagonal line through the checkbox}}
tskExample1 setTaskState "FAILED"; // Puts a red cross in the checkbox
tskExample1 [[setTaskState]] "CREATED";   {{codecomment|// Clears the checkbox (makes it look like you've just created it)}}
tskExample1 setTaskState "CANCELED"; // Puts a grey diagonal line through the checkbox
 
tskExample1 setTaskState "CREATED"; // Clears the checkbox (makes it look like you've just created it)
You can show the state of the task with the [[taskHint]] command, or for an alternative method see this [http://www.ofpec.com/forum/index.php?topic=33768.0 OFPEC topic].
</sqf>
 
=== Adding tasks in Arma 3 ===
See [[Arma 3 Tasks Overhaul]].
 
=== Formatting tags for tasks and notes ===
There are many formatting tags that can be incorporated in the strings for tasks and notes:
 
* To add a link to a marker: <marker name='obj1'>Link to Marker</marker>
* To show an image: <tt><img image='somePic.jpg'/></tt>
** Manipulate the image width and height like so: <tt><img image='somePic.jpg' width='200' height='200'/></tt>
* Coloured text: <noWiki><font color='#A52A2A'>Some text</font color></noWiki>
* Line break can be added with: <noWiki><br/></noWiki>
 
'''Example:'''
*<img image='\A3\weapons_F\Rifles\Khaybar\Data\UI\gear_Khaybar_GL_X_CA.paa' width='300' height='200'/>
*<noWiki><br/></noWiki>
*<noWiki><font color='#A52A2A'>Some text</font color></noWiki>
*<execute expression='One = 1; systemChat str One;'>Some expression</execute></font color>
 
[[File:A3 Briefing Formatting Example.jpg|left]]


== See also ==
You can show the state of the task with the [[taskHint]] command, or for an alternative method see this [http://www.ofpec.com/forum/index.php?topic{{=}}33768.0 OFPEC topic].
[[Tasks]], [[Briefing.html]], [[Arma 3 Tasks Overhaul]]




[[Category:ArmA_2:_Editing]]
[[Category:Briefing]]
[[Category:Arma_3:_Editing]]
[[Category:Scripting Topics]]

Latest revision as of 18:20, 28 April 2023

The briefing is an essential part of any mission. It usually displays a synopsis of what to do to complete the mission, as well as objectives.

Prior to Arma 2, briefings were constructed through a Briefing.html file.

Arma 3
For Arma 3 briefing, see Arma 3: Briefing.


Briefings

Adding Notes

Example:

player createDiaryRecord ["Diary", ["Situation", "Things are looking bad."]];

This adds a note called 'Situation', and when you click on that a bigger message screen comes up with the message 'Things are looking bad.'

Adding Tasks

See Tasks. Example:

tskExample1 = player createSimpleTask ["Task Message"]; tskExample1 setSimpleTaskDescription ["Task Message", "Task Title", "Task HUD Title"]; // Make sure you have an empty marker called 'mkrObj1' // and you will see a semi-transparant circular marker which will light up when you set the task as active. tskExample1 setSimpleTaskDestination (getMarkerPos "mkrObj1");

In your diary, "Task Title" is displayed for each task you set, and when you click on each task, it is "Task Message" appears. And "Task HUD Title" is what gets shown on the HUD.

We force a task upon a player by executing this on his machine:

player setCurrentTask tskExample1; // This will highlight the objective marker, and show him the through the HUD where the objective is.

We alter the task status during the mission by the following options:

tskExample1 setTaskState "SUCCEEDED"; // Makes the checkbox green tskExample1 setTaskState "FAILED"; // Puts a red cross in the checkbox tskExample1 setTaskState "CANCELED"; // Puts a grey diagonal line through the checkbox tskExample1 setTaskState "CREATED"; // Clears the checkbox (makes it look like you've just created it)

You can show the state of the task with the taskHint command, or for an alternative method see this OFPEC topic.

Retrieved from "https://community.bistudio.com/wiki?title=Arma_2:_Briefing&oldid=339780"