buttonSetAction: Difference between revisions

From Bohemia Interactive Community
mNo edit summary
m (Text replacement - "\] +\[" to "] [")
 
(79 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.75


|1.5|= Game version
|game2= ofpe
|version2= 1.00


|arg= local |= Arguments in MP
|game3= arma1
|version3= 1.00


|eff= local |= Effects in MP
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Set the action of a control of the currently active user dialog. Can be used for buttons and active texts. See [[Dialog Control]] for more information about user dialogs. Works with:
|game5= arma2oa
* CT_BUTTON
|version5= 1.50
* CT_XBUTTON
* CT_ACTIVETEXT
* CT_SHORTCUTBUTTON
{{warning | The action code is expected to be in '''[[SQS]]''' format}} |= Description
____________________________________________________________________________________________


| '''buttonSetAction''' [idc, action] |= Syntax
|game6= tkoh
|p1= [idc, action]: [[Array]] |= Parameter 1
|version6= 1.00
|p2= idc: [[Number]] - control ID |= Parameter 2
|p3= action: [[String]] - [[SQS]] code body that should be executed when the button/active text is clicked |= Parameter 3
| [[Nothing]] |= Return value


|s2= control '''buttonSetAction''' action |= Syntax
|game7= arma3
|p21= control:  [[Control]] - button control|= Parameter 1
|version7= 0.50
|p22= action:  [[String]] - [[SQS]] code body that should be executed when the button/active text is clicked |= Parameter 2
|r2= [[Nothing]] |= Return value
____________________________________________________________________________________________
 
|x1= <code>[[buttonSetAction]] [100, "[[player]] [[exec]] ""reply.sqs"""];</code> |= Example 1
|x2= <code>_ctrl [[buttonSetAction]] "[[if]] ([[alive]] bob) [[then]] {[[hint]] 'alive'} [[else]] {[[hint]] 'dead'}"; // SQF but SQS compatible, see [[SQS]]</code> |= Example 2
____________________________________________________________________________________________


| [[buttonAction]], [[ctrlActivate]] |= See also
|gr1= GUI Control


|arg= local
|eff= local
|descr=
{{Feature|obsolete|Use [[ctrlAddEventHandler]] instead.}}
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]]
* [[CT_ACTIVETEXT]]
* [[CT_SHORTCUTBUTTON]]
|s1= [[buttonSetAction]] [idc, action]
|p1= idc: [[Number]] - button IDC
|p2= action: [[String]] - '''[[SQS Syntax|SQS]]''' code body that should be executed when the button/active text is clicked
|r1= [[Nothing]]
|s2= control [[buttonSetAction]]  action
|p21= control:  [[Control]] - button control
|p22= action:  [[String]] - '''[[SQS Syntax|SQS]]''' code body that should be executed when the button/active text is clicked
|r2= [[Nothing]]
|x1= <sqf>buttonSetAction [100, "player exec ""reply.sqs"""];</sqf>
|x2= <sqf>_ctrl buttonSetAction "if (alive bob) then {hint 'alive'} else {hint 'dead'}"; // SQF but SQS compatible, see SQS</sqf>
|x3= Script is [[SQS Syntax|SQS]]:
<sqs>_control buttonSetAction "hint format ['Is SQS: %1', !isNil '_time']"</sqs>
|seealso= [[buttonAction]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Kungtotte
<!-- Note Section BEGIN -->
|timestamp= 20091005162300
<dd class="notedate">Posted on October 5, 2009 - 16:23
|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.
<pre><nowiki>
/* This will print 'any bar' in the hint box,
/* This will print 'any bar' in the hint box,
  since _foo has no value according to buttonSetAction */
  since _foo has no value according to buttonSetAction */


_foo = "foo";
_foo = "foo";
buttonSetAction [100, "hint format[""%1 bar"", _foo];"];</nowiki></pre>
buttonSetAction [100, "hint format [""%1 bar"", _foo];"];
</sqf>
}}


<!-- Note Section END -->
{{Note
</dl>
|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.
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
 
|user= Nomisum
[[Category:Scripting Commands|BUTTONSETACTION]]
|timestamp= 20160611192400
[[Category:Scripting Commands OFP 1.99|BUTTONSETACTION]]
|text= To use variables local to the defining script, a syntax like the one below needs to be used:
[[Category:Scripting Commands OFP 1.96|BUTTONSETACTION]]
<sqf>
[[Category:Scripting Commands ArmA|BUTTONSETACTION]]
_foo = "foo";
[[Category:Scripting Commands ArmA2|BUTTONSETACTION]]
buttonSetAction [100, format ["hint '%1 bar'", _foo]];
[[Category:Command_Group:_GUI_Control|BUTTONSETACTION]]
</sqf>
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
works! thanks to [[User:Kronzky|Kronzky]] for commenting this workaround in the VBS wiki
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on February 15, 2016 - 10:15 (UTC)</dd>
<dt class="note">[[User:Molaron|Molaron]]</dt>
<dd class="note">
This command does not overwride the buttonaction which was set via "action" in the hpp of the dialog
</dd>
</dl>
<!-- DISCONTINUE Notes -->
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<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>
<!-- DISCONTINUE Notes -->

Latest revision as of 11:46, 5 May 2024

Logo A0.png 1.75ofpe logo.png 1.00Logo A1 black.png 1.00Logo A2.png 1.00A2 OA Logo.png 1.50tkoh logo small.png 1.00Arma 3 logo black.png 0.50
LALocalLELocal
Hover & click on the images for description

Description

Description:
🕖
This information is obsolete. Reason: Use ctrlAddEventHandler instead.

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
Retrieved from "https://community.bistudio.com/wiki?title=buttonSetAction&oldid=364179"