setUserActionText

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Arma 3 version 0.50
  Arguments of this scripting command don't have to be local to the client the command is executed onEffects of this scripting command are not broadcasted over the network and remain local to the client the command is executed on

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
0.50

Description

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

Since Arma 3 v1.61.136587 it is possible to set 2 more optional texts, one for background and one for foreground when action is displayed on the screen (showWindow = true)

setUserActionText.jpg

Syntax

Syntax:
object setUserActionText [actionIndex, textMenu, textWindowBackground, textWindowForeground]
Parameters:
object: Object - object the action is added to
[actionIndex, textMenu, textWindowBackground, textWindowForeground] : Array
actionIndex: Number - action id returned by addAction
textMenu: String or Structured Text - Text title shown in scroll action menu
textWindowBackground (Optional): String or Structured Text - Text displayed at background (Since Arma 3 v1.61.136587)
textWindowForeground (Optional): String or Structured Text - Text displayed at foreground (Since Arma 3 v1.61.136587)
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

Multiplayer:
-
See also:
actionIDsactionParamsaddActioninGameUISetEventHandlershowHUDinputActionremoveActionremoveAllActionsaction

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section