removeAction: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (template:command argument fix)
(26 intermediate revisions by 9 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#R|COMREF]]
{{Command|= Comments
____________________________________________________________________________________________


<h2 style="color:#000066">''unit '''''removeAction ''index'''''</h2>
| ofp |= Game name


|1.20|= Game version


'''Operand types:'''
|arg= global |= Arguments in MP


'''unit:''' [[Object]]
|eff= local |= Effects in MP
____________________________________________________________________________________________


'''index:''' [[Number]]
| 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.


'''Type of returned value:'''
This command has [[local]] effect. The action will only be removed on the computer that executes the command. |DESCRIPTION=
____________________________________________________________________________________________


[[Nothing]]
| unit '''removeAction''' index |SYNTAX=


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


Added in version '''1.11'''
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code>[[player]] [[removeAction]] 0;</code> |EXAMPLE1=
____________________________________________________________________________________________


'''Description:'''
|  [[actionIDs]], [[actionParams]], [[addAction]], [[setUserActionText]], [[inGameUISetEventHandler]], [[showHUD]], [[inputAction]], [[removeAllActions]], [[action]]|SEEALSO=


Remove action with given id '''index'''.
}}


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>


'''Example:'''
<h3 style="display:none">Bottom Section</h3>


[[player]] '''removeAction''' 0
[[Category:Scripting Commands|REMOVEACTION]]
 
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.96|REMOVEACTION]]
'''Comments'''
[[Category:Scripting Commands OFP 1.46|REMOVEACTION]]
 
[[Category:Scripting Commands ArmA|REMOVEACTION]]
'''Note:''' This only removes actions added with the addAction command.
[[Category:Command_Group:_Activators|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
You cannot remove default game actions, such as reload and salute, with this command.
[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 15:45, 7 April 2019

Logo A0.png1.20
GAGlobalLELocal
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

Retrieved from "https://community.bistudio.com/wiki?title=removeAction&oldid=122302"