BIS fnc locations: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (template:command argument fix)
Line 6: Line 6:
|1.00|=
|1.00|=


|arg= |= MPARGUMENTS
|arg= |MPARGUMENTS=  


|eff= |= MPEFFECTS
|eff= |MPEFFECTS=  
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 25: Line 25:
| [type(s),area,''debug''] call '''BIS_fnc_locations'''  |=
| [type(s),area,''debug''] call '''BIS_fnc_locations'''  |=


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


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


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


| [[Array]] - List of registered locations<br /><br /> |= RETURNVALUE
| [[Array]] - List of registered locations<br /><br /> |RETURNVALUE=




Line 41: Line 41:


   
   
|x1= <code>["CityCenter",<nowiki>[</nowiki>[[position]] [[player]],1000]] call bis_fnc_locations;</code>|= EXAMPLE1
|x1= <code>["CityCenter",<nowiki>[</nowiki>[[position]] [[player]],1000]] call bis_fnc_locations;</code>|EXAMPLE1=  


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


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


| [[Functions Library]] |= SEEALSO
| [[Functions Library]] |SEEALSO=  


|  |= MPBEHAVIOUR
|  |MPBEHAVIOUR=  
____________________________________________________________________________________________
____________________________________________________________________________________________
}}
}}

Revision as of 11:29, 7 April 2019

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