Location: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(related commands)
m (Text replacement - "[[Image:" to "[[File:")
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
A location is like an extended type of marker (introduced in ArmA 1.08).
{{TOC|side}}
A location is an extended type of marker. For example city names displayed on the map are locations; their information can be accessed and modified with [[:Category:Command Group: Locations|Location commands]].


*Locations have a name, a side, a [[Position3D|3D position]], a 2D area, and an orientation.
[[Location]] notion was introduced in {{GVI|arma1|1.08}}.
*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 [http://feedback.arma3.com/view.php?id=10875]
*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.
*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.


==Location Types==


===Armed Assault===
== Specifics ==
[[Image:LocationTypes.JPG|right|thumb|Location Types (ArmA)]]
 
Possible location types are:
Locations:
*Mount
* are defined in {{hl|bin\Config.bin\CfgLocationTypes}} / <sqf inline>configFile >> "CfgLocationTypes"</sqf>
*Name
* have a name, a side, a [[Position#Position3D|3D position]], a 2D area, and an [[direction|orientation]]
*NameMarine
* have a non-scaling map representation (icon and/or text, depending on their class)
*NameCityCapital
* can be attached to objects, with all of the location's relevant properties inherited from the object
*NameCity
* are [[Multiplayer Scripting#Locality|local]], their properties are not synchronised over the network
*NameVillage
 
*NameLocal
Terrain built-in locations:
*Hill
* provide a way to find nearby high points, towns, etc.
*ViewPoint
* are defined in an island's {{hl|.pew}} file. When the island is exported to {{hl|.wrp}} its {{hl|.hpp}} file is also produced, containing the location names used in the {{hl|.pew}} file. This {{hl|.hpp}} file 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 {{hl|.pew}} file are included in the island during packing.
*RockArea
*BorderCrossing
*VegetationBroadleaf
*VegetationFir
*VegetationPalm
*VegetationVineyard




[[Image:Arma2_CfgLocationTypes.jpg|right|thumb|Location icons and fonts (Arma 2)]]
{| class="wikitable" style="text-align: center"
! Modification
! Terrain Location
! Scripted Terrain Location<br><small>using {{Link|createLocation#Syntax 2}}</small>
! Scripted Location
|-
| style="text-align: left" | [[Side]]
| {{Icon|checked}}
| {{Icon|checked}}
| {{Icon|checked}}
|-
| style="text-align: left" | [[setSize|Size]]
| {{Icon|unchecked}}
| {{Icon|checked}}
| {{Icon|checked}}
|-
| style="text-align: left" | [[direction|Direction]]
| {{Icon|unchecked}}
| {{Icon|checked}}
| {{Icon|checked}}
|-
| style="text-align: left" | [[setVariable]]/[[getVariable]]
| {{Icon|unchecked}}
| {{Icon|checked}}
| {{Icon|checked}}
|-
| style="text-align: left" | [[Position#Position3D|3D Position]]
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|checked}}
|-
| style="text-align: left" | [[attachTo|Attach to]] an object
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|checked}}
|-
| style="text-align: left" | [[deleteLocation|Deletion]]
| {{Icon|unchecked}}
| {{Icon|unchecked}}
| {{Icon|checked}}
|}


===Arma 2===


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


===Arma 3===
[[File:LocationTypes.JPG|right|thumb|Arma Location icons and fonts]]
=== Armed Assault ===
Possible location types are:
* Mount
* Name
* NameMarine
* NameCityCapital
* NameCity
* NameVillage
* NameLocal
* Hill
* ViewPoint
* RockArea
* BorderCrossing
* VegetationBroadleaf
* VegetationFir
* VegetationPalm
* VegetationVineyard


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


==Location Related Scripting Commands==
{{Clear}}
[[File:CfgLocationTypes Arma3.png|right|thumb|Arma 3 Location icons and fonts]]
=== Arma 3 ===
* Airport (on Tanoa only. Tanoan airports have their own location type. On Altis and Stratis, airports are '''NameLocal''')
* Area
* BorderCrossing
* CityCenter
* CivilDefense
* CulturalProperty
* DangerousForces
* Flag
* FlatArea
* FlatAreaCity
* FlatAreaCitySmall
* Hill
* HistoricalSite
* Invisible
* Mount
* Name
* NameCity
* NameCityCapital
* NameLocal (will return names like Airport)
* NameMarine
* NameVillage
* RockArea
* SafetyZone
* Strategic
* StrongpointArea
* VegetationBroadleaf
* VegetationFir
* VegetationPalm
* VegetationVineyard
* ViewPoint
* b_air
* b_antiair
* b_armor
* b_art
* b_hq
* b_inf
* b_installation
* b_maint
* b_mech_inf
* b_med
* b_mortar
* b_motor_inf
* b_naval
* b_plane
* b_recon
* b_service
* b_support
* b_uav
* b_unknown
* c_air
* c_car
* c_plane
* c_ship
* c_unknown
* fakeTown
* group_0
* group_1
* group_10
* group_11
* group_2
* group_3
* group_4
* group_5
* group_6
* group_7
* group_8
* group_9
* n_air
* n_antiair
* n_armor
* n_art
* n_hq
* n_inf
* n_installation
* n_maint
* n_mech_inf
* n_med
* n_mortar
* n_motor_inf
* n_naval
* n_plane
* n_recon
* n_service
* n_support
* n_uav
* n_unknown
* o_air
* o_antiair
* o_armor
* o_art
* o_hq
* o_inf
* o_installation
* o_maint
* o_mech_inf
* o_med
* o_mortar
* o_motor_inf
* o_naval
* o_plane
* o_recon
* o_service
* o_support
* o_uav
* o_unknown
* respawn_air
* respawn_armor
* respawn_inf
* respawn_motor
* respawn_naval
* respawn_para
* respawn_plane
* respawn_unknown
* u_installation


[[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]]
[[Category: Introduced with Armed Assault version 1.08]]

Latest revision as of 00:10, 21 November 2023

A location is an extended type of marker. For example city names displayed on the map are locations; their information can be accessed and modified with Location commands.

Location notion was introduced in Logo A1 black.png1.08.


Specifics

Locations:

  • are defined in bin\Config.bin\CfgLocationTypes / configFile >> "CfgLocationTypes"
  • have a name, a side, a 3D position, a 2D area, and an orientation
  • have a non-scaling map representation (icon and/or text, depending on their class)
  • can be attached to objects, with all of the location's relevant properties inherited from the object
  • are local, their properties are not synchronised over the network

Terrain built-in locations:

  • provide a way to find nearby high points, towns, etc.
  • are defined in an island's .pew file. When the island is exported to .wrp its .hpp file is also produced, containing the location names used in the .pew file. This .hpp file 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 in the island during packing.


Modification Terrain Location Scripted Terrain Location
using createLocation - Syntax 2 		Scripted Location
Side Checked Checked Checked
Size Unchecked Checked Checked
Direction Unchecked Checked Checked
setVariable/getVariable Unchecked Checked Checked
3D Position Unchecked Unchecked Checked
Attach to an object Unchecked Unchecked Checked
Deletion Unchecked Unchecked Checked


Location Types

Arma Location icons and fonts

Armed Assault

Possible location types are:

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

Arma 2

Arma 2 Location icons and fonts
  • Name
  • Strategic
  • StrongpointArea
  • FlatArea
  • FlatAreaCity
  • FlatAreaCitySmall
  • CityCenter
  • Airport
  • NameMarine
  • NameCityCapital
  • NameCity
  • NameVillage
  • NameLocal
  • Hill
  • ViewPoint
  • RockArea
  • BorderCrossing
  • VegetationBroadleaf
  • VegetationFir
  • VegetationPalm
  • VegetationVineyard
Arma 3 Location icons and fonts

Arma 3

  • Airport (on Tanoa only. Tanoan airports have their own location type. On Altis and Stratis, airports are NameLocal)
  • Area
  • BorderCrossing
  • CityCenter
  • CivilDefense
  • CulturalProperty
  • DangerousForces
  • Flag
  • FlatArea
  • FlatAreaCity
  • FlatAreaCitySmall
  • Hill
  • HistoricalSite
  • Invisible
  • Mount
  • Name
  • NameCity
  • NameCityCapital
  • NameLocal (will return names like Airport)
  • NameMarine
  • NameVillage
  • RockArea
  • SafetyZone
  • Strategic
  • StrongpointArea
  • VegetationBroadleaf
  • VegetationFir
  • VegetationPalm
  • VegetationVineyard
  • ViewPoint
  • b_air
  • b_antiair
  • b_armor
  • b_art
  • b_hq
  • b_inf
  • b_installation
  • b_maint
  • b_mech_inf
  • b_med
  • b_mortar
  • b_motor_inf
  • b_naval
  • b_plane
  • b_recon
  • b_service
  • b_support
  • b_uav
  • b_unknown
  • c_air
  • c_car
  • c_plane
  • c_ship
  • c_unknown
  • fakeTown
  • group_0
  • group_1
  • group_10
  • group_11
  • group_2
  • group_3
  • group_4
  • group_5
  • group_6
  • group_7
  • group_8
  • group_9
  • n_air
  • n_antiair
  • n_armor
  • n_art
  • n_hq
  • n_inf
  • n_installation
  • n_maint
  • n_mech_inf
  • n_med
  • n_mortar
  • n_motor_inf
  • n_naval
  • n_plane
  • n_recon
  • n_service
  • n_support
  • n_uav
  • n_unknown
  • o_air
  • o_antiair
  • o_armor
  • o_art
  • o_hq
  • o_inf
  • o_installation
  • o_maint
  • o_mech_inf
  • o_med
  • o_mortar
  • o_motor_inf
  • o_naval
  • o_plane
  • o_recon
  • o_service
  • o_support
  • o_uav
  • o_unknown
  • respawn_air
  • respawn_armor
  • respawn_inf
  • respawn_motor
  • respawn_naval
  • respawn_para
  • respawn_plane
  • respawn_unknown
  • u_installation
Retrieved from "https://community.bistudio.com/wiki?title=Location&oldid=349799"