canSuspend: Difference between revisions
Jump to navigation
Jump to search
Ilias38rus (talk | contribs) (in FSM, the code which can contain this command is executed unscheduled . im not sure about SQS, but the deleted statement is very misleading for FSM) |
Lou Montana (talk | contribs) m (Fix the fix) |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
|gr2= Program Flow | |gr2= Program Flow | ||
|descr= Returns [[true]] if [[sleep]], [[uiSleep]] or [[waitUntil]] commands can be used in current scope. Usually when suspension is not allowed but used, for example when code is executed in [[Scheduler# | |descr= Returns [[true]] if [[sleep]], [[uiSleep]] or [[waitUntil]] commands can be used in the current scope. | ||
Usually when suspension is not allowed but used, for example when code is executed in [[Scheduler#Unscheduled Environment|unscheduled environment]], the script engine would ignore any suspension command and throw error: "Suspending not allowed in this context". | |||
Using [[canSuspend]] command allows to detect the correct environment for the code. | |||
| | {{Feature|informative| | ||
The definition of [[Scheduler#Scheduled Environment|scheduled]] and [[Scheduler#Unscheduled Environment|unscheduled environment]] is not the same as whether or not the script execution can or cannot be suspended. | |||
For example while .''sqs'' and .''fsm'' scripts are [[Scheduler#Scheduled_Environment|scheduled]] (i.e. added to the [[Scheduler|scheduler]]: | |||
[[diag_activeSQSScripts]], [[diag_activeMissionFSMs]]), they cannot use [[sleep]] or be suspended like [[execVM]] or [[spawn]] scripts can, therefore [[canSuspend]] for these types of scripts will return [[false]]. | |||
}} | |||
|s1= [[canSuspend]] | |||
|r1= [[Boolean]] | |r1= [[Boolean]] | ||
|x1= < | |x1= <sqf> | ||
onEachFrame | |||
{ | { | ||
systemChat str canSuspend; // false | |||
0 spawn { hint str canSuspend }; // true | |||
onEachFrame {}; | |||
};</ | }; | ||
|x2= Make sure the function code is always spawned even when called:< | </sqf> | ||
|x2= Make sure the function code is always spawned even when called: | |||
<sqf> | |||
private _sleepingCode = | |||
{ | { | ||
if (!canSuspend) exitWith { _this spawn _sleepingCode }; | |||
sleep _this; | |||
hint ("slept " + str _this); | |||
}; | }; | ||
5 | 5 call _sleepingCode; | ||
</sqf> | |||
|seealso= [[sleep]] | |seealso= [[sleep]] [[uiSleep]] [[waitUntil]] [[call]] [[spawn]] [[execVM]] [[isRemoteExecuted]] [[isRemoteExecutedJIP]] [[remoteExecutedOwner]] [[isUIContext]] [[isGamePaused]] [[isGameFocused]] | ||
}} | }} | ||
Latest revision as of 21:47, 17 March 2024
Description
- Description:
- Returns true if sleep, uiSleep or waitUntil commands can be used in the current scope. Usually when suspension is not allowed but used, for example when code is executed in unscheduled environment, the script engine would ignore any suspension command and throw error: "Suspending not allowed in this context". Using canSuspend command allows to detect the correct environment for the code.
- Groups:
- Program Flow
Syntax
- Syntax:
- canSuspend
- Return Value:
- Boolean
Examples
- Example 1:
- onEachFrame { systemChat str canSuspend; // false 0 spawn { hint str canSuspend }; // true onEachFrame {}; };
- Example 2:
- Make sure the function code is always spawned even when called:
Additional Information
- See also:
- sleep uiSleep waitUntil call spawn execVM isRemoteExecuted isRemoteExecutedJIP remoteExecutedOwner isUIContext isGamePaused isGameFocused
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