set3DENMissionAttributes: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game name" to "|Game name=")
m (Some wiki formatting)
 
(47 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


|arma3|Game name=
|game1= arma3
|version1= 1.56


|1.56|= Game version
|gr1= Eden Editor
____________________________________________________________________________________________


| Set [[Eden_Editor:_Scenario_Atttributes|scenario attributes]].
|descr= Set [[Eden_Editor:_Scenario_Atttributes|scenario attributes]].
<br /><br />
An attribute is identified by its {{hl|property}} ({{hl|data}} when it is an engine-driven attribute) value in config.
An attribute is identified by its <tt>property</tt> (<tt>data</tt> when it's engine-drive attribute) value in config. For the list of all attributes with their properties, see [[Eden_Editor:_Setting_Attributes#Attributes|Setting Attributes]].
For the list of all attributes with their properties, see [[Eden_Editor:_Setting_Attributes#Scenario|Mission Attributes]].


{{Important|Attributes are available only within the Eden Editor workspace. You cannot access them in scenario preview or exported scenario!}}
{{Feature|important|Attributes are available only within the Eden Editor workspace. You cannot access them in scenario preview or exported scenario!}}
|DESCRIPTION=
____________________________________________________________________________________________


| '''set3DENMissionAttributes''' <nowiki>[[<section>,<class1>,<value1>], ..., [<section >,<classN>,<valueN>]]</nowiki> |SYNTAX=
|s1= [[set3DENMissionAttributes]] [<nowiki/>[section1, class1, value1], ...]
|p1= section: [[String]] - attribute section |PARAMETER1=
|p2= class: [[String]] - attribute name |PARAMETER2=
|p3= value: [[Any]] - new attribute value |PARAMETER3=
| [[Bool]] - [[true]] if the value was set |RETURNVALUE=


|x1= <code>[[set3DENMissionAttributes]] <nowiki>[[</nowiki>"Multiplayer","respawn",3],["Multiplayer","respawnDelay",10]];</code>
|p1= sectionN: [[String]] - attribute section. See [[Eden_Editor:_Setting_Attributes#Sections_.26_Properties|Sections & Properties]]
Set respawn type to 3 and respawn delay to 10 seconds |EXAMPLE1=
____________________________________________________________________________________________


|  
|p2= classN: [[String]] - attribute name
[[get3DENMissionAttribute]] [[set3DENMissionAttribute]]
 
|SEEALSO=
|p3= valueN: [[Anything]] - new attribute value
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}


<h3 style='display:none'>Notes</h3>
|r1= [[Nothing]]
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<!-- DISCONTINUE Notes -->


|x1= <sqf>
// set respawn type to 3 and respawn delay to 10 seconds
set3DENMissionAttributes [["Multiplayer", "respawn", 3], ["Multiplayer", "respawnDelay", 10]];
</sqf>


<h3 style='display:none'>Bottom Section</h3>
|seealso= [[get3DENMissionAttribute]] [[set3DENMissionAttribute]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command Group: Eden Editor|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= R3vo
<dd class="notedate">Posted on January 2, 2019 - 12:09 (UTC)</dd>
|timestamp= 20190102120900
<dt class="note">[[User:R3vo|R3vo]]</dt>
|text= Usually, the attributes value can be received by <sqf>_sectionName get3DENMissionAttribute _attributeName; // See example above</sqf>
<dd class="note">
However, if the attribute was not changed and it is default value is used [[get3DENMissionAttribute]] might return [[Nothing]], even though in [[:Category:Eden Editor|Eden Editor]] the attribute has got a value. In that case the attribute's config name is not identical to the 'property' or 'data' config value. To get the right values in these cases one has to do:<br>
Usually, the attributes value can be recieved by <code>_sectionName [[get3DENMissionAttribute]] _attributeName;//See example above</code>
<sqf>
However, if the attribute was not changed and it's default value is used [[get3DENMissionAttribute]] might return [[Nothing]], even though in [[Eden Editor]] the attribute has got a value. In that case the attribute's config name is not identical to the 'property' or 'data' config value. To get the right values in these cases one has to do:<br>
_sectionName get3DENMissionAttribute _propertyName;
<code>_sectionName [[get3DENMissionAttribute]] _propertyName;</code> or
// or
<code>_sectionName [[get3DENMissionAttribute]] _dataName;</code>
_sectionName get3DENMissionAttribute _dataName;
</dd>
</sqf>
</dl>
}}
<!-- DISCONTINUE Notes -->

Latest revision as of 10:27, 25 June 2024

Hover & click on the images for description

Description

Description:
Set scenario attributes. An attribute is identified by its property (data when it is an engine-driven attribute) value in config. For the list of all attributes with their properties, see Mission Attributes.
Attributes are available only within the Eden Editor workspace. You cannot access them in scenario preview or exported scenario!
Groups:
Eden Editor

Syntax

Syntax:
set3DENMissionAttributes [[section1, class1, value1], ...]
Parameters:
sectionN: String - attribute section. See Sections & Properties
classN: String - attribute name
valueN: Anything - new attribute value
Return Value:
Nothing

Examples

Example 1:
// set respawn type to 3 and respawn delay to 10 seconds set3DENMissionAttributes [["Multiplayer", "respawn", 3], ["Multiplayer", "respawnDelay", 10]];

Additional Information

See also:
get3DENMissionAttribute set3DENMissionAttribute

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
R3vo - c
Posted on Jan 02, 2019 - 12:09 (UTC)
Usually, the attributes value can be received by
_sectionName get3DENMissionAttribute _attributeName; // See example above
However, if the attribute was not changed and it is default value is used get3DENMissionAttribute might return Nothing, even though in Eden Editor the attribute has got a value. In that case the attribute's config name is not identical to the 'property' or 'data' config value. To get the right values in these cases one has to do:
_sectionName get3DENMissionAttribute _propertyName; // or _sectionName get3DENMissionAttribute _dataName;