createUnit array: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(Redirected page to createUnit)
 
(17 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Command|= Comments
#REDIRECT [[createUnit]]
____________________________________________________________________________________________
 
| arma |= Game name
 
|1.00|= Game version
____________________________________________________________________________________________
 
| Creates a unit (person) of the given type (type is a name of a subclass of [[CfgVehicles]]) and makes it a member of the given group. If the markers array contains several marker names, the position of a random one is used. Otherwise, the given position is used. The unit is placed inside a circle with this position as its center and placement as its radius.
 
Special properties can be: "NONE" and "FORM".  |= Description
____________________________________________________________________________________________
 
| [[Object]] <nowiki>=</nowiki> group '''createUnit''' [type, position, markers, placement, special] |= Syntax
 
|p1= group: [[Group]] |= Parameter 1
 
|p2= [type, position, markers, placement, special]: [[Array]] |= Parameter 2
|p3= type: [[String]] |= Parameter 3
|p4= position: [[Position]] |= Parameter 4
|p5= markers: [[Array]] |= Parameter 5
|p6= placement: [[Number]]. Radius |= Parameter 6
|p7= special: [[String]] |= Parameter 7
 
| [[Object]] |= Return value
____________________________________________________________________________________________
|x1 = <code>_unit <nowiki>=</nowiki> group [[player]] createUnit ["SoldierWB", [[Position]] [[player]], [], 0, "FORM"]  </code>
| [[createUnit]], [[createCenter]], [[createGroup]], [[createVehicle]] |= See also
 
}}
 
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
Although this command takes a group as an argument, you need to use the [[join]] command if you want the created units to perform actions such as [[move]].  For example:-
 
<code> [[comment]] "Create a new soldier within 100m of the player and cause them to run towards the player" ;
_grp = [[createGroup]] [[west]];
unit = _grp [[createUnit]] ["SoldierWB", [[position]] [[player]], [], 100, "FORM"] ; 
[unit] [[join]] _grp ;
unit [[move]] [[position]] [[player]] ;
</code>
 
However, some commands such as [[setUnitPos]] only work if run before the [[join]].
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|CREATEUNITGROUP]]
[[Category:Scripting Commands ArmA|CREATEUNITGROUP]]
[[Category:Command_Group:_Object_Manipulation|CREATEUNITGROUP]]

Latest revision as of 11:39, 30 August 2016

Redirect to: