Difference between revisions of "getFatigue"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (global args)
m (Text replacement - "\|s([0-9])\= '''([^' ]+)'''([^ ]+) " to "|s$1= $2$3 ")
 
(37 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| arma3 |= Game name
+
|game1= arma3
|0.50|= Game version
+
|version1= 0.50
|arg= global|= Arguments in MP
+
|arg= global
____________________________________________________________________________________________
 
  
| Returns fatigue of given unit.  |= Description
+
|gr1= Stamina System
____________________________________________________________________________________________
 
  
| '''getFatigue''' unit |= Syntax
+
|descr= Returns fatigue of given unit.
  
|p1= unit: [[Object]] |= PARAMETER1
+
|s1= [[getFatigue]] unit
  
| [[Number]] |= RETURNVALUE
+
|p1= unit: [[Object]]
  
 +
|r1= [[Number]]
  
|x1= <code> value = '''getFatigue''' player;
+
|x1= <code>value = [[getFatigue]] [[player]];
</code>|= EXAMPLE1
+
</code>
  
|x2= <code> if ('''getFatigue''' player < 0.5) Then { player sideChat "I'm good to go!" };
+
|x2= <code>[[if]] ([[getFatigue]] [[player]] < 0.5) [[then]] { [[player]] [[sideChat]] "I'm good to go!" };
</code>|= EXAMPLE2
+
</code>
  
____________________________________________________________________________________________
+
|seealso= [[setFatigue]], [[enableFatigue]], [[getStamina]]
 +
}}
  
| [[setFatigue]], [[enableFatigue]] |= SEEALSO
+
<dl class="command_description">
  
| |= MPBEHAVIOUR
+
<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>
  
<h3 style='display:none'>Notes</h3>
 
<dl class='command_description'>
 
<!-- Note Section BEGIN -->
 
<dt class="note">'''[[User:Killzone_Kid|Killzone_Kid]]'''<dd class="note">
 
<br>
 
[[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 -->
 
 
</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_Information|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 18:05, 20 June 2021

Hover & click on the images for description

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.