setFatigue: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[cC]ommand[_ ][gG]roup:[_ ][^|]+\|\{*uc:{{PAGENAME}*]\]" to "")
m (Text replacement - "<code>([a-zA-Z0-9_]+) +\[\[([a-zA-Z0-9_]+)\]\] +([a-zA-Z0-9_]+);?<\/code>" to "<sqf>$1 $2 $3;</sqf>")
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command


| arma3 |Game name=
|game1= arma3
|version1= 0.50


|0.50|Game version=
|arg= global
|arg= global |Multiplayer Arguments=


|eff= local |Multiplayer Effects=
|eff= local


|gr1= Stamina System |GROUP1=
|gr1= Stamina System


| Sets the person's fatigue, from 0 to 1. |DESCRIPTION=
|descr= Sets the person's fatigue, from 0 to 1.


| unit '''setFatigue''' value |SYNTAX=
|s1= unit [[setFatigue]] value


|p1= unit: [[Object]] |PARAMETER1=
|p1= unit: [[Object]]


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


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


|x1= <sqf>player setFatigue 1;</sqf>


|x1= <code> player '''setFatigue''' 1;
|seealso= [[Arma 3: Stamina]] [[getFatigue]] [[enableFatigue]] [[setStamina]] [[getStamina]] [[enableStamina]]
</code>|EXAMPLE1=  
}}
 


| [[Arma 3 Stamina]] [[getFatigue]] [[enableFatigue]] [[setStamina]] [[getStamina]] [[enableStamina]] |SEEALSO=  
<dl class="command_description">


| |MPBEHAVIOUR=  
<dt></dt>
}}
<dd class="notedate">Posted on 05 April, 2014</dd>
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]</dt>
<dd class="note">
[[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.
</dd>


<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on 05 April, 2014
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]<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.<br>
<!-- Note Section END -->
</dl>
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma3|New Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 13:25, 5 May 2022

Arma 3 logo black.png0.50
GAGlobalLELocal
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.
Retrieved from "https://community.bistudio.com/wiki?title=setFatigue&oldid=310086"