BIS fnc wpTimed: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(34 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| TKOH |= Game name
|game1= tkoh
|version1= 1.00


|1.00|= Game version
|gr1= Waypoints
____________________________________________________________________________________________


| COUNTDOWN [[Custom_Waypoints|custom waypoint]].
|exec= spawn
 
|descr= COUNTDOWN [[Custom_Waypoints|custom waypoint]].


Player has to reach waypoint area before time runs out.
Player has to reach waypoint area before time runs out.
|DESCRIPTION=
____________________________________________________________________________________________


| [[Custom_Waypoints#Function|arguments]]: [failCode,timeLimit,showHint] |SYNTAX=
|s1= [[Custom Waypoints#Function|Custom Waypoint arguments]]: [failCode,timeLimit,showHint]


|p1= failCode: [[Code]] - code executed when time runs oout before player reach the waypoint (default: {}) |=
|p1= failCode: [[Code]] - (Optional, default <sqf inline>{}</sqf> code executed when time runs oout before player reach the waypoint


|p2= timeLimit: [[Number]] - limit in seconds (default: 30s) |=
|p2= timeLimit: [[Number]] - (Optional, default 30) limit in seconds


|p3= showHint: [[Boolean]] - true to show info about time left (default: false) |=
|p3= showHint: [[Boolean]] - (Optional, default [[false]]) [[true]] to show info about time left


| [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]
____________________________________________________________________________________________
 
|x1= <code><nowiki>[</nowiki>[[player]],[[position]] dude,100,{[[hintC]] "You failed!"},42,true] [[spawn]] BIS_fnc_wpTimed;</code> |EXAMPLE1=


____________________________________________________________________________________________
|x1= <sqf>[player, position dude, 100, { hintC "You failed!" }, 42, true] spawn BIS_fnc_wpTimed;</sqf>
| exec=spawn |=
 
| |SEEALSO=


|seealso=
}}
}}
<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:Take_On_Helicopters:_Functions|wpTimed]]
[[Category:Function Group: Waypoints|wpTimed]]

Latest revision as of 14:42, 25 July 2022

tkoh logo small.png1.00
Hover & click on the images for description

Description

Description:
COUNTDOWN custom waypoint. Player has to reach waypoint area before time runs out.
Execution:
spawn
Groups:
Waypoints

Syntax

Syntax:
Custom Waypoint arguments: [failCode,timeLimit,showHint]
Parameters:
failCode: Code - (Optional, default {} code executed when time runs oout before player reach the waypoint
timeLimit: Number - (Optional, default 30) limit in seconds
showHint: Boolean - (Optional, default false) true to show info about time left
Return Value:
Nothing

Examples

Example 1:
[player, position dude, 100, { hintC "You failed!" }, 42, true] spawn BIS_fnc_wpTimed;

Additional Information

See also:
See also needed

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_wpTimed&oldid=329167"