BIS fnc locations: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " +" to " ")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *L([a-z ])" to "$1 - l$2")
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma2
|game1= arma2
|1.00
|version1= 1.00


|game2= arma2oa
|game2= arma2oa
Line 17: Line 17:
|arg=
|arg=


|eff=| Creates or registers location logics (used in various modules, like [[Ambient Civilians]], [[Ambient Civilian Vehicles]] or Warfare 2).
|eff=
 
|descr= 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:
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>)
* "class" - unique class of location (either {{hl|BIS_loc_<configname>}} or {{hl|BIS_loc_custom_<ID>}})
*"name" - name of location from config or [[setName]] command. If none is defined, class is used
* "name" - name of location from config or [[setName]] command. If none is defined, class is used
*"type" - config type
* "type" - config type
*"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 are registering currently existing object and some of variables above is already stored in it, it will '''not''' be replaced.


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


|p1= type(s): [[String]] or [[Array]] of strings
|p1= types: [[String]] or [[Array]] of [[String]]s


|p2= area: [[Array]] in format [center,distance]
|p2= area: [[Array]] in format [center, distance]


|p3= debug: ''(Optional)'': [[Boolean]]
|p3= debug: [[Boolean]] (Optional)


| [[Array]] - List of registered locations<br><br>
|r1= [[Array]] - list of registered locations


|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
|p21= objects: Array of [[Object]]s or [[Location]]s - list of specific locations to be registered


|r2= [[Array]] - List of registered locations<br><br>
|r2= [[Array]] - list of registered locations
 
   
   
|x1= <code>["CityCenter",<nowiki>[</nowiki>[[position]] [[player]],1000]] call bis_fnc_locations;</code>
|x1= <sqf>["CityCenter", [getPosATL player, 1000]] call BIS_fnc_locations;</sqf>


|x2= <code><nowiki>[[</nowiki>"acityc_dolina"<nowiki>]]</nowiki> call bis_fnc_locations;</code>
|x2= <sqf>[["acityc_dolina"]] call BIS_fnc_locations;</sqf>


|x3= <code><nowiki>[[</nowiki>myLocation1,myLocation2],[],true] call bis_fnc_locations;</code>
|x3= <sqf>[[myLocation1, myLocation2], [], true] call BIS_fnc_locations;</sqf>


|seealso= [[Functions Library]]
|seealso= [[Functions Library]]
}}
}}


<dl class="command_description">
{{Note
<dt><dt>
|user= Str
<dd class="notedate">Posted on May 31, 2009 - 15:15</dd>
|timestamp= 20090531151500
<dt class="note">[[User:Str|Str]]</dt><dd class="note">You can also use '''"" call bis_fnc_locations''' for quick debug of all locations on landscape</dd>
|text= You can also use <sqf inline>"" call BIS_fnc_locations</sqf> for quick debug of all locations on landscape
 
}}
</dl>
 
 
[[Category:{{Name|arma2}}: Functions|{{uc:locations}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:locations}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:locations}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:locations}}]]

Latest revision as of 15:38, 8 November 2023

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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:
["CityCenter", [getPosATL 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
Str - c
Posted on May 31, 2009 - 15:15 (UTC)
You can also use "" call BIS_fnc_locations for quick debug of all locations on landscape
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_locations&oldid=348808"