triggerTimeoutCurrent: Difference between revisions

From Bohemia Interactive Community
(note -> informative)
m (Some wiki formatting)
 
(35 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.08


|1.08|= Game version
|arg= global
|arg= global|= Arguments in MP
|eff= local |= Effects in MP
____________________________________________________________________________________________


| Returns current timeout of the given trigger or -1 if countdown is not in progress.
|gr1= Triggers
<br><br>
{{Informative |The trigger could be local or remote but the result returned by this command will be for the trigger condition set up locally on the client that executed the command. See [[createTrigger]] for more info}}|= Description
____________________________________________________________________________________________


| '''triggerTimeoutCurrent''' trigger |= Syntax
|descr= Returns current timeout of the given trigger or -1 if countdown is not in progress.


|p1= trigger: [[Object]] - trigger object|= Parameter 1
{{Feature|important|
The trigger could be [[Multiplayer Scripting#Locality|local]] or remote but the result returned by this command will be for the current trigger timeout local to the client that executed the command.
See [[createTrigger]] for more info.
}}


| [[Number]] - time remaining before trigger activation.
|s1= [[triggerTimeoutCurrent]] trigger


|= RETURNVALUE
|p1= trigger: [[Object]] - trigger object


|x1= <code>_remaining = [[triggerTimeoutCurrent]] _trigger;</code>|= EXAMPLE1
|r1= [[Number]] - time remaining before trigger activation.
____________________________________________________________________________________________


| [[triggerTimeout]], [[setTriggerTimeout]], [[waypointTimeoutCurrent]] |= SEEALSO
|x1= <sqf>_remaining = triggerTimeoutCurrent _trigger;</sqf>


| |= MPBEHAVIOUR
|seealso= [[triggerTimeout]] [[setTriggerTimeout]] [[waypointTimeoutCurrent]]
____________________________________________________________________________________________
}}
}}


<h3 style='display:none'>Notes</h3>
{{Note
<dl class='command_description'>
|user= Killzone_Kid
<!-- Note Section BEGIN -->
|timestamp= 20131126121600
<dd class="notedate">Posted on November 26, 2013
|text= Triggers have their own schedule. If you create a trigger with timeout and try to read [[triggerTimeoutCurrent]] immediately it will return -1.
<dt class="note">'''[[User:Killzone_Kid|Killzone_Kid]]'''
This is because the countdown will not start until the next scheduled trigger check is due, and this could take up to 0.5 seconds.
<dd class="note">
}}
Triggers have their own schedule. If you create a trigger with timeout and try to read [[triggerTimeoutCurrent]] immediately it will return -1. This is because the countdown will not start until the next scheduled trigger check is due, and this could take up to 0.5 seconds.
 
 
<!-- Note Section END -->
</dl>
 
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 10:15, 1 September 2025

Hover & click on the images for description

Description

Description:
Returns current timeout of the given trigger or -1 if countdown is not in progress.
The trigger could be local or remote but the result returned by this command will be for the current trigger timeout local to the client that executed the command. See createTrigger for more info.
Groups:
Triggers

Syntax

Syntax:
triggerTimeoutCurrent trigger
Parameters:
trigger: Object - trigger object
Return Value:
Number - time remaining before trigger activation.

Examples

Example 1:
_remaining = triggerTimeoutCurrent _trigger;

Additional Information

See also:
triggerTimeout setTriggerTimeout waypointTimeoutCurrent

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
Killzone_Kid - c
Posted on Nov 26, 2013 - 12:16 (UTC)
Triggers have their own schedule. If you create a trigger with timeout and try to read triggerTimeoutCurrent immediately it will return -1. This is because the countdown will not start until the next scheduled trigger check is due, and this could take up to 0.5 seconds.