getArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some wiki formatting)
 
(107 intermediate revisions by 15 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


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


|2.35|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Extract array from config entry. |= Description
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| '''getArray''' config |= Syntax
|game4= tkoh
|version4= 1.00


|p1= config [[Config]] |= Parameter 1
|game5= arma3
|version5= 0.50


| [[Array]] |= Return value
|gr1= Config
____________________________________________________________________________________________
 
|x1= <pre>_array = getArray (configFile >> "CfgVehicles" >> "Thing" >> "threat")</pre> |= Example 1
____________________________________________________________________________________________


| |= See also
|descr= Extract array from config entry.


|s1= [[getArray]] config
|p1= config: [[Config]]
|r1= [[Array]]
|x1= <sqf>_array = getArray (configFile >> "CfgVehicles" >> "Thing" >> "threat");</sqf>
|seealso= [[configFile]] [[a / b]] [[configName]] [[count]] [[getText]] [[getNumber]] [[inheritsFrom]] [[isArray]] [[isClass]] [[isNumber]] [[isText]] [[select]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= ffur2007slx2_5
<!-- Note Section BEGIN -->
|timestamp= 20140328075200
|text= ({{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:
<sqf>
_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 };
};
</sqf>
'''Recommended workaround:'''
<sqf>(configFile >> "CfgVehicles" >> _SomeAddonClassName >> "DestructionEffects" >> "Smoke1" >> "type") call BIS_fnc_getCfgData;</sqf>
To return default value once entry was not found, we can use [[BIS_fnc_returnConfigEntry]] instead of [[BIS_fnc_getCfgData]].
<sqf>[(configFile >> "CannonFire" >> "LightExp"),"lifeTime",0] call BIS_fnc_returnConfigEntry; // 0.5</sqf>
}}


<!-- Note Section END -->
{{Note
</dl>
|user= demellion
|timestamp= 20180112194800
|text= 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]].
<sqf>
// SP with false in array
getArray (missionConfigFile >> "someClass" >> "someArray") // -> "false"


<h3 style="display:none">Bottom Section</h3>
// MP with false in array
[[Category:Scripting Commands|GETARRAY]]
getArray (missionConfigFile >> "someClass" >> "someArray") // -> 0
[[Category:Scripting Commands ArmA|GETARRAY]]
</sqf>
}}

Latest revision as of 23:30, 13 May 2023

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:
configFile a / b configName count getText getNumber inheritsFrom isArray isClass isNumber isText select

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
ffur2007slx2_5 - c
Posted on Mar 28, 2014 - 07:52 (UTC)
(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
demellion - c
Posted on Jan 12, 2018 - 19:48 (UTC)
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=341204"