Location: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
Line 1: Line 1:
A location is like an extended type of marker (introduced in ArmA 1.08).
A location is like an extended type of marker (introduced in ArmA 1.08).


*Locations have a name, a side, a [[Position3D|3D position]], a 2D area, and an orientation.  
* Locations have a name, a side, a [[Position3D|3D position]], a 2D area, and an orientation.  
*They have a non-scaling map representation (icon and/or text, depending on class).
* They have a non-scaling map representation (icon and/or text, depending on class).
*They require a class definition to define basic properties that can be changed using script commands. Classes are defined in bin\Config.bin\CfgLocationTypes
* They require a class definition to define basic properties that can be changed using script commands. Classes are defined in bin\Config.bin\CfgLocationTypes
*They can be attached to objects, with all of the location's relevant properties inherited from the object
* They can be attached to objects, with all of the location's relevant properties inherited from the object
*They can use [[setVariable]] and [[getVariable]], but only works with user made locations [http://feedback.arma3.com/view.php?id=10875]
* They can use [[setVariable]] and [[getVariable]], but only works with user made locations [http://feedback.arma3.com/view.php?id=10875]
*Locations are local in MP, their properties are not synchronized
* Locations are local in MP, their properties are not synchronized
*Existing locations are set in an islands .pew file. When the island is exported to .wrp the islandname.hpp is also produced - this contains the location names used in the .pew file.  This .hpp is then incorporated into the config for the island using an [[PreProcessor_Commands#.23include|#include]] statement.<br>This section included in the island config ensures any locations set in the .pew file are included the island during packing.
* Existing locations are set in an islands .pew file. When the island is exported to .wrp the islandname.hpp is also produced - this contains the location names used in the .pew file.  This .hpp is then incorporated into the config for the island using an [[PreProcessor_Commands#.23include|#include]] statement.<br>This section included in the island config ensures any locations set in the .pew file are included the island during packing.
*A terrain's config can not be changed using the location script commands, but they can be found and read. This provides a single command method of finding nearby high points, towns, etc.
* A terrain config can not be changed using the location script commands, but they can be found and read. This provides a single command method of finding nearby high points, towns, etc.
 
 
== Location Types ==


==Location Types==


===Armed Assault===
[[Image:LocationTypes.JPG|right|thumb|Location Types (ArmA)]]
[[Image:LocationTypes.JPG|right|thumb|Location Types (ArmA)]]
=== Armed Assault ===
Possible location types are:
Possible location types are:
*Mount
* Mount
*Name
* Name
*NameMarine
* NameMarine
*NameCityCapital
* NameCityCapital
*NameCity
* NameCity
*NameVillage
* NameVillage
*NameLocal
* NameLocal
*Hill
* Hill
*ViewPoint
* ViewPoint
*RockArea
* RockArea
*BorderCrossing
* BorderCrossing
*VegetationBroadleaf
* VegetationBroadleaf
*VegetationFir
* VegetationFir
*VegetationPalm
* VegetationPalm
*VegetationVineyard
* VegetationVineyard




[[Image:Arma2_CfgLocationTypes.jpg|right|thumb|Location icons and fonts (Arma 2)]]
[[Image:Arma2_CfgLocationTypes.jpg|right|thumb|Location icons and fonts (Arma 2)]]
=== Arma 2 ===
* Name
* Strategic
* StrongpointArea
* FlatArea
* FlatAreaCity
* FlatAreaCitySmall
* CityCenter
* Airport
* NameMarine
* NameCityCapital
* NameCity
* NameVillage
* NameLocal
* Hill
* ViewPoint
* RockArea
* BorderCrossing
* VegetationBroadleaf
* VegetationFir
* VegetationPalm
* VegetationVineyard


===Arma 2===


*Name
=== Arma 3 ===
*Strategic
*StrongpointArea
*FlatArea
*FlatAreaCity
*FlatAreaCitySmall
*CityCenter
*Airport
*NameMarine
*NameCityCapital
*NameCity
*NameVillage
*NameLocal
*Hill
*ViewPoint
*RockArea
*BorderCrossing
*VegetationBroadleaf
*VegetationFir
*VegetationPalm
*VegetationVineyard


===Arma 3===
* NameCity
* NameCityCapital
* NameMarine
* NameVillage
* NameLocal (Will return names like Airport)
* Hill
* Mount
* Airport (On Tanoa only. Tanoan airports have their own location type. On Altis and Stratis, airports are '''NameLocal''')


*NameCity
== Location Related Scripting Commands ==
*NameCityCapital
*NameMarine
*NameVillage
*NameLocal (Will return names like Airport)
*Hill
*Mount
*Airport (On Tanoa only. Tanoan airports have their own location type. On Altis and Stratis, airports are NameLocal)


==Location Related Scripting Commands==
See [[:Category:Command_Group:_Locations]]


[[createLocation]], [[deleteLocation]], [[nearestLocations]], [[nearestLocation]], [[position]], [[getPos]], [[locationPosition]], [[direction]], [[size]], [[type]], [[importance]], [[name]], [[className]], [[text]], [[rectangular]], [[attachedObject]], [[side]], [[isNull]], [[locationNull]], [[nearestLocationWithDubbing]], [[in]], [[drawLocation]], [[setPosition]], [[setDirection]], [[setSize]], [[setType]], [[setImportance]], [[setName]], [[setText]], [[setRectangular]], [[attachObject]], [[setSide]], [[setVariable]], [[getVariable]], [[distance]], [[distanceSqr]]
[[createLocation]], [[deleteLocation]], [[nearestLocations]], [[nearestLocation]], [[position]], [[getPos]], [[locationPosition]], [[direction]], [[size]], [[type]], [[importance]], [[name]], [[className]], [[text]], [[rectangular]], [[attachedObject]], [[side]], [[isNull]], [[locationNull]], [[nearestLocationWithDubbing]], [[in]], [[drawLocation]], [[setPosition]], [[setDirection]], [[setSize]], [[setType]], [[setImportance]], [[setName]], [[setText]], [[setRectangular]], [[attachObject]], [[setSide]], [[setVariable]], [[getVariable]], [[distance]], [[distanceSqr]]


[[Category: Data Types]]
[[Category: Data Types]]

Revision as of 22:10, 11 May 2018

A location is like an extended type of marker (introduced in ArmA 1.08).

  • Locations have a name, a side, a 3D position, a 2D area, and an orientation.
  • They have a non-scaling map representation (icon and/or text, depending on class).
  • They require a class definition to define basic properties that can be changed using script commands. Classes are defined in bin\Config.bin\CfgLocationTypes
  • They can be attached to objects, with all of the location's relevant properties inherited from the object
  • They can use setVariable and getVariable, but only works with user made locations [1]
  • Locations are local in MP, their properties are not synchronized
  • Existing locations are set in an islands .pew file. When the island is exported to .wrp the islandname.hpp is also produced - this contains the location names used in the .pew file. This .hpp is then incorporated into the config for the island using an #include statement.
    This section included in the island config ensures any locations set in the .pew file are included the island during packing.
  • A terrain config can not be changed using the location script commands, but they can be found and read. This provides a single command method of finding nearby high points, towns, etc.


Location Types

Location Types (ArmA)

Armed Assault

Possible location types are:

  • Mount
  • Name
  • NameMarine
  • NameCityCapital
  • NameCity
  • NameVillage
  • NameLocal
  • Hill
  • ViewPoint
  • RockArea
  • BorderCrossing
  • VegetationBroadleaf
  • VegetationFir
  • VegetationPalm
  • VegetationVineyard


Location icons and fonts (Arma 2)

Arma 2

  • Name
  • Strategic
  • StrongpointArea
  • FlatArea
  • FlatAreaCity
  • FlatAreaCitySmall
  • CityCenter
  • Airport
  • NameMarine
  • NameCityCapital
  • NameCity
  • NameVillage
  • NameLocal
  • Hill
  • ViewPoint
  • RockArea
  • BorderCrossing
  • VegetationBroadleaf
  • VegetationFir
  • VegetationPalm
  • VegetationVineyard


Arma 3

  • NameCity
  • NameCityCapital
  • NameMarine
  • NameVillage
  • NameLocal (Will return names like Airport)
  • Hill
  • Mount
  • Airport (On Tanoa only. Tanoan airports have their own location type. On Altis and Stratis, airports are NameLocal)

Location Related Scripting Commands

See Category:Command_Group:_Locations

createLocation, deleteLocation, nearestLocations, nearestLocation, position, getPos, locationPosition, direction, size, type, importance, name, className, text, rectangular, attachedObject, side, isNull, locationNull, nearestLocationWithDubbing, in, drawLocation, setPosition, setDirection, setSize, setType, setImportance, setName, setText, setRectangular, attachObject, setSide, setVariable, getVariable, distance, distanceSqr

Retrieved from "https://community.bistudio.com/wiki?title=Location&oldid=107375"