setAttributes: Difference between revisions

Latest revision as of 03:34, 27 November 2023

1.00

1.50

1.00

0.50

Hover & click on the images for description

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

Syntax:: text setAttributes [name1, value1, name2, value2, ...]
Parameters:: text: String or Structured Text - only passing Structured Text has any effect
: nameN: String - name of the attribute
: valueN: 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

See also:: composeText formatText parseText text ctrlSetStructuredText

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

@@ Line 1: / Line 1: @@
 {{RV|type=command
-| ofpe
+|game1= ofpe
-| 1.00
+|version1= 1.00
 |game2= arma1
@@ Line 23: / Line 23: @@
 |gr2= Structured Text
-| Returns a [[Structured Text]] created from the given [[Structured Text|structured]] text and sets [[Structured_Text#Attributes | attributes]] to the given values.{{Feature | 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]]}}
+|descr= Returns a [[Structured Text]] created from the given [[Structured Text|structured]] text and sets [[Structured_Text#Attributes | attributes]] to the given values.
+{{Feature|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 {{Link|#Example 1}}) or [[formatText]].
+}}
-|s1=  text '''setAttributes''' [name1, value1, name2, value2, ...]
+|s1= text [[setAttributes]] [name1, value1, name2, value2, ...]
 |p1= text: [[String]] or [[Structured Text]] - only passing [[Structured Text]] has any effect
-|p2= [name1, value1, name2, value2, ...]: [[Array]]
-|p3= name: [[String]] - name of the attribute
-|p4= value: [[String]] - value of the attribute
-|r1=[[Structured Text]]
+|p2= nameN: [[String]] - name of the attribute
+|p3= valueN: [[String]] - value of the attribute
+|r1= [[Structured Text]]
-|x1= <code>_txt = [[text]] "Red text, right align";
+|x1= <sqf>
-_txt [[setAttributes]] ["color", "#ff0000", "align", "right"];
+_txt = text "Red text, right align";
-[[hint]] [[composeText]] [_txt];</code>
+_txt setAttributes ["color", "#FF0000", "align", "right"];
+hint composeText [_txt];
+</sqf>
-|seealso= [[composeText]], [[formatText]], [[parseText]], [[text]], [[ctrlSetStructuredText]]
+|seealso= [[composeText]] [[formatText]] [[parseText]] [[text]] [[ctrlSetStructuredText]]
 }}
-{{GameCategory|ofpe|Scripting Commands}}
-{{GameCategory|arma1|Scripting Commands}}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}