setStamina: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|[ _]?New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command
|arma3|Game name=
|arma3


|1.54|Game version=
|1.54


|eff= local |Effects in MP=
|eff= local
|arg= local |Arguments in MP=
|arg= local


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


| Set units' stamina (seconds until depletion) |DESCRIPTION=
| Set units' stamina (seconds until depletion)


| unit '''setStamina''' stamina |SYNTAX=
| unit '''setStamina''' stamina


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


|p2= stamina: [[Number]] |PARAMETER2=
|p2= stamina: [[Number]]


| Nothing |RETURNVALUE=
| Nothing


|x1= <code>[[player]] [[setStamina]] 42;</code>|EXAMPLE1=
|x1= <code>[[player]] [[setStamina]] 42;</code>


| [[setStaminaScheme]], [[getStamina]], [[enableStamina]], [[setFatigue]], [[getFatigue]], [[Arma 3 Stamina]] |SEEALSO=
| [[setStaminaScheme]], [[getStamina]], [[enableStamina]], [[setFatigue]], [[getFatigue]], [[Arma 3 Stamina]]
}}
}}



Revision as of 11:12, 18 January 2021

Hover & click on the images for description

Description

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

Syntax

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

Examples

Example 1:
player setStamina 42;

Additional Information

See also:
setStaminaSchemegetStaminaenableStaminasetFatiguegetFatigueArma 3 Stamina

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.