createLocation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
(warning + notes merged with description)
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Creates a location of the specified class and dimensions at the specified position. Classes are defined in CfgLocationTypes. |DESCRIPTION=
| 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]]<br><br>
{{Warning | [[Location]]s are not serialized, meaning that if you save the game and then load, all created locations will be lost. Use "OnSaveGame" [[Arma_3:_Event_Handlers/ScriptedEventHandlers | scripted event handler]] to manually serialize them and "Loaded" [[Arma_3:_Event_Handlers/addMissionEventHandler#Loaded | mission event handler]] to recreate them on mission load from save.}} |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 38: Line 39:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on 12:25, 12 February 2010
<dt class="note">[[User:MaestrO.fr|MaestrO.fr]], [[User:TeaCup|TeaCup]]<dd class="note">
Possible location types, see: [[Location#Location Types|Location Types]]<br>
For the actual name text of the location, use [[setText]].<br>
<!-- Note Section END -->
<!-- Note Section END -->
</dl>
</dl>

Revision as of 09:45, 12 August 2019

-wrong parameter ("Arma") defined!-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. For the actual name text of the location, use text and setText

Locations are not serialized, meaning that if you save the game and then load, all created locations will be lost. Use "OnSaveGame" scripted event handler to manually serialize them and "Loaded" mission event handler to recreate them on mission load from save.
Groups:
Uncategorised

Syntax

Syntax:
createLocation [className, position, sizeX, sizeY]
Parameters:
[className, position, sizeX, sizeY]: Array
className: String - see Location Types
position: Position2D, Position3D or Object
sizeX: Number in meters
sizeY: Number in meters
Return Value:
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";

Additional Information

See also:
setTextnearestLocationnearestLocationslocationPositionnearestLocationWithDubbingsetRectangularrectangularsize

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

Notes

Bottom Section