removeAllActions: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{RV\|type=command \| *arma3 \|0.50 \|arg= *(.+) * \|eff= *(.+) * \|gr1= *(.+) * \| *(.+) * \| *(.+) .* \|p1= *(.+) * \| (.*) \|x1= *(.+) * \|seealso= *(.+) * \}\}" to "{{RV|type=command |game1= arma3 |version1= 0.50...)
(Add warning and examples)
 
(10 intermediate revisions by the same user not shown)
Line 4: Line 4:
|version1= 0.50
|version1= 0.50


|arg= global
|arg= global


|eff= local
|eff= local


|gr1= Interaction
|gr1= Interaction


|descr= Removes all unit's user added actions.
|descr= Removes all unit's user added actions.
{{Feature|informative|This command's syntax was <sqf inline>unit removeAllActions number</sqf> from {{arma3}} v0.50 to v1.06.}}
{{Feature|important|Usage of this command is usually a bad practice unless justified by the situation; removing all actions in order to remove all actions that ''one'' added is not a good method as a mod or another script could have added its own actions as well and see them removed. Instead, store the action id returned by [[addAction]] either in a script variable or using [[setVariable]].}}


|s1= '''removeAllActions'''
|s1= [[removeAllActions]] obj


|p1= unit: [[Object]] - unit, vehicle or static object
|p1= obj: [[Object]]


|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>[[removeAllActions]] [[player]];</code>
|x1= <sqf>removeAllActions player;</sqf>


|seealso= [[actionIDs]], [[actionParams]], [[addAction]], [[setUserActionText]], [[inGameUISetEventHandler]], [[showHUD]], [[inputAction]], [[removeAction]], [[action]]
|x2= Do
}}
<sqf>
private _actionId = player addAction ["Heal self", { player setDamage 0; }];
// ...
player removeAction _actionId;
</sqf>
Don't
<sqf>
player addAction ["Heal self", { player setDamage 0; }];
// ...
removeAllActions player;
</sqf>


<dl class="command_description">
|x3= Do
<dt><dt>
<sqf>
<dd class="notedate">Posted on 30 October, 2013 </dd>
player addAction ["Heal self (once)", {
<dt class="note">[[User:Druid|Druid]]</dt>
params ["_target", "", "_actionId"];
<dd class="note">
_target setDamage 0;
Syntax of this command was until Arma 3 ver. 1.06: ''unit'' '''removeAllActions''' ''number''
_target removeAction _actionId;
}];
</sqf>
Don't
<sqf>
player addAction ["Heal self (once)", {
player setDamage 0;
removeAllActions player;
}];
</sqf>


</dl>
|seealso= [[actionIDs]] [[actionParams]] [[addAction]] [[setUserActionText]] [[inGameUISetEventHandler]] [[showHUD]] [[inputAction]] [[removeAction]] [[action]]
 
}}
{{GameCategory|arma3|New Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}

Latest revision as of 12:37, 27 July 2022

Arma 3 logo black.png0.50
GAGlobalLELocal
Hover & click on the images for description

Description

Description:
Removes all unit's user added actions.
ⓘ
This command's syntax was unit removeAllActions number from Arma 3 v0.50 to v1.06.
⚠
Usage of this command is usually a bad practice unless justified by the situation; removing all actions in order to remove all actions that one added is not a good method as a mod or another script could have added its own actions as well and see them removed. Instead, store the action id returned by addAction either in a script variable or using setVariable.
Groups:
Interaction

Syntax

Syntax:
removeAllActions obj
Parameters:
obj: Object
Return Value:
Nothing

Examples

Example 1:
removeAllActions player;
Example 2:
Do
private _actionId = player addAction ["Heal self", { player setDamage 0; }]; // ... player removeAction _actionId;
Don't
player addAction ["Heal self", { player setDamage 0; }]; // ... removeAllActions player;
Example 3:
Do
player addAction ["Heal self (once)", { params ["_target", "", "_actionId"]; _target setDamage 0; _target removeAction _actionId; }];
Don't
player addAction ["Heal self (once)", { player setDamage 0; removeAllActions player; }];

Additional Information

See also:
actionIDs actionParams addAction setUserActionText inGameUISetEventHandler showHUD inputAction removeAction action

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
Retrieved from "https://community.bistudio.com/wiki?title=removeAllActions&oldid=329338"