createLocation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *(arg|eff|mp|serverExec|gr[0-9]) *= *(.*) * *\|([^=]{12})" to "|$1=$2 |descr=$3")
(Add alternative syntax)
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= arma1
|1.08
|version1= 1.08


|game2= arma2
|game2= arma2
Line 20: Line 20:
|gr1= Locations
|gr1= Locations


|descr= 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]]
|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:
* it cannot be deleted (but can be [[setType]] to "Invisible" to hide it)
* it cannot be moved


|s1= '''createLocation''' [className, position, sizeX, sizeY]
|s1= [[createLocation]] [className, position, sizeX, sizeY]


|p1= [className, position, sizeX, sizeY]: [[Array]]
|p1= className: [[String]]
|p2= className: [[String]] - see [[Location#Location Types|Location Types]]
|p3= position: [[Position2D]], [[Position3D]] or [[Object]]
|p4= sizeX: [[Number]] in meters
|p5= sizeY: [[Number]] in meters


|r1=[[Location]]
|p2= position: [[Position#Introduction|Position2D]], [[Position#Introduction|Position3D]] or [[Object]]


|x1= <code>_location = [[createLocation]] [<nowiki/>[[Location#Location Types|"NameVillage"]] , [4035,2151,10], 100, 100];</code>
|p3= sizeX: [[Number]] - in meters


|x2= <code>_location = [[createLocation]] [<nowiki/>[[Location#Location Types|"NameVillage"]] , [4035,2151,10], 30, 30];
|p4= sizeY: [[Number]] - in meters
_location [[setText]] "Player town";</code>


|seealso= [[setText]], [[nearestLocation]], [[nearestLocations]], [[locationPosition]], [[nearestLocationWithDubbing]], [[setRectangular]], [[rectangular]], [[size]]
|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
 
|x1= <sqf>_location = createLocation ["NameVillage", [4035,2151,10], 100, 100];</sqf>
 
|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>
 
|seealso= [[setText]] [[nearestLocation]] [[nearestLocations]] [[locationPosition]] [[nearestLocationWithDubbing]] [[setRectangular]] [[rectangular]] [[size]]
}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 14:56, 23 June 2022

Logo A1 black.png1.08Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LELocal
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
Retrieved from "https://community.bistudio.com/wiki?title=createLocation&oldid=322768"