buttonSetAction: Difference between revisions

Revision as of 22:53, 21 July 2022

1.75

1.00

Hover & click on the images for description

Description

Description:

Set the action of a control of the currently active user dialog. The script statement is executed on button release and _this is available, but contains ""; See Arma: GUI Configuration for more information about user dialogs. Works with:

Groups:

GUI Control

Syntax

Syntax:: buttonSetAction [idc, action]
Parameters:: idc: Number - Button IDC
: action: String - SQS code body that should be executed when the button/active text is clicked
Return Value:: Nothing

Alternative Syntax

Syntax:: control buttonSetAction action
Parameters:: control: Control - Button control
: action: String - SQS code body that should be executed when the button/active text is clicked
Return Value:: Nothing

Examples

Example 1:: buttonSetAction [100, "player exec ""reply.sqs"""];
Example 2:: _ctrl buttonSetAction "if (alive bob) then {hint 'alive'} else {hint 'dead'}"; // SQF but SQS compatible, see SQS
Example 3:: Script is SQS:
_control buttonSetAction "hint format ['Is SQS: %1', !isNil '_time']"

Additional Information

See also:: buttonAction

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

Kungtotte - c: Posted on Oct 05, 2009 - 16:23 (UTC)
: When using buttonSetAction for an ActiveText control from a script, you cannot use any variables local to the script in it.
/* This will print 'any bar' in the hint box, since _foo has no value according to buttonSetAction */ _foo = "foo"; buttonSetAction [100, "hint format [""%1 bar"", _foo];"];

Molaron - c: Posted on Feb 15, 2016 - 10:15 (UTC)
: This command does not overwrite the button's action that was set via "action" in the .hpp of the dialog.

Nomisum - c: Posted on Jun 11, 2016 - 19:24 (UTC)
: To use variables local to the defining script, a syntax like the one below needs to be used:
_foo = "foo"; buttonSetAction [100, format ["hint '%1 bar'", _foo]];
works! thanks to Kronzky for commenting this workaround in the VBS wiki

@@ Line 28: / Line 28: @@
 |eff= local
-|descr= Set the action of a control of the currently active user dialog. The script statement is executed on button release and <tt>_this</tt> is available, but contains ""; See [[Arma: GUI Configuration]] for more information about user dialogs. Works with:
+|descr= Set the action of a control of the currently active user dialog. The script statement is executed on button release and {{hl|_this}} is available, but contains ""; See [[Arma: GUI Configuration]] for more information about user dialogs. Works with:
 * [[CT_BUTTON]]
 * [[CT_XBUTTON]]
@@ Line 34: / Line 34: @@
 * [[CT_SHORTCUTBUTTON]]
-|s1= '''buttonSetAction''' [idc, action]
+|s1= [[buttonSetAction]]  [idc, action]
 |p1= idc: [[Number]] - Button IDC
@@ Line 42: / Line 42: @@
 |r1= [[Nothing]]
-|s2= control '''buttonSetAction''' action
+|s2= control [[buttonSetAction]]  action
 |p21= control:  [[Control]] - Button control
@@ Line 50: / Line 50: @@
 |r2= [[Nothing]]
-|x1= <code>[[buttonSetAction]] [100, "[[player]] [[exec]] ""reply.sqs"""];</code>
+|x1= <sqf>buttonSetAction [100, "player exec ""reply.sqs"""];</sqf>
-|x2= <code>_ctrl [[buttonSetAction]] "[[if]] ([[alive]] bob) [[then]] {[[hint]] 'alive'} [[else]] {[[hint]] 'dead'}"; // SQF but SQS compatible, see [[SQS Syntax|SQS]]</code>
+|x2= <sqf>_ctrl buttonSetAction "if (alive bob) then {hint 'alive'} else {hint 'dead'}"; // SQF but SQS compatible, see SQS</sqf>
-|x3= Script is SQS<code>_control [[buttonSetAction]] "[[hint]] [[format]] ['Is SQS: %1', ![[isNil]] '_time']";</code>
+|x3= Script is [[SQS Syntax|SQS]]:
+<sqs>_control buttonSetAction "hint format ['Is SQS: %1', !isNil '_time']"</sqs>
 |seealso= [[buttonAction]]
 }}
-<dl class="command_description">
+{{Note
+|user= Kungtotte
-<dt></dt>
+|timestamp= 20091005162300
-<dd class="notedate">Posted on October 5, 2009 - 16:23</dd>
+|text= When using buttonSetAction for an ActiveText control from a script, you cannot use any variables local to the script in it.
-<dt class="note">[[User:Kungtotte|kungtotte]]<dd class="note">
+<sqf>
-When using buttonSetAction for an ActiveText control from a script, you cannot use any variables local to the script in it.
+/* This will print 'any bar' in the hint box,
-<code>/* This will print 'any bar' in the hint box,
   since _foo has no value according to buttonSetAction */
 _foo = "foo";
-[[buttonSetAction]] [100, "[[hint]] [[format]] [""%1 bar"", _foo];"];</code>
+buttonSetAction [100, "hint format [""%1 bar"", _foo];"];
+</sqf>
+}}
-</dl>
+{{Note
+|user= Molaron
+|timestamp= 20160215101500
+|text= This command does not overwrite the button's action that was set via "action" in the {{hl|.hpp}} of the dialog.
+}}
-<dl class="command_description">
+{{Note
+|user= Nomisum
-<dt></dt>
+|timestamp= 20160611192400
-<dd class="notedate">Posted on February 15, 2016 - 10:15 (UTC)</dd>
+|text= To use variables local to the defining script, a syntax like the one below needs to be used:
-<dt class="note">[[User:Molaron|Molaron]]</dt>
+<sqf>
-<dd class="note">
+_foo = "foo";
-This command does not overwrite the button's action that was set via "action" in the .hpp of the dialog
+buttonSetAction [100, format ["hint '%1 bar'", _foo]];
-</dd>
+</sqf>
+works! thanks to [[User:Kronzky|Kronzky]] for commenting this workaround in the VBS wiki
-<dt><dt>
+}}
-<dd class="notedate">Posted on June 11, 2016 - 19:24 (UTC)</dd>
-<dt class="note">[[User:Nomisum|Nomisum]]</dt>
-<dd class="note">
-To use variables local to the defining script, a syntax like the one below needs to be used:
-<code>_foo = "foo";
-buttonSetAction [100, [[format]] ["[[hint]] '%1 bar'", _foo]];</code>
-works! thanks to Kronzky for commenting this workaround in the VBS wiki
-</dd>
-</dl>