createUnit: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "{{HashLink" to "{{Link") |
Lou Montana (talk | contribs) m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )U([a-z])" to "$1u$3") |
||
Line 93: | Line 93: | ||
|p24= 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 [[Magic Variables#this_2|this]]. Do not use global commands in a unit's ''init'' as it runs on every client. | |p24= 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 [[Magic Variables#this_2|this]]. Do not use global commands in a unit's ''init'' as it runs on every client. | ||
|p25= skill: [[Number]] - (Optional, default 0.5) | |p25= skill: [[Number]] - (Optional, default 0.5) unit [[skill]] | ||
|p26= rank: [[String]] - (Optional, default "PRIVATE") | |p26= rank: [[String]] - (Optional, default "PRIVATE") unit [[rank]] | ||
|r2= {{Feature|Warning|'''[[Nothing]]''' - This syntax does '''not''' return a unit reference! See {{Link|#Example 7}} for a workaround.}} | |r2= {{Feature|Warning|'''[[Nothing]]''' - This syntax does '''not''' return a unit reference! See {{Link|#Example 7}} for a workaround.}} |
Revision as of 12:32, 8 November 2023
Description
- Description:
- Create a unit of the provided CfgVehicles class.
Syntax 1 Syntax 2 Group's locality the provided group can be non-local, but a warning will be logged the provided group must be local Unit's side using a classname from a different side than the provided group will result in the unit itself being of a (config-defined) side inside a group of another side - see Example 6 for more information using a classname from a different side than the provided group will result in the unit being of the same side as the provided group Other the unit's init code will execute after a slight delay if the provided group is not local this syntax does not return a reference to the created unit (see Example 7) - Multiplayer:
- It is recommended to create the unit where the group is local - use remoteExec if needed.
- Groups:
- Object Manipulation
Syntax
- Syntax:
- group createUnit [type, position, markers, placement, special]
- Parameters:
- group: Group - existing group new unit will join; if the group is not local, a warning will be logged
- type: String - classname of unit to be created as per CfgVehicles
- position: Object, Group or Array format Position or Position2D - location where to create the unit. In case of Group, the group leader's position 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
- "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 (see Example 5). If group has no vehicle or there is no cargo space available, the unit will be placed according to "NONE". "CARGO" placement excludes cargo positions with personal FFV turrets. To check available cargo space use:
1.34 FFV before - Return Value:
- Object - The created unit
Alternative Syntax
- Syntax:
- type createUnit [position, group, init, skill, rank]
- Parameters:
- type: String - classname of unit to be created as per CfgVehicles
- position: Object, Group or Array format Position or Position2D - location at which the unit is created. In case of Group position of the group leader is used
- group: Group - existing group the 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. Do not use global commands in a unit's init as it runs on every client.
- skill: Number - (Optional, default 0.5) unit skill
- rank: String - (Optional, default "PRIVATE") unit rank
- Return Value:
Examples
- Example 1:
- Example 2:
- Example 3:
- Example 4:
- "B_RangeMaster_F" createUnit [ getMarkerPos "marker_1", _groupAlpha, "loon1 = this; this addWeapon 'BAF_L85A2_RIS_SUSAT'", 0.6, "corporal" ];
- Example 5:
- _veh = "O_Quadbike_01_F" createVehicle (player getRelPos [10, 0]); _grp = createVehicleCrew _veh; _unit = _grp createUnit [typeOf driver _veh, _grp, [], 0, "CARGO"];
- Example 6:
- Creating a unit from a different side may lead to issues:
- Example 7:
- Reference the created unit through a global variable:
Additional Information
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
- Posted on Dec 08, 2018 - 21:57 (UTC)
- 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:
- Posted on Mar 18, 2019 - 19:31 (UTC)
-
Alt Syntax is the older syntax and differs in functionality 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, the newer syntax allows creating units in remote groups while returning unit reference immediately, 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.
Another very important difference is that the older syntax (Alt Syntax) will create unit of the same side as the side of the group passed as argument. For example, if the group is WEST and the unit faction is OPFOR of type, say "O_Soldier_GL_F", the unit created will be on the WEST side as well. In contrast, newer syntax will create the same unit on the EAST side in the WEST group, which will be treated as hostile by other group members and eliminated.
- Posted on Jun 19, 2020 - 10:13 (UTC)
- 1.98 note that even when setting the placement special parameter to "NONE", 3DEN-placed objects are being ignored when looking for a free position. In other words: units will spawn within editor-placed rocks or under houses.
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.34
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Object Manipulation
- Scripting Commands: Global Effect