setAttributes: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma1 |Game name=
| arma1


|1.00|Game version=
|1.00


|gr1= Strings |GROUP1=
|gr1= Strings


|gr2= Structured Text |GROUP2=
|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.<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]]}} |DESCRIPTION=
{{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]]}}


| text '''setAttributes''' [name1, value1, name2, value2, ...] |SYNTAX=
| text '''setAttributes''' [name1, value1, name2, value2, ...]


|p1= text: [[String]] or [[Structured Text]] - only passing [[Structured Text]] has any effect|PARAMETER1=
|p1= text: [[String]] or [[Structured Text]] - only passing [[Structured Text]] has any effect
|p2= [name1, value1, name2, value2, ...]: [[Array]]|PARAMETER2=
|p2= [name1, value1, name2, value2, ...]: [[Array]]
|p3= name: [[String]] - name of the attribute |PARAMETER3=
|p3= name: [[String]] - name of the attribute
|p4= value: [[String]] - value of the attribute |PARAMETER4=
|p4= value: [[String]] - value of the attribute


| [[Structured Text]] |RETURNVALUE=
| [[Structured Text]]
   
   
|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> |EXAMPLE1=
[[hint]] [[composeText]] [_txt];</code>


| [[composeText]], [[formatText]], [[parseText]], [[text]], [[ctrlSetStructuredText]] |SEEALSO=
| [[composeText]], [[formatText]], [[parseText]], [[text]], [[ctrlSetStructuredText]]


}}
}}

Revision as of 11:01, 18 January 2021

Logo A1 black.png1.00
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:
StringsStructured Text

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

See also:
composeTextformatTextparseTexttextctrlSetStructuredText

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


Retrieved from "https://community.bistudio.com/wiki?title=setAttributes&oldid=210378"