triggerTimeoutCurrent: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...) |
||
| Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma3 | | arma3 | ||
|1.08 | |1.08 | ||
|arg= global | |arg= global | ||
|gr1= Triggers | |gr1= Triggers | ||
| Returns current timeout of the given trigger or -1 if countdown is not in progress. | | Returns current timeout of the given trigger or -1 if countdown is not in progress. | ||
{{Important | 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.}} | {{Important | 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.}} | ||
| [[triggerTimeoutCurrent]] trigger | | [[triggerTimeoutCurrent]] trigger | ||
|p1= trigger: [[Object]] - trigger object | |p1= trigger: [[Object]] - trigger object | ||
| [[Number]] - time remaining before trigger activation. | | [[Number]] - time remaining before trigger activation. | ||
|x1= <code>[[private]] _remaining = [[triggerTimeoutCurrent]] _trigger;</code> | |x1= <code>[[private]] _remaining = [[triggerTimeoutCurrent]] _trigger;</code> | ||
| [[triggerTimeout]], [[setTriggerTimeout]], [[waypointTimeoutCurrent]] | | [[triggerTimeout]], [[setTriggerTimeout]], [[waypointTimeoutCurrent]] | ||
}} | }} | ||
Revision as of 11:24, 18 January 2021
Description
- Description:
- Returns current timeout of the given trigger or -1 if countdown is not in progress.
- Groups:
- Triggers
Syntax
- Syntax:
- triggerTimeoutCurrent trigger
- Parameters:
- trigger: Object - trigger object
- Return Value:
- Number - time remaining before trigger activation.
Examples
- Example 1:
private _remaining = triggerTimeoutCurrent _trigger;
Additional Information
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
Notes
- Posted on November 26, 2013
- Killzone_Kid
- 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.