BIS fnc briefingAnimate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(31 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.78


| arma3 |= Game name
|gr1= Briefing


|1.00|= Game version
|descr= Animate briefing markers.
____________________________________________________________________________________________


| <pre>/*
|s1= [markerName, stepId, delay] call [[BIS_fnc_briefingAnimate]]
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
</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 {{hl|&lt;''markerName''&gt;_&lt;''stepId''&gt;}})


|p1= |= Parameter 1
|p3= delay: [[String]] - commit time (transition duration)


| |= Return value
|r1= [[Nothing]]
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <sqf>
____________________________________________________________________________________________
// given you have 6 markers:
 
// - "myMarker"
| |= See also
// - "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;
};
</sqf>


|seealso= [[BIS_fnc_briefingInit]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Briefing|{{uc:briefingAnimate}}]]
[[Category:Functions|{{uc:briefingAnimate}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:briefingAnimate}}]]

Latest revision as of 12:03, 13 July 2022

Hover & click on the images for description

Description

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

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