configClasses: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (example corrected) |
Lou Montana (talk | contribs) m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>") |
||
(82 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| arma3 |= | |game1= arma3 | ||
|version1= 1.24 | |||
| | |gr1= Config | ||
|descr= Returns an array of config entries which meet criteria in condition code. Command iterates through all available config sub classes of the given config class. Current looked at config is stored in _x variable (similar to alternative [[count]] command implementation). Condition has to return [[true]] in order for the looked at config to be added to the resulting array. Slightly faster than [[configProperties]], but doesn't account for config properties or inherited entries. | |||
{{Feature|important| | |||
* The condition code passed to [[configClasses]] should only be used for '''simple filter expressions''' and nothing more | |||
* Do not use {{hl|"[[isClass]] [[Magic Variables#x|_x]]"}} in the condition. The engine does this check already<br><br> | |||
* {{arma3}} v2.02 brought specific engine optimisations for the following conditions: | |||
** {{hl|"[[true]]"}} | |||
** {{hl|"[[getNumber]] ([[Magic Variables#x|_x]] >> 'scope') > 0"}}}} | |||
| | |s1= condition [[configClasses]] config | ||
| condition | |p1= condition: [[String]] | ||
|p2= config: [[Config]] | |||
|p2= config: [[Config]] | |||
| [[Array]] - | |r1= [[Array]] - array of [[Config]]s | ||
| | |x1= collect all CfgVehicles configs: | ||
<sqf>_configs = "true" configClasses (configFile >> "CfgVehicles");</sqf> | |||
| | |x2= Return all classes that can transport 10 and more soldiers: | ||
<sqf>_transporters = "getNumber (_x >> 'transportSoldier') >= 10" configClasses (configFile >> "CfgVehicles");</sqf> | |||
| | |x3= Return all classes that inherit from 'RscText': | ||
<sqf>hint str ("inheritsFrom _x == (configFile >> 'RscText')" configClasses configFile);</sqf> | |||
|seealso= [[Config]] [[configFile]] [[missionConfigFile]] [[configProperties]] [[configHierarchy]] | |||
}} | }} | ||
{{Note | |||
|user= Iceman77 | |||
|timestamp= 20141019122400 | |||
|text= A fantastic way to filter stuff. eg: | |||
<sqf> | |||
// create an array of west vehicles and spawn then in front of the player in rows of 5 | |||
< | |||
private ["_cfgArray", "_xPos", "_yPos", "_veh"]; | |||
// | |||
_cfgArray = "( | _cfgArray = "( | ||
(getNumber (_x >> 'scope') >= 2) && | |||
{ | |||
getNumber (_x >> 'side') == 1 && | |||
{ getText (_x >> 'vehicleClass') in ['Armored', 'Car', 'Air'] } | |||
} | |||
)" configClasses (configFile >> "CfgVehicles"); | )" configClasses (configFile >> "CfgVehicles"); | ||
Line 77: | Line 55: | ||
{ | { | ||
_yPos = _yPos + 20; | |||
_veh = createVehicle [(configName _x), player modelToWorld [_xPos, _yPos, 0], [], 0, "NONE"]; | |||
if (_yPos >= 100) then | |||
{ | |||
_yPos = 0; | |||
_xPos = _xPos + 20; | |||
}; | |||
} forEach _cfgArray; | } forEach _cfgArray; | ||
</sqf> | |||
</ | }} | ||
< | {{Note | ||
|user= Benargee | |||
|timestamp= 20160528202800 | |||
|text= [[configClasses]] does not account for inherited subclasses, use [[configProperties]] with [[isClass]] filter instead | |||
<sqf>configProperties [_config, "isClass _x", true];</sqf> | |||
}} | |||
< | {{Note | ||
|user= Nelis75733126 | |||
|timestamp= 20170528091800 | |||
|text= this will get a list of ALL locations on the currently loaded world | |||
<sqf> | |||
( "true" configClasses (configFile >> "CfgWorlds" >> worldName >> "names" ) ) apply { | |||
// change each config entry into a location | |||
nearestLocation [ | |||
getArray ( _x >> "position" ), | |||
getText ( _x >> "type" ) | |||
] | |||
}; | |||
</sqf> | |||
}} |
Latest revision as of 19:43, 3 September 2024
Description
- Description:
- Returns an array of config entries which meet criteria in condition code. Command iterates through all available config sub classes of the given config class. Current looked at config is stored in _x variable (similar to alternative count command implementation). Condition has to return true in order for the looked at config to be added to the resulting array. Slightly faster than configProperties, but doesn't account for config properties or inherited entries.
- Groups:
- Config
Syntax
- Syntax:
- condition configClasses config
- Parameters:
- condition: String
- config: Config
- Return Value:
- Array - array of Configs
Examples
- Example 1:
- collect all CfgVehicles configs:
- Example 2:
- Return all classes that can transport 10 and more soldiers:
_transporters = "getNumber (_x >> 'transportSoldier') >= 10" configClasses (configFile >> "CfgVehicles");
- Example 3:
- Return all classes that inherit from 'RscText':
Additional Information
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 Oct 19, 2014 - 12:24 (UTC)
-
A fantastic way to filter stuff. eg:
// create an array of west vehicles and spawn then in front of the player in rows of 5 private ["_cfgArray", "_xPos", "_yPos", "_veh"]; _cfgArray = "( (getNumber (_x >> 'scope') >= 2) && { getNumber (_x >> 'side') == 1 && { getText (_x >> 'vehicleClass') in ['Armored', 'Car', 'Air'] } } )" configClasses (configFile >> "CfgVehicles"); _xPos = 0; _yPos = 0; { _yPos = _yPos + 20; _veh = createVehicle [(configName _x), player modelToWorld [_xPos, _yPos, 0], [], 0, "NONE"]; if (_yPos >= 100) then { _yPos = 0; _xPos = _xPos + 20; }; } forEach _cfgArray;
- Posted on May 28, 2016 - 20:28 (UTC)
-
configClasses does not account for inherited subclasses, use configProperties with isClass filter instead
- Posted on May 28, 2017 - 09:18 (UTC)
- this will get a list of ALL locations on the currently loaded world