getFatigue: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) mNo edit summary |
Lou Montana (talk | contribs) m (Text replacement - "\|s([0-9])\= '''([^' ]+)'''([^ ]+) " to "|s$1= $2$3 ") |
||
| (38 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| arma3 |= | |game1= arma3 | ||
|version1= 0.50 | |||
|arg= global | |||
| | |gr1= Stamina System | ||
| Returns fatigue of given unit. | |descr= Returns fatigue of given unit. | ||
| | |s1= [[getFatigue]] unit | ||
|p1= unit: [[Object]] | |p1= unit: [[Object]] | ||
| [[Number]] | |r1= [[Number]] | ||
|x1= <code>value = [[getFatigue]] [[player]]; | |||
</code> | |||
| | |x2= <code>[[if]] ([[getFatigue]] [[player]] < 0.5) [[then]] { [[player]] [[sideChat]] "I'm good to go!" }; | ||
</code> | </code> | ||
| | |seealso= [[setFatigue]], [[enableFatigue]], [[getStamina]] | ||
}} | |||
<dl class="command_description"> | |||
| [[setFatigue]], [[ | <dt class="note">[[User:Killzone_Kid|Killzone_Kid]]</dt> | ||
<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> | |||
</dl> | </dl> | ||
Revision as of 18:05, 20 June 2021
Description
- Description:
- Returns fatigue of given unit.
- Groups:
- Stamina System
Syntax
- Syntax:
- getFatigue unit
- Parameters:
- unit: Object
- Return Value:
- Number
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
- 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.