createLocation

From Bohemia Interactive Community
Revision as of 14:56, 23 June 2022 by Lou Montana (talk | contribs) (Add alternative syntax)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Creates a location of the specified class and dimensions at the specified position. Classes are defined in CfgLocationTypes; for possible location types see Location Types.
The alternative syntax allows to convert a non-editable (built-in) terrain location into an editable one, with the following restrictions:
  • it cannot be deleted (but can be setType to "Invisible" to hide it)
  • it cannot be moved
Groups:
Locations

Syntax

Syntax:
createLocation [className, position, sizeX, sizeY]
Parameters:
className: String
position: Position2D, Position3D or Object
sizeX: Number - in meters
sizeY: Number - in meters
Return Value:
Location

Alternative Syntax

Syntax:
createLocation [location]
Parameters:
location: Location - a terrain's location. If a scripted location is provided, it is simply returned
Return Value:
Location - a script-editable location

Examples

Example 1:
_location = createLocation ["NameVillage", [4035,2151,10], 100, 100];
Example 2:
_location = createLocation ["NameVillage", [4035,2151,10], 30, 30]; _location setText "Player town";
Example 3:
private _terrainLocation = nearestLocation [player, "nameCity"]; // assuming it returns a built-in location _terrainLocation setType "Invisible"; // does not do anything private _editableLocation = createLocation [_terrainLocation]; // does the conversion _editableLocation setType "Invisible"; // hides the location

Additional Information

See also:
setText nearestLocation nearestLocations locationPosition nearestLocationWithDubbing setRectangular rectangular size

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