Positions
52 scripting commands. Also as Markdown for agents.
- AGLToASLConverts position from PositionAGL to PositionASL.
- aimPosReturns the position of the object other units can aim to.
- ASLToAGLConverts position from PositionASL to PositionAGL
- ASLToATLConverts a position from PositionASL to PositionATL
- ATLToASLConverts a position from PositionATL to PositionASL
- buildingPosReturns position of a given indexed position in a building.
- eyePosReturns the object's eyes / main turret position.
- findEmptyPositionSearches for an empty area around the specified position, starting from the *center* looking for an empty *areaRadius* and looks as far away as…
- findEmptyPositionReadyPreloads area to be used with findEmptyPosition command and returns true when area is ready. The size of the area preloaded is from `center - radius…
- formationPositionReturn position of unit in the formation.
- getPosReturns object or location position. If the argument is an object, the return value is in format PositionAGLS.
- getPosASLReturns the object position height above sea level.
- getPosASLWReturns the object position height above water surface (waves and pond objects included).
- getPosATLReturns the position of an object relative to the terrain.
- getPosWorldReturns the provided object's model centre position ([0,0,0]) in PositionASL, rather than the transformed boundingCenter or LandContact vertices.
- getRelPosReturns position that is given distance and relative direction away from original object. The alternative syntax available from Arma 3 v 2.14,…
- getTerrainHeightReturns terrain height at the specified location.
- getTerrainHeightASLReturns the terrain height above the sea for the given position.
- getTerrainInfoReturns the terrain heightmap information, as well as sea level offset (due to tides, if available).
- 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.
- inPolygonChecks whether position is inside given polygon. The polygon is only checked in 2 dimensions, i.e. the value of Z is ignored.
- isFlatEmptyChecks given position against given filter params. Filter includes checks for: - If there are any objects closer than given distance from given…
- mapGridPositionReturns the map grid position of an object or position.
- modelToWorldTranslates relative position from object model space to world space in PositionAGL format.
- modelToWorldWorldConverts position from object model space to world space in PositionASL format from the object's centre position.
- positionReturns position of an object (alias of getPos) or location (alias of locationPosition).
- positionCameraToWorldGet the world coordinate space (AGL) from a camera-relative position.
- posScreenToWorldConverts map screen coordinates into world coordinates. Unlike ctrlMapScreenToWorld, this command returns world position is format [x, y, 0],…
- posWorldToScreenConverts world coordinates into map screen coordinates. This command is identical to ctrlMapWorldToScreen.
- screenToWorldReturns the position on landscape (PositionAGL) corresponding to the given point on screen (in UI coordinates).
- screenToWorldDirectionReturns the 3D vector in world corresponding to the given point on the screen (in UI coordinates), as if the vector was aiming from the camera to the…
- setPosSets object position to format PositionAGLS (over surface). The Z value is used to calculate the nearest surface below the provided position. If the…
- setPosASLSets the object position above sea level. Given position must be in PositionASL format.
- setPosASL2Sets the object position. The pos array uses the PositionASL format. The version of the command does not offset based on object center.
- setPosASLWSets the object position above sea surface. The pos array uses the PositionASLW format.
- setPosATLSets the position of an object relative to the terrain.
- setPosWorldSets position of an object based on the model's centre position (see getPosWorld).
- setTerrainHeightSet the current terrain's altitude on provided location(s).
- setVehiclePositionMoves the object to a given position (same as createVehicle placement algorithm). Uses either the position that's defined by the *position* param, or…
- surfaceIsWaterReturns whether there is water at given position. In Arma 3, it also detects pond objects, but only if they are loaded in memory (normally only true…
- surfaceNormalReturns terrain's surface normal) on given position.
- surfaceTextureSame as surfaceType, but returns texture path to ground texture as string.
- surfaceTypeReturns what surface type is at the given position. For surface texture see surfaceTexture command.
- unitAimPositionReturns the position on the unit other units can aim at. Same as aimPos only returns position in PositionAGL format and has render scope alternative…
- unitsBelowHeightReturns units in group/array below given Above Terrain Level (ATL) altitude.
- visiblePositionReturns an object's rendered position (z value above surface underneath) in render time scope. Same as getPosVisual.
- visiblePositionASLReturns an object's rendered ASL position (z value above sea level) in render time scope.
- worldToModelConverts position from world space to object model space.
- worldToModelVisualConverts position from world space to object model space in render time scope.
- worldToScreenConverts position in world space into screen (UI) space. If a specified position is not within the current screen view, an empty array is returned.