setStamina: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(49 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<!-- setStamina from EXPORT -->
{{RV|type=command
{{Command|= Comments
|game1= arma3
|arma3|= Game name
|version1= 1.54
|1.54|= Game version
 
| Set units' stamina (seconds until depletion) |= Description
|eff= local
| unit '''setStamina''' stamina |= Syntax
|arg= local
|p1= unit: [[Object]] |= PARAMETER1
 
|p2= stamina: [[Number]] |= PARAMETER2
|gr1= Stamina System
| Nothing |= RETURNVALUE
 
|x1= <code> player '''setStamina''' 42;
|descr= Set units' stamina (seconds until depletion)
</code>|= EXAMPLE1
 
| [[Arma 3 Stamina]] [[getStamina]] [[enableStamina]] [[setFatigue]] [[getFatigue]] |= SEEALSO
|s1= unit [[setStamina]] stamina
|  |= MPBEHAVIOUR
 
|p1= unit: [[Object]]
 
|p2= stamina: [[Number]]
 
|r1= [[Nothing]]
 
|x1= <sqf>player setStamina 42;</sqf>
 
|seealso= [[setStaminaScheme]] [[getStamina]] [[enableStamina]] [[setFatigue]] [[getFatigue]] [[Arma 3: Stamina]]
}}
}}


<h3 style='display:none'>Bottom Section</h3>
<dl class="command_description">
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
<dt></dt>
<dl class="command_description">
<dd class="notedate">Posted on 2015-12-30 - 01:50 (UTC)</dd>
<dd class="notedate">Posted on December 30, 2015 - 01:50 (UTC)</dd>
<dt class="note">[[User:Molaron|Molaron]]</dt>
<dt class="note">[[User:Molaron|Molaron]]</dt>
<dd class="note">
<dd class="note">
"setStamina" has the same effect as "setFatigue".
"setStamina" has the same effect as "setFatigue".
</dd>
</dd>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
<dt><dt>
<dl class="command_description">
<dd class="notedate">Posted on 2018-12-26 - 11:34 (UTC)</dd>
<dd class="notedate">Posted on December 26, 2018 - 11:34 (UTC)</dd>
<dt class="note">[[User:demellion|demellion]]</dt>
<dt class="note">[[User:demellion|demellion]]</dt>
<dd class="note">
<dd class="note">
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:
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:
<code>[[getStamina]] [[player]]; // 8.58
<sqf>
[[getFatigue]] [[player]]; // 0
getStamina player; // 8.58
[[player]] [[setStamina]] 50; // This will be minimized to 8.58 on next unit simulation cycle.  
getFatigue player; // 0
</code>
player setStamina 50; // This will be minimized to 8.58 on next unit simulation cycle.  
</sqf>
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 19:42, 3 September 2024

Arma 3 logo black.png1.54
LALocalLELocal
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:
setStaminaScheme getStamina enableStamina setFatigue getFatigue Arma 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
Posted on 2015-12-30 - 01:50 (UTC)
Molaron
"setStamina" has the same effect as "setFatigue".
Posted on 2018-12-26 - 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.
Retrieved from "https://community.bistudio.com/wiki?title=setStamina&oldid=369292"