setUserActionText: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (removed redundand params (not available in A3)) |
Killzone Kid (talk | contribs) (optional extended params) |
||
Line 11: | Line 11: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Changes user added action menu item text. |= Description | | Changes user added action (see [[addAction]]) menu item text. <br><br> | ||
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'' <nowiki>=</nowiki> [[true]])<br><br> | |||
[[Image:setUserActionText.jpg|500px]] | |||
|= Description | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | object '''setUserActionText''' [actionIndex, textMenu, textWindowBackground, textWindowForeground] |= Syntax | ||
|p1= | |p1= object: [[Object]] - object the action is added to |= PARAMETER1 | ||
|p2= [ | |p2= [actionIndex, textMenu, textWindowBackground, textWindowForeground] : [[Array]] |= PARAMETER2 | ||
|p3= | |p3= actionIndex: [[Number]] - action id returned by [[addAction]] |= PARAMETER3 | ||
|p4= | |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'') |= PARAMETER4 | |||
|p6= textWindowForeground (Optional): [[String]] or [[Structured Text]] - Text displayed at foreground (''Since Arma 3 v1.61.136587'')|= PARAMETER4 | |||
| [[Nothing]] |= RETURNVALUE | | [[Nothing]] |= RETURNVALUE | ||
Line 30: | Line 36: | ||
[[player]] [[setUserActionText]] [_id, "Good Bye"];</code>|= EXAMPLE1 | [[player]] [[setUserActionText]] [_id, "Good Bye"];</code>|= EXAMPLE1 | ||
|x2= <code>_id = billboard [[addAction]] ["Some Action", {}]; | |||
billboard [[setUserActionText]] [ | |||
_id, | |||
"Some Action", | |||
<nowiki>"<t color='#ff0000'>Background-----------------</t><br/>Multiline<br/>Multiline<br/>Multiline<br/>. . ."</nowiki>, | |||
<nowiki>"<t color='#00ff00'>-----------------Foreground</t>"</nowiki> | |||
];</code>|= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 17:34, 7 June 2016
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:
- addActionremoveActionremoveAllActions
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