BIS fnc locations: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \|r2=(.*)\|RETURNVALUE=" to " |r2=$1|RETURNVALUE2=")
mNo edit summary
Line 19: Line 19:
*"neighbors" - config defined neighbor locations
*"neighbors" - config defined neighbor locations


If you're registering currently existing object and some of variables above is already stored in it, it '''won't''' be replaced.
If you're registering currently existing object and some of variables above is already stored in it, it '''won't''' be replaced.|DESCRIPTION=
|=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [type(s),area,''debug''] call '''BIS_fnc_locations'''  |=
| [type(s),area,''debug''] call '''BIS_fnc_locations'''  |SYNTAX=


|p1= type(s): [[String]] or [[Array]] of strings |PARAMETER1=  
|p1= type(s): [[String]] or [[Array]] of strings |PARAMETER1=  
Line 34: Line 33:




|s2= [objects] call '''BIS_fnc_locations'''|Alternative Syntax=
|s2= [objects] call '''BIS_fnc_locations'''|SYNTAX2=


|p21= objects: Array of [[Object]]s or [[Location]]s - list of specific locations to be registered |PARAMETER21=
|p21= objects: Array of [[Object]]s or [[Location]]s - list of specific locations to be registered |PARAMETER21=

Revision as of 08:34, 25 September 2020

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're registering currently existing object and some of variables above is already stored in it, it won't be replaced.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[type(s),area,debug] call BIS_fnc_locations
Parameters:
type(s): String or Array of strings
area: Array in format [center,distance]
debug: (Optional): Boolean
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:
["CityCenter",[position player,1000]] call bis_fnc_locations;
Example 2:
[["acityc_dolina"]] call bis_fnc_locations;
Example 3:
[[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

Notes

Posted on May 31, 2009 - 15:15
Str
You can also use "" call bis_fnc_locations for quick debug of all locations on landscape

Bottom Section