removeAllActions: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
(Add warning and examples)
 
(39 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 0.50


|0.50|= Game version
|arg= global
____________________________________________________________________________________________


| Removes all unit's user added actions.  |= Description
|eff= local
____________________________________________________________________________________________


| unit '''removeAllActions''' number |= Syntax
|gr1= Interaction


|p1= unit: [[Object]] - unit, vehicle or static object  |= PARAMETER1
|descr= Removes all unit's user added actions.
|p2= number: [[Number]] - any number, it doesn't matter (The syntax of command might change in the future to ''''removeAllActions''' unit' as per [http://feedback.arma3.com/view.php?id=5317 this assigned ticket]) |= PARAMETER1
{{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]].}}


| [[Nothing]] |= RETURNVALUE
|s1= [[removeAllActions]] obj


|p1= obj: [[Object]]


|x1= <code>[[player]] [[removeAllActions]] 0;</code>|= EXAMPLE1
|r1= [[Nothing]]


____________________________________________________________________________________________
|x1= <sqf>removeAllActions player;</sqf>


| [[addAction]], [[removeAction]], [[setUserActionText]] |= SEEALSO
|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>


| |= MPBEHAVIOUR
|x3= Do
____________________________________________________________________________________________
<sqf>
player addAction ["Heal self (once)", {
params ["_target", "", "_actionId"];
_target setDamage 0;
_target removeAction _actionId;
}];
</sqf>
Don't
<sqf>
player addAction ["Heal self (once)", {
player setDamage 0;
removeAllActions player;
}];
</sqf>
 
|seealso= [[actionIDs]] [[actionParams]] [[addAction]] [[setUserActionText]] [[inGameUISetEventHandler]] [[showHUD]] [[inputAction]] [[removeAction]] [[action]]
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Arma 3: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:37, 27 July 2022

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