setUserActionText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(mp effects)
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(50 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 0.50


|0.50|= Game version
|arg= global


|arg= global |= Arguments in MP
|eff= local


|eff= local |= Effects in MP
|gr1= Interaction
____________________________________________________________________________________________


| Changes user added action menu item text. |= Description
|descr= [[File:setUserActionText.jpg|right|350px]] Changes user added action (see [[addAction]]) menu item text. <br><br>
____________________________________________________________________________________________


| unit '''setUserActionText''' [index, text, textDefault, textToolTip] |= Syntax
|s1= object [[setUserActionText]] [actionIndex, textMenu, textWindowBackground, textWindowForeground]


|p1= unit: [[Object]] |= PARAMETER1
|p1= object: [[Object]] - object the action is added to


|p2= [index, text, textDefault, textToolTip]: [[Array]] |= PARAMETER2
|p2= actionIndex: [[Number]] - action id returned by [[addAction]]


|p3= index: [[Number]] - Action id returned by [[addAction]] |= PARAMETER3
|p3= textMenu: [[String]] or [[Structured Text]] - text title shown in scroll action menu


|p4= text: [[String]] or [[Structured Text]] - Action title |= PARAMETER4
|p4= textWindowBackground: [[String]] or [[Structured Text]] - (Optional, default "") background text
|p4since= arma3 1.62


|p5= textDefault: [[String]] (does nothing, looks like leftover from [[:Category:Take_On|TKOH]]) |= PARAMETER5
|p5= textWindowForeground: [[String]] or [[Structured Text]] - (Optional, default "") foreground text
|p5since= arma3 1.62


|p6= textToolTip: [[String]] (does nothing, looks like leftover from [[:Category:Take_On|TKOH]]) |= PARAMETER6
|r1= [[Nothing]]


| [[Nothing]] |= RETURNVALUE
|x1= <sqf>
_id = player addAction ["Hello", ""];
player setUserActionText [_id, "Good Bye"];
</sqf>


|x2= <sqf>
_id = billboard addAction ["Some Action", {}];
billboard setUserActionText [
_id,
"Some Action",
"<t color='#ff0000'>Background-----------------</t><br>Multiline<br>Multiline<br>Multiline<br>. . .",
"<t color='#00ff00'>-----------------Foreground</t>"
];
</sqf>


|x1= <code>_id = [[player]] [[addAction]] ["Hello", ""];
|seealso= [[actionIDs]] [[actionParams]] [[addAction]] [[inGameUISetEventHandler]] [[showHUD]] [[inputAction]] [[removeAction]] [[removeAllActions]] [[action]]
[[player]] [[setUserActionText]] [_id, "Good Bye"];</code>|= EXAMPLE1
 
____________________________________________________________________________________________
 
| [[addAction]], [[removeAction]], [[removeAllActions]] |= SEEALSO
 
|  |= MPBEHAVIOUR
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:34, 3 September 2024

Arma 3 logo black.png0.50
GAGlobalLELocal
Hover & click on the images for description

Description

Description:
setUserActionText.jpg
Changes user added action (see addAction) menu item text.

Groups:
Interaction

Syntax

Syntax:
object setUserActionText [actionIndex, textMenu, textWindowBackground, textWindowForeground]
Parameters:
object: Object - object the action is added to
actionIndex: Number - action id returned by addAction
textMenu: String or Structured Text - text title shown in scroll action menu
since Arma 3 logo black.png1.62
textWindowBackground: String or Structured Text - (Optional, default "") background text
since Arma 3 logo black.png1.62
textWindowForeground: String or Structured Text - (Optional, default "") foreground text
Return Value:
Nothing

Examples

Example 1:
_id = player addAction ["Hello", ""]; player setUserActionText [_id, "Good Bye"];
Example 2:
_id = billboard addAction ["Some Action", {}]; billboard setUserActionText [ _id, "Some Action", "<t color='#ff0000'>Background-----------------</t><br>Multiline<br>Multiline<br>Multiline<br>. . .", "<t color='#00ff00'>-----------------Foreground</t>" ];

Additional Information

See also:
actionIDs actionParams addAction inGameUISetEventHandler showHUD inputAction removeAction removeAllActions action

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