setAttributes: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (see also) |
m (template:command argument fix) |
||
| Line 8: | Line 8: | ||
| Returns a [[Structured Text]] created from the given [[Structured Text|structured]] text and sets [[Structured_Text#Attributes | attributes]] to the given values.<br><br> | | Returns a [[Structured Text]] created from the given [[Structured Text|structured]] text and sets [[Structured_Text#Attributes | attributes]] to the given values.<br><br> | ||
{{Important | Even though command accepts plain [[String]] too, the argument should be [[Structured Text]] in order for the set attributes to have an effect. Additionally the result of the command should be fed to [[composeText]] (See Example 1) or [[formatText]]}} |= | {{Important | Even though command accepts plain [[String]] too, the argument should be [[Structured Text]] in order for the set attributes to have an effect. Additionally the result of the command should be fed to [[composeText]] (See Example 1) or [[formatText]]}} |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| text '''setAttributes''' [name1, value1, name2, value2, ...] |= | | text '''setAttributes''' [name1, value1, name2, value2, ...] |SYNTAX= | ||
|p1= text: [[String]] or [[Structured Text]] - only passing [[Structured Text]] has any effect|= | |p1= text: [[String]] or [[Structured Text]] - only passing [[Structured Text]] has any effect|PARAMETER1= | ||
|p2= [name1, value1, name2, value2, ...]: [[Array]]|= | |p2= [name1, value1, name2, value2, ...]: [[Array]]|PARAMETER2= | ||
|p3= name: [[String]] - name of the attribute |= | |p3= name: [[String]] - name of the attribute |PARAMETER3= | ||
|p4= value: [[String]] - value of the attribute |= | |p4= value: [[String]] - value of the attribute |PARAMETER4= | ||
| [[Structured Text]] |= | | [[Structured Text]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_txt = [[text]] "Red text, right align"; | |x1= <code>_txt = [[text]] "Red text, right align"; | ||
_txt [[setAttributes]] ["color", "#ff0000", "align", "right"]; | _txt [[setAttributes]] ["color", "#ff0000", "align", "right"]; | ||
[[hint]] [[composeText]] [_txt];</code> |= | [[hint]] [[composeText]] [_txt];</code> |EXAMPLE1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[composeText]], [[formatText]], [[parseText]], [[text]], [[ctrlSetStructuredText]] |= | | [[composeText]], [[formatText]], [[parseText]], [[text]], [[ctrlSetStructuredText]] |SEEALSO= | ||
}} | }} | ||
Revision as of 15:46, 7 April 2019
Description
- Description:
- Returns a Structured Text created from the given structured text and sets attributes to the given values.
- Groups:
- Uncategorised
Syntax
- Syntax:
- text setAttributes [name1, value1, name2, value2, ...]
- Parameters:
- text: String or Structured Text - only passing Structured Text has any effect
- [name1, value1, name2, value2, ...]: Array
- name: String - name of the attribute
- value: String - value of the attribute
- Return Value:
- Structured Text
Examples
- Example 1:
_txt = text "Red text, right align"; _txt setAttributes ["color", "#ff0000", "align", "right"]; hint composeText [_txt];
Additional Information
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
Notes
Bottom Section