setUserActionText: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (see also) |
m (template:command argument fix) |
||
| Line 20: | Line 20: | ||
| object '''setUserActionText''' [actionIndex, textMenu, textWindowBackground, textWindowForeground] |= Syntax | | object '''setUserActionText''' [actionIndex, textMenu, textWindowBackground, textWindowForeground] |= Syntax | ||
|p1= object: [[Object]] - object the action is added to |= | |p1= object: [[Object]] - object the action is added to |PARAMETER1= | ||
|p2= [actionIndex, textMenu, textWindowBackground, textWindowForeground] : [[Array]] |= | |p2= [actionIndex, textMenu, textWindowBackground, textWindowForeground] : [[Array]] |PARAMETER2= | ||
|p3= actionIndex: [[Number]] - action id returned by [[addAction]] |= | |p3= actionIndex: [[Number]] - action id returned by [[addAction]] |PARAMETER3= | ||
|p4= textMenu: [[String]] or [[Structured Text]] - Text title shown in scroll action menu |= | |p4= textMenu: [[String]] or [[Structured Text]] - Text title shown in scroll action menu |PARAMETER4= | ||
|p5= textWindowBackground (Optional): [[String]] or [[Structured Text]] - Text displayed at background (''Since Arma 3 v1.61.136587'') |= | |p5= textWindowBackground (Optional): [[String]] or [[Structured Text]] - Text displayed at background (''Since Arma 3 v1.61.136587'') |PARAMETER4= | ||
|p6= textWindowForeground (Optional): [[String]] or [[Structured Text]] - Text displayed at foreground (''Since Arma 3 v1.61.136587'')|= | |p6= textWindowForeground (Optional): [[String]] or [[Structured Text]] - Text displayed at foreground (''Since Arma 3 v1.61.136587'')|PARAMETER4= | ||
| [[Nothing]] |= | | [[Nothing]] |RETURNVALUE= | ||
|x1= <code>_id = [[player]] [[addAction]] ["Hello", ""]; | |x1= <code>_id = [[player]] [[addAction]] ["Hello", ""]; | ||
[[player]] [[setUserActionText]] [_id, "Good Bye"];</code>|= | [[player]] [[setUserActionText]] [_id, "Good Bye"];</code>|EXAMPLE1= | ||
|x2= <code>_id = billboard [[addAction]] ["Some Action", {}]; | |x2= <code>_id = billboard [[addAction]] ["Some Action", {}]; | ||
| Line 45: | Line 45: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[actionIDs]], [[actionParams]], [[addAction]], [[inGameUISetEventHandler]], [[showHUD]], [[inputAction]], [[removeAction]], [[removeAllActions]], [[action]] |= | | [[actionIDs]], [[actionParams]], [[addAction]], [[inGameUISetEventHandler]], [[showHUD]], [[inputAction]], [[removeAction]], [[removeAllActions]], [[action]] |SEEALSO= | ||
| |= | | |MPBEHAVIOUR= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
}} | }} | ||
Revision as of 10:37, 7 April 2019
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)
- Groups:
- Uncategorised
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
- See also:
- actionIDsactionParamsaddActioninGameUISetEventHandlershowHUDinputActionremoveActionremoveAllActionsaction
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