setStamina: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (template:command argument fix)
Line 5: Line 5:
| Set units' stamina (seconds until depletion) |= Description
| Set units' stamina (seconds until depletion) |= Description
| unit '''setStamina''' stamina |= Syntax
| unit '''setStamina''' stamina |= Syntax
|p1= unit: [[Object]] |= PARAMETER1
|p1= unit: [[Object]] |PARAMETER1=  
|p2= stamina: [[Number]] |= PARAMETER2
|p2= stamina: [[Number]] |PARAMETER2=
| Nothing |= RETURNVALUE
| Nothing |RETURNVALUE=  
|x1= <code> player '''setStamina''' 42;
|x1= <code> player '''setStamina''' 42;
</code>|= EXAMPLE1
</code>|EXAMPLE1=  
| [[Arma 3 Stamina]] [[getStamina]] [[enableStamina]] [[setFatigue]] [[getFatigue]] |= SEEALSO
| [[Arma 3 Stamina]] [[getStamina]] [[enableStamina]] [[setFatigue]] [[getFatigue]] |SEEALSO=  
|  |= MPBEHAVIOUR
|  |MPBEHAVIOUR=  
}}
}}



Revision as of 10:37, 7 April 2019


Hover & click on the images for description

Description

Description:
Set units' stamina (seconds until depletion)
Groups:
Uncategorised

Syntax

Syntax:
unit setStamina stamina
Parameters:
unit: Object
stamina: Number
Return Value:
Nothing

Examples

Example 1:
player setStamina 42;

Additional Information

See also:
Arma 3 Stamina getStamina enableStamina setFatigue getFatigue

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

Bottom Section

Posted on December 30, 2015 - 01:50 (UTC)
Molaron
"setStamina" has the same effect as "setFatigue".
Posted on December 26, 2018 - 11:34 (UTC)
demellion
Note that setStamina will not be able to exceed a 100% stamina value given by the engine. It will minimize to a maximum possible value, similar to application of the old command setFatigue in a range of 0..1. Example: getStamina player; // 8.58 getFatigue player; // 0 player setStamina 50; // This will be minimized to 8.58 on next unit simulation cycle.