BIS fnc briefingAnimate: Difference between revisions

Revision as of 14:58, 4 June 2018

1.00

Hover & click on the images for description

Description

Description:: Animate briefing markers.
Execution:: call
Groups:: Uncategorised

Syntax

Syntax:: [markerName, stepId, delay] call BIS_fnc_briefingAnimate
Parameters:: markerName: String - marker to animate
: stepId: Number - step ID (steps are invisible markers named <markerName>_<stepId>)
: delay: String - commit time (transition duration)
Return Value:: Nothing

Examples

Example 1:: // given you have 6 markers: // - "myMarker" // - "myMarker_0" // - "myMarker_1" // - "myMarker_2" // - "myMarker_3" // - "myMarker_4" for "_i" from 0 to 4 do { private _commit = 1; ["myMarker", 5, _commit] call BIS_fnc_briefingAnimate; sleep _commit; };

Additional Information

See also:: BIS_fnc_briefingInit

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

@@ Line 1: / Line 1: @@
+{{Function|Comments=
+____________________________________________________________________________________________
+| arma3 |Game name=
-{{Function|= Comments
+|1.00|Game version=
 ____________________________________________________________________________________________
-| arma3 |= Game name
+| Animate briefing markers. |Description=
-|1.00|= Game version
 ____________________________________________________________________________________________
-| <pre>/*
+| [markerName, stepId, delay] call [[BIS_fnc_briefingAnimate]] |Syntax=
-	Description:
-	Animate briefing markers.
-	Parameters:
-		_this select 0: STRING - Marker to animate.
-		_this select 1: NUMBER - Marker ID.
-		_this select 2: NUMBER - Commit time.
-	Returns:
-	Nothing.
-*/
-// Determine the marker, its ID & the commit time
+|p1= markerName: [[String]] - marker to animate |Parameter 1=
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_briefingAnimate]]; --> |= Syntax
+|p2= stepId: [[Number]] - step ID (steps are invisible markers named <tt>&lt;''markerName''&gt;_&lt;''stepId''&gt;</tt>) |Parameter 2=
-|p1= |= Parameter 1
+|p3= delay: [[String]] - commit time (transition duration) |Parameter 3=
-| |= Return value
+| [[Nothing]] |Return value=
 ____________________________________________________________________________________________
-|x1= <code></code> |=
+|x1= <code>{{codecomment|// given you have 6 markers:
+// - "myMarker"
+// - "myMarker_0"
+// - "myMarker_1"
+// - "myMarker_2"
+// - "myMarker_3"
+// - "myMarker_4"}}
+[[for]] "_i" [[from]] 0 [[to]] 4 [[do]] {
+	[[private]] _commit = 1;
+	["myMarker", 5, _commit] [[call]] [[BIS_fnc_briefingAnimate]];
+	sleep _commit;
+};</code> |Example 1=
 ____________________________________________________________________________________________
-| |= See also
+| [[BIS_fnc_briefingInit]] |See also=
 }}
@@ Line 48: / Line 46: @@
 <h3 style="display:none">Bottom Section</h3>
+[[Category:Functions|{{uc:briefingAnimate}}]]
 [[Category:Function Group: Briefing|{{uc:briefingAnimate}}]]
-[[Category:Functions|{{uc:briefingAnimate}}]]
 [[Category:{{Name|arma3}}: Functions|{{uc:briefingAnimate}}]]