addAction - Revision history

Lou Montana: Text replacement - " ''via'' " to " via "

2025-02-21T10:44:04Z

Text replacement - " ''via'' " to " via "

← Older revision		Revision as of 12:44, 21 February 2025
Line 32:		Line 32:
	\|mp= The command will be ignored on dedicated servers, probably because no UI exists.		\|mp= The command will be ignored on dedicated servers, probably because no UI exists.

	\|pr= {{Feature\|ofp\|Due to a bug in {{ofp}}, actions added ''via'' [[addAction]] do not get properly updated after mounting vehicles. When several actions are available while mounting a vehicle and it drives away from the actions' position, they will still be shown in the menu until dismounting/boarding the vehicle again.}}		\|pr= {{Feature\|ofp\|Due to a bug in {{ofp}}, actions added via [[addAction]] do not get properly updated after mounting vehicles. When several actions are available while mounting a vehicle and it drives away from the actions' position, they will still be shown in the menu until dismounting/boarding the vehicle again.}}

	\|s1= object [[addAction]] [title, script, arguments, priority, showWindow, hideOnUse, shortcut, condition, positionInModel, radius, radiusView, showIn3D, available, textDefault, textToolTip]		\|s1= object [[addAction]] [title, script, arguments, priority, showWindow, hideOnUse, shortcut, condition, positionInModel, radius, radiusView, showIn3D, available, textDefault, textToolTip]

Lou Montana: Text replacement - "↵↵" to " "

2024-09-03T18:48:51Z

Text replacement - "↵↵</sqf>" to " </sqf>"

← Older revision		Revision as of 20:48, 3 September 2024
Line 272:		Line 272:
	"" // memoryPoint		"" // memoryPoint
	];		];

	</sqf>		</sqf>

Lou Montana: Text replacement - "([^↵][^<]↵[^<])<\/sqf>" to " $1 "

2024-09-03T18:43:11Z

Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>"

← Older revision		Revision as of 20:43, 3 September 2024
Line 254:		Line 254:

	\|x5= Default parameters with comments:		\|x5= Default parameters with comments:
	<sqf>this addAction		<sqf>
			this addAction
	[		[
	"title", // title		"title", // title
Line 271:		Line 272:
	"" // memoryPoint		"" // memoryPoint
	];		];

	</sqf>		</sqf>

Lou Montana: Text replacement - "[[Arma 3 " to "[[Arma 3: "

2024-05-06T09:38:37Z

Text replacement - "[[Arma 3 " to "[[Arma 3: "

← Older revision		Revision as of 11:38, 6 May 2024
Line 163:		Line 163:
	\|s1= object [[addAction]] [title, script, arguments, priority, showWindow, hideOnUse, shortcut, condition, radius, unconscious, selection, memoryPoint]		\|s1= object [[addAction]] [title, script, arguments, priority, showWindow, hideOnUse, shortcut, condition, radius, unconscious, selection, memoryPoint]

	\|p1= '''object''': [[Object]] - unit, vehicle or static object. '''No [[createAgent\|agents]] and [[Arma 3 Simple Objects\|simple objects]]!'''		\|p1= '''object''': [[Object]] - unit, vehicle or static object. '''No [[createAgent\|agents]] and [[Arma 3: Simple Objects\|simple objects]]!'''

	\|p2= '''title''': [[String]] - the action name 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 {{hl\|&lt;}} for '''<''' and {{hl\|&gt;}} for '''>'''. The title text appearance can be changed with [[setUserActionText]]		\|p2= '''title''': [[String]] - the action name 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 {{hl\|&lt;}} for '''<''' and {{hl\|&gt;}} for '''>'''. The title text appearance can be changed with [[setUserActionText]]

Lou Montana: Add positionInModel back to TKOH's version

2024-02-28T00:59:55Z

Add positionInModel back to TKOH's version

