buttonSetAction: Difference between revisions
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?]]" to "{{GameCategory|tkoh|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| ofp |Game name= | | ofp |Game name= | ||
| Line 11: | Line 10: | ||
|eff= local |Multiplayer Effects= | |eff= local |Multiplayer Effects= | ||
| 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: | | 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: | ||
| Line 19: | Line 17: | ||
* CT_SHORTCUTBUTTON | * CT_SHORTCUTBUTTON | ||
{{Warning | The action code is expected to be in '''[[SQS]]''' format}} |DESCRIPTION= | {{Warning | The action code is expected to be in '''[[SQS]]''' format}} |DESCRIPTION= | ||
| '''buttonSetAction''' [idc, action] |SYNTAX= | | '''buttonSetAction''' [idc, action] |SYNTAX= | ||
| Line 32: | Line 29: | ||
|p22= action: [[String]] - [[SQS]] code body that should be executed when the button/active text is clicked |PARAMETER22= | |p22= action: [[String]] - [[SQS]] code body that should be executed when the button/active text is clicked |PARAMETER22= | ||
|r2= [[Nothing]] |RETURNVALUE2= | |r2= [[Nothing]] |RETURNVALUE2= | ||
|x1= <code>[[buttonSetAction]] [100, "[[player]] [[exec]] ""reply.sqs"""];</code> |EXAMPLE1= | |x1= <code>[[buttonSetAction]] [100, "[[player]] [[exec]] ""reply.sqs"""];</code> |EXAMPLE1= | ||
|x2= <code>_ctrl [[buttonSetAction]] "[[if]] ([[alive]] bob) [[then]] {[[hint]] 'alive'} [[else]] {[[hint]] 'dead'}"; // SQF but SQS compatible, see [[SQS]]</code> |EXAMPLE2= | |x2= <code>_ctrl [[buttonSetAction]] "[[if]] ([[alive]] bob) [[then]] {[[hint]] 'alive'} [[else]] {[[hint]] 'dead'}"; // SQF but SQS compatible, see [[SQS]]</code> |EXAMPLE2= | ||
|x3= Script is SQS<code>_control [[buttonSetAction]] "[[hint]] [[format]] ['Is SQS: %1', ![[isNil]] '_time']";</code> |EXAMPLE3= | |x3= Script is SQS<code>_control [[buttonSetAction]] "[[hint]] [[format]] ['Is SQS: %1', ![[isNil]] '_time']";</code> |EXAMPLE3= | ||
| [[buttonAction]], [[ctrlActivate]] |SEEALSO= | | [[buttonAction]], [[ctrlActivate]] |SEEALSO= | ||
Revision as of 00:23, 17 January 2021
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:
- CT_BUTTON
- CT_XBUTTON
- CT_ACTIVETEXT
- CT_SHORTCUTBUTTON
- Groups:
- GUI Control
Syntax
- Syntax:
- buttonSetAction [idc, action]
- Parameters:
- [idc, action]: Array
- idc: Number - control ID
- 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:
- buttonActionctrlActivate
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
- Posted on October 5, 2009 - 16:23
- kungtotte
-
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];"];
Bottom Section
- Posted on February 15, 2016 - 10:15 (UTC)
- Molaron
- This command does not overwride the buttonaction which was set via "action" in the hpp of the dialog
- Posted on June 11, 2016 - 19:24 (UTC)
- Nomisum
-
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
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.5
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: GUI Control
- Scripting Commands: Local Effect
- Scripting Commands OFP 1.99
- Scripting Commands OFP 1.96
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 3: Scripting Commands
- Take On Helicopters: Scripting Commands