Locations
31 scripting commands. Also as Markdown for agents.
- attachObjectAttaches a location to the specified object. To detach a location, attach it to objNull.
- classNameReturns short name of location. For config class name, see configName
- createLocationCreates a location of the specified class and dimensions at the specified position. Classes are defined in `CfgLocationTypes`; for possible location…
- deleteLocationDeletes scripted location.
- directionReturns the direction an object or a location is facing (differs from getDir in that this also works with locations).
- drawLocationUsed to draw locations in 2D Editor.
- importanceReturns a location's importance value.
- inChecks whether value is in array, unit is in vehicle, position is inside location or ANSI string is part of other ANSI string. If Unicode support is…
- inAreaChecks whether given position or object is inside given area. Use inAreaArray to check multiple positions/objects within area.
- inAreaArrayReturns given list of Objects and/or Positions that are in the given area, area defined by a trigger, marker, location or array.
- inAreaArrayIndexesReturns indices of positions that are within the provided area.
- locationNullA non-existing Location. To compare non-existent locations use isNull or isEqualTo:
- locationPositionReturns the position of a location. If the location is attached to an object, that object's position is returned.
- nameWhen argument is Object, the command returns the name given to a unit using the setIdentity instruction or selected randomly by the game engine if…
- nearestLocationReturn the closest location of specified class to a given position. Checked range is unlimited (i.e. covers the whole map).
- nearestLocationsReturns an array of locations of chosen type(s) within the given radius of the given position, sorted from nearest to farthest.
- nearestLocationWithDubbingFind the nearest location having a non-empty speech.
- rectangularChecks if a location is rectangular (returns true) or elliptical (returns false).
- setDirectionSets the orientation of a location. The location's area and map icon (if its type uses an icon) will be rotated to this orientation.
- setImportanceSets the importance value of location.
- setNameSets the name of a location or a person (person only in single player).
- setPositionSets the position of a location.
- setRectangularSet the shape of a location to be either rectangular or elliptical. Locations default shape is elliptical.
- setSideSets a location's side. The default side is Unknown.
- setSizeSets the size (radius) of a location.
- setSpeechAdd speech to location.
- setTextSets the text associated with a location. This text will be displayed on the game map at the location's position.
- setTypeChanges a location to the specified class. Location classes are defined in CfgLocationTypes.
- sizeReturns a location's size.
- textCreates a structured text containing the given plain text if argument is String. Use setAttributes to set additional attributes on the text. If the…
- typeReturns a string of a Location's class name or Task's name (same as taskName).