BIS fnc locations: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma2 | | arma2 | ||
|1.00 | |1.00 | ||
|gr1 = Systems | |gr1 = Systems | ||
|arg= |MPARGUMENTS= | |arg= |MPARGUMENTS= | ||
| 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. | ||
| [type(s),area,''debug''] call '''BIS_fnc_locations''' | | [type(s),area,''debug''] call '''BIS_fnc_locations''' | ||
|p1= type(s): [[String]] or [[Array]] of strings | |p1= type(s): [[String]] or [[Array]] of strings | ||
|p2= area: [[Array]] in format [center,distance] | |p2= area: [[Array]] in format [center,distance] | ||
|p3= debug: ''(Optional)'': [[Boolean]] | |p3= debug: ''(Optional)'': [[Boolean]] | ||
| [[Array]] - List of registered locations<br><br> | | [[Array]] - List of registered locations<br><br> | ||
|s2= [objects] call '''BIS_fnc_locations''' | |s2= [objects] call '''BIS_fnc_locations''' | ||
|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= | ||
|r2= [[Array]] - List of registered locations<br><br> | |r2= [[Array]] - List of registered locations<br><br> | ||
|x1= <code>["CityCenter",<nowiki>[</nowiki>[[position]] [[player]],1000]] call bis_fnc_locations;</code> | |x1= <code>["CityCenter",<nowiki>[</nowiki>[[position]] [[player]],1000]] call bis_fnc_locations;</code> | ||
|x2= <code><nowiki>[[</nowiki>"acityc_dolina"<nowiki>]]</nowiki> call bis_fnc_locations;</code> | |x2= <code><nowiki>[[</nowiki>"acityc_dolina"<nowiki>]]</nowiki> call bis_fnc_locations;</code> | ||
|x3= <code><nowiki>[[</nowiki>myLocation1,myLocation2],[],true] call bis_fnc_locations;</code> | |x3= <code><nowiki>[[</nowiki>myLocation1,myLocation2],[],true] call bis_fnc_locations;</code> | ||
| [[Functions Library]] | | [[Functions Library]] | ||
| |MPBEHAVIOUR= | | |MPBEHAVIOUR= | ||
Revision as of 00:08, 18 January 2021
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
- Execution:
- call
- Groups:
- Systems
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