Difference between revisions of "removeAction"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|")
(32 intermediate revisions by 11 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands]]
+
{{Command|Comments=
[[Category:Scripting Commands OFP 1.97]]
+
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46]]
 
[[Category:Scripting Commands ArmA]]
 
  
back to [[Scripting_Reference#R|COMREF]]
+
| ofp |Game name=
  
<h2 style="color:#000066">''unit '''''removeAction ''index'''''</h2>
+
|1.20|Game version=
  
 +
|arg= global |Multiplayer Arguments=
  
'''Operand types:'''
+
|eff= local |Multiplayer Effects=
 +
____________________________________________________________________________________________
  
'''unit:''' [[Object]]
+
| 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.
  
'''index:''' [[Number]]
+
This command has [[local]] effect. The action will only be removed on the computer that executes the command. |DESCRIPTION=
 +
____________________________________________________________________________________________
  
'''Type of returned value:'''
+
| unit '''removeAction''' index |SYNTAX=
  
[[Nothing]]
+
|p1= unit: [[Object]] - unit, vehicle or static object |PARAMETER1=
 +
|p2= index: [[Number]] - action id returned by [[addAction]] |PARAMETER2=
  
'''Compatibility:'''
+
| [[Nothing]] |RETURNVALUE=
 +
____________________________________________________________________________________________
 +
 
 +
|x1= <code>[[player]] [[removeAction]] 0;</code> |EXAMPLE1=
 +
____________________________________________________________________________________________
  
Added in version '''1.11'''
+
|  [[actionIDs]], [[actionParams]], [[addAction]], [[setUserActionText]], [[inGameUISetEventHandler]], [[showHUD]], [[inputAction]], [[removeAllActions]], [[action]]|SEEALSO=
  
'''Description:'''
+
}}
  
Remove action with given id '''index'''.
+
<h3 style="display:none">Notes</h3>
 +
<dl class="command_description">
 +
<!-- Note Section BEGIN -->
 +
<!-- Note Section END -->
 +
</dl>
  
 +
<h3 style="display:none">Bottom Section</h3>
  
'''Example:'''
+
[[Category:Scripting Commands|REMOVEACTION]]
 
+
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[player]] '''removeAction''' 0
+
[[Category:Scripting Commands OFP 1.96|REMOVEACTION]]
 
+
[[Category:Scripting Commands OFP 1.46|REMOVEACTION]]
 
+
[[Category:Scripting Commands Armed Assault|REMOVEACTION]]
'''Comments'''
+
[[Category:Command_Group:_Activators|{{uc:{{PAGENAME}}}}]]
 
+
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
'''Note:''' This only removes actions added with the addAction command.
+
[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]
 
+
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
You cannot remove default game actions, such as reload and salute, with this command.
+
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 20:41, 3 June 2020

Introduced with Operation Flashpoint version 1.201.20Arguments of this scripting command don't have to be local to the client the command is executed onEffects of this scripting command are not broadcasted over the network and remain local to the client the command is executed on
Hover & click on the images for descriptions

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.

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

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

Notes

Bottom Section