setAttributes: Difference between revisions

Revision as of 02:27, 17 January 2021

Hover & click on the images for description

Description:: Returns a Structured Text created from the given structured text and sets attributes to the given values.

⚠
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
Groups:: Strings Structured Text

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

Example 1:: _txt = text "Red text, right align"; _txt setAttributes ["color", "#ff0000", "align", "right"]; hint composeText [_txt];

: 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

@@ Line 1: / Line 1: @@
 {{Command|Comments=
-____________________________________________________________________________________________
 | arma1 |Game name=
@@ Line 9: / Line 8: @@
 |gr2= Structured Text |GROUP2=
-____________________________________________________________________________________________
 | 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]]}} |DESCRIPTION=
-____________________________________________________________________________________________
 | text '''setAttributes''' [name1, value1, name2, value2, ...] |SYNTAX=
@@ Line 23: / Line 20: @@
 | [[Structured Text]] |RETURNVALUE=
-____________________________________________________________________________________________
 |x1= <code>_txt = [[text]] "Red text, right align";
 _txt [[setAttributes]] ["color", "#ff0000", "align", "right"];
 [[hint]] [[composeText]] [_txt];</code> |EXAMPLE1=
-____________________________________________________________________________________________
 | [[composeText]], [[formatText]], [[parseText]], [[text]], [[ctrlSetStructuredText]] |SEEALSO=