← Older revision		Revision as of 02:59, 28 February 2024
Line 40:		Line 40:
	\|p2= '''title''': [[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 {{hl\|&lt;}} for '''<''' and {{hl\|&gt;}} for '''>'''. The title text appearance can be changed with [[setUserActionText]]		\|p2= '''title''': [[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 {{hl\|&lt;}} for '''<''' and {{hl\|&gt;}} for '''>'''. The title text appearance can be changed with [[setUserActionText]]

	\|p3= '''script''': [[String]] - path to the script file, relative to the mission folder. It will run in [[Scheduler#Scheduled Environment\|scheduled environment]], i.e. it is ok to use [[sleep]]. Parameters array passed to the script upon activation in ''[[Magic Variables#this\|_this]]'' variable is:		\|p3= '''script''': [[String]] or {{GVI\|tkoh\|1.00\|size= 0.75}} [[Code]] - path to the script file relative to the mission folder, or code to execute. It will run in [[Scheduler#Scheduled Environment\|scheduled environment]], i.e. it is ok to use [[sleep]]. Parameters array passed to the script upon activation in ''[[Magic Variables#this\|_this]]'' variable is:
	<sqf>params ["_target", "_caller", "_actionId", "_arguments"];</sqf>		<sqf>params ["_target", "_caller", "_actionId", "_arguments"];</sqf>
	* '''target''': [[Object]] - the object which the action is assigned to		* '''target''': [[Object]] - the object which the action is assigned to
Line 73:		Line 73:
	\|p9since= arma2 1.00		\|p9since= arma2 1.00

	\|p10= '''~~radius~~''': [[~~Number~~]] - (Optional, default 50) ~~maximum 3D [[distance]]~~ in ~~meters between~~ the ~~activating unit's [[eyePos]] and~~ the ~~''object<nowiki>'</nowiki>s'' ''memoryPoint'', ''selection'' or [[position]]. -1 disables the radius~~		\|p10= '''positionInModel''': [[String]] - (Optional, default "") name of the named selection in the model for positioning the action in 3D space; typically a memory point
	\|p10since= tkoh 1.00		\|p10since= tkoh 1.00

	\|p11= '''~~radiusView~~''': [[Number]] - (Optional, default ~~'''unknown'''~~) maximum distance in meters the ~~cursor can be away from~~ the ~~3D action to activate it~~. -1 disables ~~this~~ radius		\|p11= '''radius''': [[Number]] - (Optional, default 50) maximum 3D [[distance]] in meters between the activating unit's [[eyePos]] and the ''object<nowiki>'</nowiki>s'' ''memoryPoint'', ''selection'' or [[position]]. -1 disables the radius
	\|p11since= tkoh 1.00		\|p11since= tkoh 1.00

	\|p12= '''showIn3D''': [[Number]] - (Optional, default '''unknown''') condition for showing the action in 3D space. Can be combined e.g. <sqf inline>2 + 32</sqf>		\|p12= '''radiusView''': [[Number]] - (Optional, default '''unknown''') maximum distance in meters the cursor can be away from the 3D action to activate it. -1 disables this radius
			\|p12since= tkoh 1.00

			\|p13= '''showIn3D''': [[Number]] - (Optional, default '''unknown''') condition for showing the action in 3D space. Can be combined e.g. <sqf inline>2 + 32</sqf>
	* 1 - show		* 1 - show
	* 2 - draw if unit is pilot		* 2 - draw if unit is pilot
Line 87:		Line 90:
	* 32 - draw if not in internal camera		* 32 - draw if not in internal camera
	* 64 - draw if not in gunner camera (turret optics)		* 64 - draw if not in gunner camera (turret optics)
	\|~~p12since~~= tkoh 1.00		\|p13since= tkoh 1.00

	\|~~p13~~= '''available''': [[Number]] - (Optional, default '''unknown''') condition for being able to activate the action. Can be combined e.g. <sqf inline>1 + 4</sqf>		\|p14= '''available''': [[Number]] - (Optional, default '''unknown''') condition for being able to activate the action. Can be combined e.g. <sqf inline>1 + 4</sqf>
	* 0 - disabled		* 0 - disabled
	* 1 - unit is pilot or copilot		* 1 - unit is pilot or copilot
	* 2 - unit is inside target		* 2 - unit is inside target
	* 4 - unit is not inside target		* 4 - unit is not inside target
	~~\|p13since= tkoh 1.00~~

	\|p14= '''textDefault''': [[String]] - (Optional, default "") structured Text which is shown as the 3D action (so it can be an icon), or in the center of the screen when the action is highlighted in the action menu for a 2D action
	\|p14since= tkoh 1.00		\|p14since= tkoh 1.00

	\|p15= '''~~textToolTip~~''': [[String]] - (Optional, default "") structured Text which is ~~faded~~ in ~~under~~ the ~~textDefault~~ when ~~hovering over~~ the action in ~~3D space~~		\|p15= '''textDefault''': [[String]] - (Optional, default "") structured Text which is shown as the 3D action (so it can be an icon), or in the center of the screen when the action is highlighted in the action menu for a 2D action
	\|p15since= tkoh 1.00		\|p15since= tkoh 1.00

			\|p16= '''textToolTip''': [[String]] - (Optional, default "") structured Text which is faded in under the textDefault when hovering over the action in 3D space
			\|p16since= tkoh 1.00

	\|r1= [[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 the [[#Syntax\|''script'' parameter]])		\|r1= [[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 the [[#Syntax\|''script'' parameter]])
Line 107:		Line 110:
	// short and sweet		// short and sweet
	player addAction ["a useless action that does nothing", {}];		player addAction ["a useless action that does nothing", {}];
	player addAction ["<t color='#FF0000'>This Useless Action Is RED</t>", {hint "RED"}];		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 ["Hint Hello!", { hint format ["Hello %1!", name player] }];
	player addAction ["String Exec", "hint 'this is also compiled'"];		player addAction ["String Exec", "hint 'this is also compiled'"];
Line 138:		Line 141:
	</sqf>		</sqf>

	\|seealso= [[actionIDs]] [[actionParams]] [[setUserActionText]] [[inGameUISetEventHandler]] [[showHUD]] [[inputAction]]		\|seealso= [[actionIDs]] [[actionParams]] [[setUserActionText]] [[inGameUISetEventHandler]] [[showHUD]] [[inputAction]] [[removeAction]] [[removeAllActions]] [[action]]
	[[removeAction]], [[removeAllActions]], [[action]]
	}}		}}

Line 289:		Line 291:
	\|user= PierreMGI		\|user= PierreMGI
	\|timestamp= 20200512104200		\|timestamp= 20200512104200
	\|text= [[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"...		\|text= [[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 ([[Event Scripts#onPlayerRespawn.sqf\|onPlayerRespawn.sqf]] or [[addMissionEventHandler]] "entityRespawned" or addMPEventHandler "MPrespawn"...
	You can use [[removeAllActions]] on corpse.		You can use [[removeAllActions]] on corpse.
	}}		}}
Line 296:		Line 298:
	\|user= Leopard20		\|user= Leopard20
	\|timestamp= 20220828215200		\|timestamp= 20220828215200
	\|text= If the server blocks [[execVM]] in [[~~Arma_3~~:~~_CfgRemoteExec~~\|CfgRemoteExec]], you can't use path to script:		\|text= If the server blocks [[execVM]] in [[Arma 3: CfgRemoteExec\|CfgRemoteExec]], you can't use path to script:
	<sqf>		<sqf>
	_obj addAction ["Test", "path\script.sqf"]; // "path\script.sqf" won't execute		_obj addAction ["Test", "path\script.sqf"]; // "path\script.sqf" won't execute
Line 304:		Line 306:

	<sqf>		<sqf>
	_obj addAction ["Test", {_this spawn compile preprocessFileLineNumbers "path\script.sqf"}];		_obj addAction ["Test", { _this spawn compile preprocessFileLineNumbers "path\script.sqf" }];
	</sqf>		</sqf>

	But it's recommended to use functions if the script is called frequently.		But it's recommended to use functions if the script is called frequently.
	}}		}}

