createLocation: Difference between revisions

Latest revision as of 14: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
-____________________________________________________________________________________________
-| arma1 |Game name=
+|game1= arma1
+|version1= 1.08
-|1.08|Game version=
+|game2= arma2
+|version2= 1.00
-|arg= |Multiplayer Arguments=
+|game3= arma2oa
+|version3= 1.50
-|eff=local |Multiplayer Effects=
+|game4= tkoh
+|version4= 1.00
-|gr1= Locations |GROUP1=
+|game5= arma3
-____________________________________________________________________________________________
+|version5= 0.50
-| Creates a location of the specified class and dimensions at the specified position. Classes are defined in <tt>CfgLocationTypes</tt>. For possible location types see [[Location#Location Types|Location Types]]. For the actual name text of the location, use [[text]] and [[setText]] |DESCRIPTION=
+|eff=local
-____________________________________________________________________________________________
-|'''createLocation''' [className, position, sizeX, sizeY]|SYNTAX=
+|gr1= Locations
-|p1= [className, position, sizeX, sizeY]: [[Array]] |PARAMETER1=
+|descr= Creates a location of the specified class and dimensions at the specified position.
-|p2= className: [[String]] - see [[Location#Location Types|Location Types]] |PARAMETER2=
+Classes are defined in {{hl|CfgLocationTypes}}; for possible location types see [[Location#Location Types|Location Types]].<br>
-|p3= position: [[Position2D]], [[Position3D]] or [[Object]] |PARAMETER3=
+The alternative syntax allows to convert a non-editable (built-in) terrain location into an editable one, with the following restrictions:
-|p4= sizeX: [[Number]] in meters |PARAMETER4=
+* it cannot be deleted (but can be [[setType]] to "Invisible" to hide it)
-|p5= sizeY: [[Number]] in meters |PARAMETER5=
+* it cannot be moved
-| [[Location]] |RETURNVALUE=
+|s1= [[createLocation]] [className, position, sizeX, sizeY]
-____________________________________________________________________________________________
-|x1= <code>_location = [[createLocation]] [<nowiki/>[[Location#Location Types|"NameVillage"]] , [4035,2151,10], 100, 100];</code> |EXAMPLE1=
-|x2= <code>_location = [[createLocation]] [<nowiki/>[[Location#Location Types|"NameVillage"]] , [4035,2151,10], 30, 30];
+|p1= className: [[String]]
-_location [[setText]] "Player town";</code> |EXAMPLE2=
-____________________________________________________________________________________________
-| [[setText]], [[nearestLocation]], [[nearestLocations]], [[locationPosition]], [[nearestLocationWithDubbing]], [[setRectangular]], [[rectangular]], [[size]] |SEEALSO=
+|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
+|r2= [[Location]] - a script-editable location
-<h3 style="display:none">Notes</h3>
+|x1= <sqf>_location = createLocation ["NameVillage", [4035,2151,10], 100, 100];</sqf>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</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]]
-{{GameCategory|arma1|Scripting Commands}}
+}}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}