getFatigue: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (removed empty line from note) |
||
| (11 intermediate revisions by 6 users not shown) | |||
| Line 3: | Line 3: | ||
| arma3 |= Game name | | arma3 |= Game name | ||
|0.50|= Game version | |0.50|= Game version | ||
|arg= global|Multiplayer Arguments= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Returns fatigue of given unit. |= | | Returns fatigue of given unit. |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| '''getFatigue''' unit |= | | '''getFatigue''' unit |SYNTAX= | ||
|p1= unit: [[Object]] |= | |p1= unit: [[Object]] |PARAMETER1= | ||
| [[Number]] |= | | [[Number]] |RETURNVALUE= | ||
|x1= <code> value = | |x1= <code> value = [[getFatigue]] [[player]]; | ||
</code>|= | </code>|EXAMPLE1= | ||
|x2= <code> [[if]] ([[getFatigue]] [[player]] < 0.5) [[then]] { [[player]] [[sideChat]] "I'm good to go!" }; | |||
</code>|EXAMPLE2= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[setFatigue]] |= | | [[setFatigue]], [[enableFatigue]], [[getStamina]] |SEEALSO= | ||
| |= | | |MPBEHAVIOUR= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
}} | }} | ||
| Line 31: | Line 34: | ||
<dl class='command_description'> | <dl class='command_description'> | ||
<!-- Note Section BEGIN --> | <!-- Note Section BEGIN --> | ||
<dt class="note">'''[[User:Killzone_Kid|Killzone_Kid]]'''<dd class="note"> | |||
[[getFatigue]] can be applied to remote unit however it will not read the changes made to unit's fatigue with [[setFatigue]] command. Only natural changes resulting from unit moving will be counted. When applied to local unit, it will read resulting value of natural fatigue combined with artificial changes added locally by [[setFatigue]]. In short, the server wouldn't know the correct value of remote unit's fatigue if you used [[setFatigue]] on the unit prior.<br> | |||
<!-- Note Section END --> | <!-- Note Section END --> | ||
| Line 39: | Line 45: | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]] | |||
Revision as of 11:47, 11 August 2019
Description
- Description:
- Returns fatigue of given unit.
- Groups:
- Uncategorised
Syntax
Examples
- Example 1:
value = getFatigue player;- Example 2:
if (getFatigue player < 0.5) then { player sideChat "I'm good to go!" };
Additional Information
- See also:
- setFatigueenableFatiguegetStamina
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
- Killzone_Kid
-
getFatigue can be applied to remote unit however it will not read the changes made to unit's fatigue with setFatigue command. Only natural changes resulting from unit moving will be counted. When applied to local unit, it will read resulting value of natural fatigue combined with artificial changes added locally by setFatigue. In short, the server wouldn't know the correct value of remote unit's fatigue if you used setFatigue on the unit prior.