buttonSetAction: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("serv...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| ofp |Game name=
| ofp


|1.5|Game version=
|1.5


|gr1= GUI Control |GROUP1=
|gr1= GUI Control


|arg= local |Multiplayer Arguments=
|arg= local |Multiplayer Arguments=
Line 16: Line 16:
* CT_ACTIVETEXT
* CT_ACTIVETEXT
* 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}}


| '''buttonSetAction''' [idc, action] |SYNTAX=
| '''buttonSetAction''' [idc, action]
|p1= [idc, action]: [[Array]] |PARAMETER1=
|p1= [idc, action]: [[Array]]
|p2= idc: [[Number]] - control ID |PARAMETER2=
|p2= idc: [[Number]] - control ID
|p3= action: [[String]] - [[SQS]] code body that should be executed when the button/active text is clicked |PARAMETER3=
|p3= action: [[String]] - [[SQS]] code body that should be executed when the button/active text is clicked
| [[Nothing]] |RETURNVALUE=
| [[Nothing]]


|s2= control '''buttonSetAction''' action |SYNTAX2=
|s2= control '''buttonSetAction''' action


|p21= control:  [[Control]] - button control|PARAMETER21=
|p21= control:  [[Control]] - button control|PARAMETER21=
|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]]
   
   
|x1= <code>[[buttonSetAction]] [100, "[[player]] [[exec]] ""reply.sqs"""];</code> |EXAMPLE1=
|x1= <code>[[buttonSetAction]] [100, "[[player]] [[exec]] ""reply.sqs"""];</code>
|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>
|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>


| [[buttonAction]], [[ctrlActivate]] |SEEALSO=
| [[buttonAction]], [[ctrlActivate]]


}}
}}

Revision as of 00:03, 18 January 2021

Logo A0.png 1.5
LALocalLELocal
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:
  • CT_BUTTON
  • CT_XBUTTON
  • CT_ACTIVETEXT
  • CT_SHORTCUTBUTTON
⚠
The action code is expected to be in SQS format
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
Retrieved from "https://community.bistudio.com/wiki?title=buttonSetAction&oldid=203922"