removeAction: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|")
(19 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| ofp |= Game name
| ofp |Game name=


|1.20|= Game version
|1.20|Game version=
 
|arg= global |Multiplayer Arguments=
 
|eff= local |Multiplayer Effects=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Remove action with given id index. |= Description
| Removes user added action with given id index. This only removes actions added with the [[addAction]] command. You cannot remove default game actions, such as reload.
 
This command has [[local]] effect. The action will only be removed on the computer that executes the command. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[Object#Unit|Unit]] '''removeAction''' index |= Syntax
| unit '''removeAction''' index |SYNTAX=


|p1= index: [[Number]] of Action
|p1= unit: [[Object]] - unit, vehicle or static object |PARAMETER1=
|p2= index: [[Number]] - action id returned by [[addAction]] |PARAMETER2=


| [[Nothing]] |= Return value
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>[[player]] '''removeAction''' 0 </code> |= Example 1
|x1= <code>[[player]] [[removeAction]] 0;</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


|  |= See also
[[actionIDs]], [[actionParams]], [[addAction]], [[setUserActionText]], [[inGameUISetEventHandler]], [[showHUD]], [[inputAction]], [[removeAllActions]], [[action]]|SEEALSO=


}}
}}
Line 27: Line 34:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
This only removes actions added with the [[addAction]] command. You cannot remove default game actions, such as reload and salute, with this command.
<!-- Note Section END -->
<!-- Note Section END -->
</dl>
</dl>
Line 34: Line 40:


[[Category:Scripting Commands|REMOVEACTION]]
[[Category:Scripting Commands|REMOVEACTION]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|REMOVEACTION]]
[[Category:Scripting Commands OFP 1.96|REMOVEACTION]]
[[Category:Scripting Commands OFP 1.46|REMOVEACTION]]
[[Category:Scripting Commands OFP 1.46|REMOVEACTION]]
[[Category:Scripting Commands ArmA|REMOVEACTION]]
[[Category:Scripting Commands Armed Assault|REMOVEACTION]]
[[Category:Command_Group:_Activators|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 20:41, 3 June 2020

Hover & click on the images for description

Description

Description:
Removes user added action with given id index. This only removes actions added with the addAction command. You cannot remove default game actions, such as reload. This command has local effect. The action will only be removed on the computer that executes the command.
Groups:
Uncategorised

Syntax

Syntax:
unit removeAction index
Parameters:
unit: Object - unit, vehicle or static object
index: Number - action id returned by addAction
Return Value:
Nothing

Examples

Example 1:
player removeAction 0;

Additional Information

See also:
actionIDsactionParamsaddActionsetUserActionTextinGameUISetEventHandlershowHUDinputActionremoveAllActionsaction

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

Notes

Bottom Section