BIS_fnc_locations

1.00

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:

Creates or registers location logics (used in various modules, like Ambient Civilians, Ambient Civilian Vehicles or Warfare 2). Upon registering, function will set following variables into location logic's variable space:

"class" - unique class of location (either BIS_loc_<configname> or BIS_loc_custom_<ID>)
"name" - name of location from config or setName command. If none is defined, class is used
"type" - config type
"neighbors" - config defined neighbor locations

If you are registering currently existing object and some of variables above is already stored in it, it will not be replaced.

Execution:

call

Groups:

Systems

Syntax

Syntax:: [types, area, debug] call BIS_fnc_locations
Parameters:: types: String or Array of Strings
: area: Array in format [center, distance]
: debug: Boolean (Optional)
Return Value:: Array - list of registered locations

Alternative Syntax

Syntax:: [objects] call BIS_fnc_locations
Parameters:: objects: Array of Objects or Locations - list of specific locations to be registered
Return Value:: Array - list of registered locations

Examples

Example 1:: Copy
["CityCenter", [getPosATL player, 1000]] call BIS_fnc_locations;
Example 2:: Copy
[["acityc_dolina"]] call BIS_fnc_locations;
Example 3:: Copy
[[myLocation1, myLocation2], [], true] call BIS_fnc_locations;

Additional Information

See also:: Functions Library

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

Str - c: Posted on May 31, 2009 - 15:15 (UTC)
: You can also use c"" call BIS_fnc_locations for quick debug of all locations on landscape