getArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<dl class="command_description"> <dd class="notedate">" to "<dl class="command_description"> <dt></dt> <dd class="notedate">")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= arma1
|version1= 1.00
 
|game2= arma2
|version2= 1.00
 
|game3= arma2oa
|version3= 1.50
 
|game4= tkoh
|version4= 1.00
 
|game5= arma3
|version5= 0.50


|gr1= Config
|gr1= Config


|1.00
|descr= Extract array from config entry.


| Extract array from config entry.
|s1= [[getArray]] config
 
| '''getArray''' config


|p1= config: [[Config]]
|p1= config: [[Config]]


| [[Array]]
|r1= [[Array]]
   
   
|x1= <pre>_array = getArray (configFile >> "CfgVehicles" >> "Thing" >> "threat")</pre>
|x1= <code>_array = [[getArray]] ([[configFile]] >> "CfgVehicles" >> "Thing" >> "threat");</code>


|seealso= [[configFile]], [[config / name]], [[configName]], [[count]], [[getText]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]]
|seealso= [[configFile]], [[config / name]], [[configName]], [[count]], [[getText]], [[getNumber]], [[inheritsFrom]], [[isArray]], [[isClass]], [[isNumber]], [[isText]], [[select]]
Line 23: Line 34:
<dt></dt>
<dt></dt>
<dd class="notedate">Posted on Mar 28, 2014 - 07:52</dd>
<dd class="notedate">Posted on Mar 28, 2014 - 07:52</dd>
<dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]<dd class="note">
<dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]</dt>
<dd class="note">
({{arma3}} 1.14) It's recommended to use [[BIS_fnc_getCfgData]] or [[BIS_fnc_returnConfigEntry]] to get variable cfg data rather than conditioning via [[isNumber]], [[isText]], [[isArray]], [[getNumber]], [[getText]] and [[getArray]] combination.<br>
({{arma3}} 1.14) It's recommended to use [[BIS_fnc_getCfgData]] or [[BIS_fnc_returnConfigEntry]] to get variable cfg data rather than conditioning via [[isNumber]], [[isText]], [[isArray]], [[getNumber]], [[getText]] and [[getArray]] combination.<br>
Traditional workaround:
Traditional workaround:
Line 39: Line 51:
</code>
</code>
To return default value once entry was not found, we can use [[BIS_fnc_returnConfigEntry]] instead of [[BIS_fnc_getCfgData]].
To return default value once entry was not found, we can use [[BIS_fnc_returnConfigEntry]] instead of [[BIS_fnc_getCfgData]].
<code>[([[configFile]] >> "CannonFire" >> "LightExp"),"lifeTime",0] [[call]] [[BIS_fnc_returnConfigEntry]];//0.5
<code>[([[configFile]] >> "CannonFire" >> "LightExp"),"lifeTime",0] [[call]] [[BIS_fnc_returnConfigEntry]]; {{cc|0.5}}</code>
</code>
</dd>
</dl>


{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
<dl class="command_description">
<dt></dt>
<dt></dt>
<dd class="notedate">Posted on January 12, 2018 - 19:48 (UTC)</dd>
<dd class="notedate">Posted on January 12, 2018 - 19:48 (UTC)</dd>
Line 57: Line 60:
There is special behaviour if you try to read a description.ext config entry [[Array]] that contains a [[Boolean]].<br>
There is special behaviour if you try to read a description.ext config entry [[Array]] that contains a [[Boolean]].<br>
Getting array in '''MP''' will result in [[Number]], while '''SP''' will return [[String]].
Getting array in '''MP''' will result in [[Number]], while '''SP''' will return [[String]].
<code>// SP with false in array
<code>{{cc|SP with false in array}}
[[getArray]] ([[missionConfigFile]] >> "someClass" >> "someArray") // -> "false"
[[getArray]] ([[missionConfigFile]] >> "someClass" >> "someArray") // -> "false"


// MP with false in array
{{cc|MP with false in array}}
[[getArray]] ([[missionConfigFile]] >> "someClass" >> "someArray") // -> 0</code>
[[getArray]] ([[missionConfigFile]] >> "someClass" >> "someArray") // -> 0</code>
</dd>
</dd>
</dl>
</dl>

Revision as of 15:59, 9 June 2021

Logo 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:
Extract array from config entry.
Groups:
Config

Syntax

Syntax:
getArray config
Parameters:
config: Config
Return Value:
Array

Examples

Example 1:
_array = getArray (configFile >> "CfgVehicles" >> "Thing" >> "threat");

Additional Information

See also:
configFileconfig / nameconfigNamecountgetTextgetNumberinheritsFromisArrayisClassisNumberisTextselect

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
Posted on Mar 28, 2014 - 07:52
ffur2007slx2_5
(Arma 3 1.14) It's recommended to use BIS_fnc_getCfgData or BIS_fnc_returnConfigEntry to get variable cfg data rather than conditioning via isNumber, isText, isArray, getNumber, getText and getArray combination.
Traditional workaround: _cfg = configFile >> "CfgVehicles" >> _SomeAddonClassName >> "DestructionEffects" >> "Smoke1" >> "type" switch ( true ) do { case (isNumber _cfg): {getNumber _cfg}; case (isText _cfg): {getText _cfg}; case (isArray _cfg): {getArray _cfg;}; default { nil }; }; Recommended workaround: (configFile >> "CfgVehicles" >> _SomeAddonClassName >> "DestructionEffects" >> "Smoke1" >> "type") call BIS_fnc_getCfgData; To return default value once entry was not found, we can use BIS_fnc_returnConfigEntry instead of BIS_fnc_getCfgData. [(configFile >> "CannonFire" >> "LightExp"),"lifeTime",0] call BIS_fnc_returnConfigEntry; // 0.5
Posted on January 12, 2018 - 19:48 (UTC)
demellion
There is special behaviour if you try to read a description.ext config entry Array that contains a Boolean.
Getting array in MP will result in Number, while SP will return String. // SP with false in array getArray (missionConfigFile >> "someClass" >> "someArray") // -> "false" // MP with false in array getArray (missionConfigFile >> "someClass" >> "someArray") // -> 0
Retrieved from "https://community.bistudio.com/wiki?title=getArray&oldid=260176"