Honger: Removed the unnecessary comment from Example 4

2024-02-27T21:59:44Z

Removed the unnecessary comment from Example 4

← Older revision		Revision as of 23:59, 27 February 2024
Line 243:		Line 243:
	true,		true,
	"",		"",
	"true", ~~// _target, _this, _originalTarget~~		"true",
	50,		50,
	false,		false,

Lou Montana: Text replacement - "(\|[pr][0-9]+ = [^- ]) - *T([a-z ])" to "$1 - t$2"

2023-11-08T14:50:37Z

Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2"

← Older revision		Revision as of 16:50, 8 November 2023
Line 38:		Line 38:
	\|p1= '''object''': [[Object]] - unit, vehicle or static object. '''No [[createAgent\|agents]]!'''		\|p1= '''object''': [[Object]] - unit, vehicle or static object. '''No [[createAgent\|agents]]!'''

	\|p2= '''title''': [[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 {{hl\|&lt;}} for '''<''' and {{hl\|&gt;}} for '''>'''. The title text appearance can be changed with [[setUserActionText]]		\|p2= '''title''': [[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 {{hl\|&lt;}} for '''<''' and {{hl\|&gt;}} for '''>'''. The title text appearance can be changed with [[setUserActionText]]

	\|p3= '''script''': [[String]] - path to the script file, relative to the mission folder. It will run in [[Scheduler#Scheduled Environment\|scheduled environment]], i.e. it is ok to use [[sleep]]. Parameters array passed to the script upon activation in ''[[Magic Variables#this\|_this]]'' variable is:		\|p3= '''script''': [[String]] - path to the script file, relative to the mission folder. It will run in [[Scheduler#Scheduled Environment\|scheduled environment]], i.e. it is ok to use [[sleep]]. Parameters array passed to the script upon activation in ''[[Magic Variables#this\|_this]]'' variable is:
Line 102:		Line 102:
	\|p15since= tkoh 1.00		\|p15since= tkoh 1.00

	\|r1= [[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 the [[#Syntax\|''script'' parameter]])		\|r1= [[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 the [[#Syntax\|''script'' parameter]])

	\|x1= <sqf>		\|x1= <sqf>
Line 207:		Line 207:
	\|p13since= arma3 1.82		\|p13since= arma3 1.82

	\|r1= [[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 the [[#Syntax 2\|''script'' parameter]])		\|r1= [[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 the [[#Syntax 2\|''script'' parameter]])

	\|x1= <sqf>		\|x1= <sqf>

Lou Montana: Text replacement - "(\|[pr][0-9]+ = [^-\r\n]+) - U([a-z])" to "$1 - u$2"

2023-11-08T13:45:39Z

Text replacement - "(\|[pr][0-9]+ *= *[^-\r\n]+) *- *U([a-z])" to "$1 - u$2"

← Older revision		Revision as of 15:45, 8 November 2023
Line 36:		Line 36:
	\|s1= object [[addAction]] [title, script, arguments, priority, showWindow, hideOnUse, shortcut, condition, positionInModel, radius, radiusView, showIn3D, available, textDefault, textToolTip]		\|s1= object [[addAction]] [title, script, arguments, priority, showWindow, hideOnUse, shortcut, condition, positionInModel, radius, radiusView, showIn3D, available, textDefault, textToolTip]

	\|p1= '''object''': [[Object]] - ~~Unit~~, vehicle or static object. '''No [[createAgent\|agents]]!'''		\|p1= '''object''': [[Object]] - unit, vehicle or static object. '''No [[createAgent\|agents]]!'''

	\|p2= '''title''': [[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 {{hl\|&lt;}} for '''<''' and {{hl\|&gt;}} for '''>'''. The title text appearance can be changed with [[setUserActionText]]		\|p2= '''title''': [[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 {{hl\|&lt;}} for '''<''' and {{hl\|&gt;}} for '''>'''. The title text appearance can be changed with [[setUserActionText]]

Lou Montana: Text replacement - "(\|p[0-9]+ = [^(]+$Optional(, default[^)]*)$ )S([a-z])" to "$1s$3"

2023-11-08T11:32:30Z

Text replacement - "(\|p[0-9]+ *= *[^(]+$Optional(, default[^)]*)$ )S([a-z])" to "$1s$3"

← Older revision		Revision as of 13:32, 8 November 2023
Line 96:		Line 96:
	\|p13since= tkoh 1.00		\|p13since= tkoh 1.00

	\|p14= '''textDefault''': [[String]] - (Optional, default "") ~~Structured~~ Text which is shown as the 3D action (so it can be an icon), or in the center of the screen when the action is highlighted in the action menu for a 2D action		\|p14= '''textDefault''': [[String]] - (Optional, default "") structured Text which is shown as the 3D action (so it can be an icon), or in the center of the screen when the action is highlighted in the action menu for a 2D action
	\|p14since= tkoh 1.00		\|p14since= tkoh 1.00

	\|p15= '''textToolTip''': [[String]] - (Optional, default "") ~~Structured~~ Text which is faded in under the textDefault when hovering over the action in 3D space		\|p15= '''textToolTip''': [[String]] - (Optional, default "") structured Text which is faded in under the textDefault when hovering over the action in 3D space
	\|p15since= tkoh 1.00		\|p15since= tkoh 1.00

Lou Montana: Text replacement - "(\|p[0-9]+ = [^(]+$Optional(, default[^)]*)$ )P([a-z])" to "$1p$3"

2023-11-08T11:31:58Z

Text replacement - "(\|p[0-9]+ *= *[^(]+$Optional(, default[^)]*)$ )P([a-z])" to "$1p$3"

← Older revision		Revision as of 13:31, 8 November 2023
Line 50:		Line 50:
	\|p4since= arma1 1.00		\|p4since= arma1 1.00

	\|p5= '''priority''': [[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 to 6		\|p5= '''priority''': [[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 to 6
	\|p5since= arma1 1.00		\|p5since= arma1 1.00

addAction - Revision history

Lou Montana: Text replacement - " ''via'' " to " via "

Lou Montana: Text replacement - "↵↵" to " "

Lou Montana: Text replacement - "([^↵][^<]↵[^<])<\/sqf>" to " $1 "

Lou Montana: Text replacement - "[[Arma 3 " to "[[Arma 3: "

Lou Montana: Add positionInModel back to TKOH's version

Honger: Removed the unnecessary comment from Example 4

Lou Montana: Text replacement - "(\|[pr][0-9]+ = [^- ]) - *T([a-z ])" to "$1 - t$2"

Lou Montana: Text replacement - "(\|[pr][0-9]+ = [^-\r\n]+) - U([a-z])" to "$1 - u$2"

Lou Montana: Text replacement - "(\|p[0-9]+ = [^(]+\(Optional(, default[^)]*)\) )S([a-z])" to "$1s$3"

Lou Montana: Text replacement - "(\|p[0-9]+ = [^(]+\(Optional(, default[^)]*)\) )P([a-z])" to "$1p$3"

addAction - Revision history

Lou Montana: Text replacement - " ''via'' " to " via "

Lou Montana: Text replacement - "↵↵" to " "

Lou Montana: Text replacement - "([^↵][^<]*↵[^<]*)<\/sqf>" to " $1 "

Lou Montana: Text replacement - "[[Arma 3 " to "[[Arma 3: "

Lou Montana: Add positionInModel back to TKOH's version

Honger: Removed the unnecessary comment from Example 4

Lou Montana: Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2"

Lou Montana: Text replacement - "(\|[pr][0-9]+ *= *[^-\r\n]+) *- *U([a-z])" to "$1 - u$2"

Lou Montana: Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )S([a-z])" to "$1s$3"

Lou Montana: Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )P([a-z])" to "$1p$3"

Lou Montana: Text replacement - "([^↵][^<]↵[^<])<\/sqf>" to " $1 "

Lou Montana: Text replacement - "(\|[pr][0-9]+ = [^- ]) - *T([a-z ])" to "$1 - t$2"

Lou Montana: Text replacement - "(\|[pr][0-9]+ = [^-\r\n]+) - U([a-z])" to "$1 - u$2"

Lou Montana: Text replacement - "(\|p[0-9]+ = [^(]+\(Optional(, default[^)]*)\) )S([a-z])" to "$1s$3"

Lou Montana: Text replacement - "(\|p[0-9]+ = [^(]+\(Optional(, default[^)]*)\) )P([a-z])" to "$1p$3"