setUserActionText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
Line 18: Line 18:
|p2= actionIndex: [[Number]] - action id returned by [[addAction]]
|p2= actionIndex: [[Number]] - action id returned by [[addAction]]


|p3= textMenu: [[String]] or [[Structured Text]] - Text title shown in scroll action menu
|p3= textMenu: [[String]] or [[Structured Text]] - text title shown in scroll action menu


|p4= textWindowBackground: [[String]] or [[Structured Text]] - (Optional, default "") background text
|p4= textWindowBackground: [[String]] or [[Structured Text]] - (Optional, default "") background text

Revision as of 16:51, 8 November 2023

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