setFatigue: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|s([0-9])\= ([^' ]+)'''([^' ]+)'''([^ ]*) " to "|s$1= $2$3$4 ")
m (Some wiki formatting)
Line 3: Line 3:
|game1= arma3
|game1= arma3
|version1= 0.50
|version1= 0.50
|arg= global
|arg= global


Line 15: Line 16:
|p1= unit: [[Object]]
|p1= unit: [[Object]]


|p2= value: [[Number]]
|p2= value: [[Number]] - in 0..1 ''available'' fatigue range: 0 is fully energised, 1 is fully exhausted


|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>player '''setFatigue''' 1;
|x1= <code>player [[setFatigue]] 1;</code>
</code>


|seealso= [[Arma 3: Stamina]] [[getFatigue]] [[enableFatigue]] [[setStamina]] [[getStamina]] [[enableStamina]]
|seealso= [[Arma 3: Stamina]] [[getFatigue]] [[enableFatigue]] [[setStamina]] [[getStamina]] [[enableStamina]]
Line 31: Line 31:
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]</dt>
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]</dt>
<dd class="note">
<dd class="note">
<br>
[[setFatigue]] will affect fatigue of a local unit only. If you execute it on remote unit, the [[getFatigue]] value will only change locally with no effect on remote unit. Scripted [[setFatigue]] changes don't broadcast at all. In short, use [[setFatigue]] on local units only.
[[setFatigue]] will affect fatigue of a local unit only. If you execute it on remote unit, the [[getFatigue]] value will only change locally with no effect on remote unit. Scripted [[setFatigue]] changes don't broadcast at all. In short, use [[setFatigue]] on local units only.<br>
</dd>
 
</dl>
</dl>

Revision as of 10:54, 1 August 2021

Hover & click on the images for description

Description

Description:
Sets the person's fatigue, from 0 to 1.
Groups:
Stamina System

Syntax

Syntax:
unit setFatigue value
Parameters:
unit: Object
value: Number - in 0..1 available fatigue range: 0 is fully energised, 1 is fully exhausted
Return Value:
Nothing

Examples

Example 1:
player setFatigue 1;

Additional Information

See also:
Arma 3: Stamina getFatigue enableFatigue setStamina getStamina enableStamina

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
Posted on 05 April, 2014
Killzone_Kid
setFatigue will affect fatigue of a local unit only. If you execute it on remote unit, the getFatigue value will only change locally with no effect on remote unit. Scripted setFatigue changes don't broadcast at all. In short, use setFatigue on local units only.