createLocation: Difference between revisions

Latest revision as of 15:56, 23 June 2022

1.08

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

2.10

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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma |= Game name
+|game1= arma1
+|version1= 1.08
-|1.08|= Game version
+|game2= arma2
+|version2= 1.00
-|arg= |= Arguments in MP
+|game3= arma2oa
+|version3= 1.50
-|eff=local |= Effects in MP
+|game4= tkoh
-____________________________________________________________________________________________
+|version4= 1.00
-| Creates a location of the specified class and dimensions at the specified position. Classes are defined in CfgLocationTypes. |= Description
+|game5= arma3
-____________________________________________________________________________________________
+|version5= 0.50
-| [[Location]] <nowiki>=</nowiki> '''createLocation''' ["ClassName", [[Position]], sizeX, sizeY]|= Syntax
+|eff=local
-|p1= "ClassName" : [[String]] |= Parameter 1
+|gr1= Locations
-|p2= [[Position]] |= Parameter 2
-|p3= sizeX: [[Number]] in meters |= Parameter 3
-|p4= sizeY: [[Number]] in meters |= Parameter 4
-| [[Location]] |= Return value
+|descr= Creates a location of the specified class and dimensions at the specified position.
-____________________________________________________________________________________________
+Classes are defined in {{hl|CfgLocationTypes}}; for possible location types see [[Location#Location Types|Location Types]].<br>
+The alternative syntax allows to convert a non-editable (built-in) terrain location into an editable one, with the following restrictions:
-|x1= <pre>myLocation = createLocation ["NameVillage", [4035,2151,10], 100, 100]</pre> |= Example 1
+* it cannot be deleted (but can be [[setType]] to "Invisible" to hide it)
-____________________________________________________________________________________________
+* it cannot be moved
-||= See also
+|s1= [[createLocation]] [className, position, sizeX, sizeY]
-}}
+|p1= className: [[String]]
+|p2= position: [[Position#Introduction|Position2D]], [[Position#Introduction|Position3D]] or [[Object]]
+|p3= sizeX: [[Number]] - in meters
+|p4= sizeY: [[Number]] - in meters
+|r1= [[Location]]
+|s2= [[createLocation]] [location]
+|s2since= arma3 2.10
+|p21= location: [[Location]] - a terrain's location. If a scripted location is provided, it is simply returned
-<h3 style="display:none">Notes</h3>
+|r2= [[Location]] - a script-editable location
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-[[Image:LocationTypes.JPG|right|thumb|Location Types]]
-Possible location types are:
-*Mount
-*Name
-*NameMarine
-*NameCityCapital
-*NameCity
-*NameVillage
-*NameLocal
-*Hill
-*ViewPoint
-*RockArea
-*BorderCrossing
-*VegetationBroadleaf
-*VegetationFir
-*VegetationPalm
-*VegetationVineyard
-<!-- Note Section END -->
+|x1= <sqf>_location = createLocation ["NameVillage", [4035,2151,10], 100, 100];</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|x2= <sqf>
+_location = createLocation ["NameVillage", [4035,2151,10], 30, 30];
+_location setText "Player town";
+</sqf>
+|x3= <sqf>
+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
+</sqf>
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
+|seealso= [[setText]] [[nearestLocation]] [[nearestLocations]] [[locationPosition]] [[nearestLocationWithDubbing]] [[setRectangular]] [[rectangular]] [[size]]
-[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
+}}
-[[Category:Command_Group:_Locations|{{uc:{{PAGENAME}}}}]]