setFatigue: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (added to Object Manipulation command group)
m (Text replacement - "<code>([a-zA-Z0-9_]+) +\[\[([a-zA-Z0-9_]+)\]\] +([a-zA-Z0-9_]+);?<\/code>" to "<sqf>$1 $2 $3;</sqf>")
 
(45 intermediate revisions by 7 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
____________________________________________________________________________________________


| Sets the person's fatigue, from 0 to 1.  |= Description
|eff= local
____________________________________________________________________________________________


| unit '''setFatigue''' value |= Syntax
|gr1= Stamina System


|p1= unit: [[Object]]  |= PARAMETER1
|descr= Sets the person's fatigue, from 0 to 1.


|p2= value: [[Number]] |= PARAMETER2
|s1= unit [[setFatigue]] value


| [[Nothing]] |= RETURNVALUE
|p1= unit: [[Object]]


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


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


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


| [[getFatigue]] [[enableFatigue]] |= SEEALSO
|seealso= [[Arma 3: Stamina]] [[getFatigue]] [[enableFatigue]] [[setStamina]] [[getStamina]] [[enableStamina]]
}}


|  |= MPBEHAVIOUR
<dl class="command_description">
____________________________________________________________________________________________
}}


<h3 style='display:none'>Notes</h3>
<dt></dt>
<dl class='command_description'>
<dd class="notedate">Posted on 05 April, 2014</dd>
<!-- Note Section BEGIN -->
<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>


<!-- Note Section END -->
</dl>
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]

Latest revision as of 13:25, 5 May 2022

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.