R3vo – User talk

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 38: Line 38:
{{RV|type=command
{{RV|type=command


|game1= arma3
| arma3
|version1= 0.50


|gr1= Lights
|0.50
|gr2= Weapons


|arg= local
|arg= global
|eff= global


|descr= Toggles the target group's gun light(s).
|eff= local


|s1= target [[enableGunLights]] mode
|gr1= Interaction


|p1= target: [[Group]] or [[Object]] - The group forced to use gun lights. If unit is supplied as argument, unit's group is used
| {{Feature|arma3 | This command syntax is for {{arma3}} only. For TKOH and older {{arma}} games see [[addAction TKOH]].}}


|p2= mode: [[String]] - Can be:
Adds an entry to the action menu of an object (scroll wheel menu). The action can only be activated when in proximity to the object (default 50m) '''and''' look at it. Adding an action to the player makes that action available to the player at all times.<br>
* <tt>"Auto"</tt> - Depends on combat mode
The appearance of onscreen text can be further tweaked with [[setUserActionText]]. For event handling of user interaction see [[inGameUISetEventHandler]].
* <tt>"ForceOn"</tt> - Always on
* <tt>"ForceOff"</tt> - Always off


|r1= [[Nothing]]
{{Feature | Informative | [[addAction]] does not work on [[createAgent|agents]] (including animals) and [[Arma 3 Simple Objects|simple objects]], this is intended behavior.}}


|x1= <code>_unit [[enableGunLights]] "Auto";</code>
| object [[addAction]] [title, script, arguments, priority, showWindow, hideOnUse, shortcut, condition, radius, unconscious, selection, memoryPoint]


|x2= <code>_unit [[enableGunLights]] "ForceOff";</code>
|p1=
<dl>
<dt style="clear:none;">object:</dt>
<dd>[[Object]] - unit, vehicle or static object</dd>


|seealso= [[isFlashlightOn]]
<dt>title:</dt>
<dd>[[String]] - The action name which is displayed in the action menu, may contain [[Structured Text]]. Because of that '''<''' and '''>''' symbols will be interpreted as opening and closing XML tags. To avoid this use <tt>&amp;lt;</tt> for '''&lt;''' and <tt>&amp;gt;</tt> for '''&gt;'''. The title text can be changed with [[setUserActionText]]</dd>
 
<dt>script:</dt>
<dd>[[String]] or [[Code]] - Either path to the script file, relative to the mission folder or string with code or the actual script code. If the string is a path to script file, the script file '''must''' have extension .[[SQS Syntax|SQS]] or .[[SQF Syntax|SQF]]. The script, whether it is a file or a code, will run in [[Scheduler#Scheduled Environment|scheduled environment]], i.e. it is ok to use [[sleep]].
<br>
Parameters array passed to the script upon activation in ''[[Magic Variables#this|_this]]'' variable is:
<syntaxhighlight lang="cpp">params ["_target", "_caller", "_actionId", "_arguments"];</syntaxhighlight>
* ''target'' (_this select 0): [[Object]] - the object which the action is assigned to
* ''caller'' (_this select 1): [[Object]] - the unit that activated the action
* ''actionId'' (_this select 2): [[Number]] - activated action's ID (same as [[addAction]]'s return value)
* ''arguments'' (_this select 3): [[Anything]] - arguments given to the script if you are using the extended syntax
 
</dd>
 
<dt>arguments:</dt>
<dd>[[Anything]] - (Optional, default [[nil]]) arguments to pass to the script (will be ''_this select 3'' inside the script). If [[Array]] is used as an argument for example, its first element reference would be {{ic|_this select 3 select 0}}</dd>
 
<dt>priority:</dt>
<dd>[[Number]] - (Optional, default 1.5) priority value of the action. Actions will be arranged in descending order according to this value. Every game action has a preset priority value. Value can be negative or decimal fraction. Actions with same values will be arranged in order which they were made, newest at the bottom. The bigger the number the higher the action will be positioned on the menu. Typical range is 0 (low priority. Eg: 'Get out') to 6 (high priority. Eg: 'Auto-hover on')</dd>
 
<dt>showWindow:</dt>
<dd>[[Boolean]] - (Optional, default [[true]]) if set to [[true]], players see "Titletext" at mid-lower screen, as they approach the object. Only the title text for the action with highest priority and 'showWindow true' will be shown. Setting it to [[false]] disables the feature</dd>
 
<dt>hideOnUse:</dt>
<dd>[[Boolean]] - (Optional, default [[true]]) if set to [[true]], it will hide the action menu after selecting that action. If set to [[false]], it will leave the action menu open and visible after selecting that action, leaving the same action highlighted, for the purpose of allowing you to reselect that same action quickly, or to select another action</dd>
 
<dt>shortcut:</dt>
<dd>[[String]] - (Optional, default "") one of the [[:Category:Key Actions|key names]] defined in bin.pbo (e.g. "moveForward"). Adding available shortcut will bind corresponding keyboard key to this action. Shortcut availability can be tested with [[inputAction]] command</dd>
 
<dt>condition:</dt>
<dd>[[String]] - (Optional, default "true") script code that must return [[true]] for the action to be shown. Special variables passed to the script code are:
* ''_target'': [[Object]] - the object to which action is attached or, if the object is a unit inside of vehicle, the vehicle
* ''_this'': [[Object]] - caller person to whom the action is shown (or not shown if ''condition'' returns [[false]])
* ''_originalTarget'': [[Object]] - the original object to which the action is attached, regardless if the object/unit is in a vehicle or not
{{Feature|important|
* ''condition'' is evaluated on each frame in [[Scheduler#Unscheduled Environment|non-scheduled environment]].
* ''condition'' is '''not''' evaluated if a dialog is open.
* If action is added to an object (and not to [[player]]) ''condition'' will only get evaluated IF player is closer than ~50m to the object surface AND is looking at the object.
* If action is added to [[player]], ''condition'' is evaluated all the time.}}</dd>
 
<dt>radius:</dt>
<dd>[[Number]] - (Optional, default 50) maximum 3D [[distance]] in meters between the activating unit's [[eyePos]] and the ''object'''s ''memoryPoint'', ''selection'' or [[position]]. -1 disables the radius
<br>{{Since|arma3|1.64|y}}</dd>
 
<dt>unconscious:</dt>
<dd>[[Boolean]] - (Optional, default [[false]]) if [[true]] will be shown to incapacitated player (see [[setUnconscious]], [[lifeState]])<br>{{Since|arma3|1.64|y}}</dd>
 
<dt>selection:</dt>
<dd>[[String]] - (Optional, default "") ''object'' Geometry LOD's named selection
<br>{{Since|arma3|1.70|y}}</dd>
 
<dt>memoryPoint:</dt>
<dd>[[String]] - (Optional, default "") ''object'''s memory point. If ''selection'' is supplied, ''memoryPoint'' is not used
<br>{{Since|arma3|1.82|y}}</dd>
 
</dl>
 
| [[Number]] - The added action's ID. Action can be removed with [[removeAction]] (see also [[removeAllActions]]). IDs are incrementing, the first given action to each unit has the ID 0, the second the ID 1, etc. IDs are also passed to the called script (see [[#Syntax|''script'' parameter]])
 
|x1= <code>{{cc|short and sweet}}
[[player]] [[addAction]] ["a useless action that does nothing", {}];
[[player]] [[addAction]] ["<t color='#FF0000'>This Useless Action Is RED</t>", {[[hint]] "RED"}];
[[player]] [[addAction]] ["Hint Hello!", { [[hint]] [[format]] ["Hello %1!", [[name]] [[player]]] }];
[[player]] [[addAction]] ["String Exec", "[[hint]] 'this is also compiled'"];</code>
 
|x2= <code>_actionID = [[player]] [[addAction]] ["Exec the file", "scriptFile.sqf"]</code>
'''scriptFile.sqf:'''
<code>[[hint]] [[str]] [[Magic Variables#this|_this]];</code>
 
|x3= <code>{{cc|create object on the server and add action to the object on every client}}
[[if]] ([[isServer]]) [[then]]
{
[[private]] _object = "some_obj_class" [[createVehicle]] [1234, 1234, 0];
[_object, ["Greetings!", { [[hint]] "Hello!"; }]] [[remoteExec]] ["addAction"]; {{cc|Note: does '''not''' return action id}}
};</code>
 
|x4= Default parameters:<code>[[Magic Variables#this_2|this]] [[addAction]]
[
"title",
{
[[params]] ["_target", "_caller", "_actionId", "_arguments"];
},
[[nil]],
1.5,
[[true]],
[[true]],
"",
"[[true]]", {{cc|_target, [[Magic Variables#this|_this]], _originalTarget}}
50,
[[false]],
"",
""
];</code>
 
|x5= Default parameters with comments:<code>[[Magic Variables#this_2|this]] [[addAction]]
[
"title", {{cc|title}}
{
[[params]] ["_target", "_caller", "_actionId", "_arguments"]; {{cc|script}}
},
[[nil]], {{cc|arguments}}
1.5, {{cc|priority}}
[[true]], {{cc|showWindow}}
[[true]], {{cc|hideOnUse}}
"", {{cc|shortcut}}
"[[true]]", {{cc|condition}}
50, {{cc|radius}}
[[false]], {{cc|unconscious}}
"", {{cc|selection}}
"" {{cc|memoryPoint}}
];</code>
 
| [[actionIDs]], [[actionParams]], [[setUserActionText]], [[inGameUISetEventHandler]], [[showHUD]], [[inputAction]]
[[removeAction]], [[removeAllActions]], [[action]], [[BIS_fnc_holdActionAdd]]
}}
}}
<dl class="command_description">
<dt></dt>
<dd class="notedate">Posted on May 02, 2018 - 13:44 (UTC)</dd>
<dt class="note">[[User:Dedmen|Dedmen]]</dt>
<dd class="note">
If you want to replicate vanilla Actions like "Treat yourself" where the scroll menu only shows text and it displays the icon mid-screen you can use
<code>[[private]] _action = [[player]] [[addAction]] ["Heal", {}];
[[player]] [[setUserActionText]] [_action , "Heal", "<img size='2' image='\a3\ui_f\data\IGUI\Cfg\Actions\heal_ca'/>"];
</code>
<dt><dt>
<dd class="notedate">Posted on May 12, 2020 - 10:42 (UTC)</dd>
<dt class="note">[[User:PierreMGI|PierreMGI]]</dt>
<dd class="note">
addAction on unit or player stays on corpse after kill. So this action is lost for the new body after respawn. If you want a persistent addAction, you need to add it in the respawn script (onPlayerRespawn.sqf or addMissionEventHandler "entityRespawned" or addMPEventHandler "MPrespawn"...
You can use [[removeAllActions]] on corpse.
</dl>
}}
}}

Revision as of 14:32, 20 April 2021

RV/type Template

-Type not defined-


RV/param Template

Missing Name: Template:RV/type

Retrieved from "https://community.bistudio.com/wiki?title=User_talk:R3vo&oldid=255581"