Difference between revisions of "getFatigue"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (added to Object Information command group)
m (Text replacement - "|= Game name" to "|Game name=")
(11 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma3 |= Game name
+
| arma3 |Game name=
 
+
|0.50|Game version=
|0.50|= Game version
+
|arg= global|Multiplayer Arguments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Returns fatigue of given unit.  |= Description
+
| Returns fatigue of given unit.  |DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| '''getFatigue''' unit |= Syntax
+
| '''getFatigue''' unit |SYNTAX=
  
|p1= unit: [[Object]]  |= PARAMETER1
+
|p1= unit: [[Object]]  |PARAMETER1=  
  
| [[Number]] |= RETURNVALUE
+
| [[Number]] |RETURNVALUE=  
  
  
|x1= <code> value = '''getFatigue''' player;
+
|x1= <code> value = [[getFatigue]] [[player]];
</code>|= EXAMPLE1
+
</code>|EXAMPLE1=  
  
|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>|EXAMPLE2=  
  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[setFatigue]], [[enableFatigue]] |= SEEALSO
+
| [[setFatigue]], [[enableFatigue]], [[getStamina]] |SEEALSO=  
  
|  |= MPBEHAVIOUR
+
|  |MPBEHAVIOUR=  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
}}
 
}}
Line 34: Line 34:
 
<dl class='command_description'>
 
<dl class='command_description'>
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
 +
 +
<dt class="note">'''[[User:Killzone_Kid|Killzone_Kid]]'''<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>
  
 
<!-- Note Section END -->
 
<!-- Note Section END -->

Revision as of 23:32, 31 August 2019

Introduced with Arma 3 version 0.500.50Arguments of this scripting command don't have to be local to the client the command is executed on
Hover & click on the images for descriptions

Description

Description:
Returns fatigue of given unit.

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

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

Notes

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.

Bottom Section