setAttributes: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]2(\|.*)\]\]" to "{{GameCategory|arma2|Scripting Commands}}")
mNo edit summary
 
(35 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma1 |Game name=
|game1= ofpe
|version1= 1.00


|1.00|Game version=
|game2= arma1
|version2= 1.00


|gr1= Strings |GROUP1=
|game3= arma2
|version3= 1.00


|gr2= Structured Text |GROUP2=
|game4= arma2oa
____________________________________________________________________________________________
|version4= 1.50


| Returns a [[Structured Text]] created from the given [[Structured Text|structured]] text and sets [[Structured_Text#Attributes | attributes]] to the given values.<br><br>
|game5= tkoh
{{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=
|version5= 1.00
____________________________________________________________________________________________


| text '''setAttributes''' [name1, value1, name2, value2, ...] |SYNTAX=
|game6= arma3
|version6= 0.50


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


| [[Structured Text]] |RETURNVALUE=
|gr2= Structured Text
____________________________________________________________________________________________
 
|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=
|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, ...]
 
|p1= text: [[String]] or [[Structured Text]] - only passing [[Structured Text]] has any effect
 
|p2= nameN: [[String]] - name of the attribute


<h3 style="display:none">Notes</h3>
|p3= valueN: [[String]] - value of the attribute
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|r1= [[Structured Text]]
</dl>


<h3 style="display:none">Bottom Section</h3>
|x1= <sqf>
[[Category:Scripting Commands|SETATTRIBUTES]]
_txt = text "Red text, right align";
[[Category:Scripting Commands OFP Elite |SETATTRIBUTES]]
_txt setAttributes ["color", "#FF0000", "align", "right"];
{{GameCategory|arma1|Scripting Commands}}
hint composeText [_txt];
{{GameCategory|arma2|Scripting Commands}}
</sqf>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
|seealso= [[composeText]] [[formatText]] [[parseText]] [[text]] [[ctrlSetStructuredText]]
<!-- DISCONTINUE Notes -->
}}

Latest revision as of 03:34, 27 November 2023

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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:
StringsStructured 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
Retrieved from "https://community.bistudio.com/wiki?title=setAttributes&oldid=351277"