BIS fnc getCfgDataPool: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " {{Function|Comments=" to "{{Function|Comments=")
m (Text replacement - "<code>(\[[a-zA-Z0-9_, ]*\] )?(call|spawn) \[\[(BI[NS]\_fnc\_[a-zA-Z0-9_]+)\]\];?<\/code>" to "<sqf>$1$2 $3;</sqf>")
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Configs
____________________________________________________________________________________________


| <pre>/*
|descr= <pre>/*


Description:
Description:
Line 32: Line 31:
};
};
};
};


Remark(s):
Remark(s):
Line 56: Line 54:
Returns:
Returns:
ARRAY or nil, if parent class is not found
ARRAY or nil, if parent class is not found
*/
*/</pre>
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |DESCRIPTION=
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_getCfgDataPool]]; --> |SYNTAX=


|p1= |PARAMETER1=
{{Wiki|placeholder}}


| |RETURNVALUE=
|s1= <!-- [] call [[BIS_fnc_getCfgDataPool]] -->
____________________________________________________________________________________________


|x1= <code></code> |EXAMPLE1=
|r1=
____________________________________________________________________________________________


| |SEEALSO=
|x1= <!-- <sqf>[] call BIS_fnc_getCfgDataPool;</sqf> -->


|seealso=
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Configs|{{uc:getCfgDataPool}}]]
[[Category:Functions|{{uc:getCfgDataPool}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getCfgDataPool}}]]

Latest revision as of 13:09, 5 May 2022

Hover & click on the images for description

Description

Description:
/*

	Description:
	* Get array of attribute values out of the parent config class.
	* Attributes need to be in this format: "_n", where n is an index number (starting from 0).
	* If any discrepancy in indexing is detected, loading will stop and only the correctly indexed values will be returned.
	* Max. index supported is 99.
	* If more then 9 attributes used, 0-9 need to use leading zeroes.

	CFG example:

	class Timeline
	{
		class StageA
		{
			_0[] = {2035,7,7,04,30};
			_1[] = {2035,7,7,06,15};
			_2[] = {2035,7,7,18,35};
			_3[] = {2035,7,8,09,05};
			_4[] = {2035,7,8,13,25};
			_5[] = {2035,7,8,17,10};
			_6[] = {2035,7,8,21,40};
			_7[] = {2035,7,9,19,55};
		};
	};

	Remark(s):
	* Can by called 2 ways:
		* 1st way (general) works for any config.
		* 2nd way is for comfortable working with mission description.ext.

	Parameter(s):
		_this: CFG
		_this: ARRAY of STRINGS - missionConfigFile classes.

	Example:

	* 1st way of calling:

		_array = (configfile >> "BulletBubbles" >> "BulletBubbles1") call BIS_fnc_getCfgData;
		_array = (missionconfigfile >> "Timeline" >> "StageA") call BIS_fnc_getCfgData;

	* 2nd way of calling:

		_array = ["Timeline","StageA"] call BIS_fnc_getCfgData;

	Returns:
		ARRAY or nil, if parent class is not found
*/
🏗
Placeholder description extracted from the function header by BIS_fnc_exportFunctionsToWiki.
Execution:
call
Groups:
Configs

Syntax

Syntax:
Syntax needed
Return Value:
Return value needed

Examples

Examples:
Example needed

Additional Information

See also:
See also needed

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