createUnit

Hover & click on the images for description

Description:: Create a unit of class that is defined in CfgVehicles.

⚠
1.34 -wrong parameter ("Arma") defined!-1.00

This command could be bugged in Operation Flashpoint or Arma ; an additional join may solve the problem.

However, some commands such as setUnitPos only work if run before the join.

⚠
The unit won't be created if the passed group doesn't exist (a.k.a grpNull); this can happen if createGroup fails because the group limit has been reached.

Alt Syntax is the older syntax and differs from the main, newer syntax. The main difference is that the older syntax does not return unit reference. This is because the unit created with Alt Syntax is created strictly where passed group is local. This means that if the group is remote the unit will be created on the different client than the one the command was executed on and therefore it is not possible to return created unit reference immediately. In contrast newer syntax allows creating units in remote groups, which could be unsafe and the appropriate warning is logged into .rpt file: Warning: Adding units to a remote group is not safe. Please use setGroupOwner to change the group owner first.
Groups:: Uncategorised

Syntax:

group createUnit [type, position, markers, placement, special]

Parameters:

group: Group - Existing group new unit will join

[type, position, markers, placement, special]: Array

type: String - Class name of unit to be created as per CfgVehicles

position: Position, Position2D, Object or Group - Location unit is created at. In case of Group position of the group leader is used

markers: Array - Placement markers

placement: Number - Placement radius

special: String - Unit placement special, one of:

"NONE" - The unit will be created at the first available free position nearest to given position
"FORM" - Not implemented, currently functions the same as "NONE".
"CAN_COLLIDE" - The unit will be created exactly at passed position
"CARGO" - The unit will be created in cargo of the group's vehicle, regardless of the passed position. If group has no vehicle or there is no cargo space available, the unit will be placed according to "NONE". To check available cargo space use:_hasCargo = _veh emptyPositions "CARGO" > 0;

Return Value:

Object - The created unit

Syntax:: type createUnit [position, group, init, skill, rank]
Parameters:: type: String - Class name of unit to be created as per CfgVehicles
: [position, group, init, skill, rank]: Array
: position: Position, Position2D, Object or Group - Location unit is created at. In case of Group position of the group leader is used
: group: Group - Existing group new unit will join
: init: String - (Optional, default "") Unit init statement, similar to unit init field in the editor. The code placed in unit init will run upon unit creation for every client on network, present and future. The code itself receives the reference to the created unit via local variable this. Avoid using global commands in unit init statement as it already runs on every client.
: skill: Number - (Optional, default 0.5) Unit skill
: rank: String - (Optional, default "PRIVATE") Unit rank
Return Value:: ⚠
Nothing - This syntax does NOT return a unit reference!
In order to reference this unit, you can use newUnit = this in the init field

Example 1:: _unit = group player createUnit ["B_RangeMaster_F", position player, [], 0, "FORM"];
Example 2:: "B_RangeMaster_F" createUnit [position player, group player];
Example 3:: "B_RangeMaster_F" createUnit [getMarkerPos "barracks", _groupAlpha];
Example 4:: "B_RangeMaster_F" createUnit [ getMarkerPos "marker_1", _groupAlpha, "loon1 = this; this addWeapon 'BAF_L85A2_RIS_SUSAT'", 0.6, "corporal" ];

: 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

Posted on 27th Nov 2016
Ffur2007slx2_5: 1.64 The side of the created unit by this command uses its config's side and not the side of a passed empty group created by createGroup: _grp = createGroup east; hint str side _grp; // EAST _ap = _grp createUnit [ "C_man_p_beggar_F", position player, [], 0, "FORM"]; hint str side _ap; // CIV, not EAST We can use join command or fill the _grp with entities in advance to set _ap to the desired side.; Posted on 8th Dec 2018
oOKexOo: Since 1.86: If you want to place a module with createUnit, you have to ensure that the module gets activated automatically by setting BIS_fnc_initModules_disableAutoActivation to false, e.g: private _grp = createGroup sideLogic; "ModuleSmokeWhite_F" createUnit [ getPos player, _grp, "this setVariable ['BIS_fnc_initModules_disableAutoActivation', false, true];" ];

Navigation menu