BIS fnc spawnObjects: Difference between revisions

Latest revision as of 15:40, 13 July 2022

1.00

Hover & click on the images for description

Description

Description:: Create a stack of objects at given position or on top of given object (eg. table).
Execution:: call
Groups:: Object Manipulation

Syntax

Syntax:

[position, className, count, offsetMatrix, offsetDir, dirNoise, enableSimulation] call BIS_fnc_spawnObjects

Parameters:

position: Array format PositionASL, or Array as [referenceObject, placement]

referenceObject: Object
placement: String - can be:
- "BOTTOM" = at the bottom of the object
- "TOP" = top of the objects boundingbox
- "GROUND" = sitting just on the ground
- "ROADWAY" = sitting just on the ground

className: String - class of the object(s) to spawn; all will use the same class

count: Number - (Optional, default: 1) how many objects will be spawned

offsetMatrix: Array - (Optional, default: [0,0,0]) starting spawning position offset

offsetDir: Number - (Optional, default: 0) starting spawning direction offset

dirNoise: Code - (Optional, default: {0}) spawned object direction delta from the starting direction, defined as code returning dir delta value

enableSimulation: Boolean - (Optional, default: false) shall the simulation of the spawned objects be enabled or not

Return Value:

Array of created Objects

Examples

Example 1:: private _randomPos = [(random 0.2) -0.1, (random 0.2) -0.1, 0]; _objects = [[_table, "TOP"], "Box_NATO_Wps_F", 3, _randomPos,(random 20)-10] call BIS_fnc_spawnObjects;

Additional Information

See also:: createVehicle createSimpleObject enableSimulation

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

@@ Line 1: / Line 1: @@
 {{RV|type=function
-| arma3
+|game1= arma3
+|version1= 1.00
-|1.00
 |gr1= Object Manipulation
-| Create a stack of objects at given position or on top of given object (eg. table).
+|descr= Create a stack of objects at given position or on top of given object (eg. table).
-| [position, className, count, offsetMatrix, offsetDir, dirNoise, enableSimulation] call [[BIS_fnc_spawnObjects]]
+|s1= [position, className, count, offsetMatrix, offsetDir, dirNoise, enableSimulation] call [[BIS_fnc_spawnObjects]]
-|p1= position: [[PositionASL]], or [[Array]] as [referenceObject, placement]
+|p1= position: [[Array]] format [[Position#PositionASL|PositionASL]], or [[Array]] as [referenceObject, placement]
 * referenceObject: [[Object]]
 * placement: [[String]] - can be:
@@ Line 21: / Line 20: @@
 |p2= className: [[String]] - class of the object(s) to spawn; all will use the same class
-|p3= count: [[Number]] (Optional, default: 1) - how many objects will be spawned
+|p3= count: [[Number]] - (Optional, default: 1) how many objects will be spawned
-|p4= offsetMatrix: [[Array]] (Optional, default: [0,0,0]) - starting spawning position offset
+|p4= offsetMatrix: [[Array]] - (Optional, default: [0,0,0]) starting spawning position offset
-|p5= offsetDir: [[Number]] (Optional, default: 0) - starting spawning direction offset
+|p5= offsetDir: [[Number]] - (Optional, default: 0) starting spawning direction offset
-|p6= dirNoise: [[Code]] (Optional, default: {0}) - spawned object direction delta from the starting direction, defined as code returning dir delta value
+|p6= dirNoise: [[Code]] - (Optional, default: {0}) spawned object direction delta from the starting direction, defined as code returning dir delta value
-|p7= enableSimulation: [[Boolean]] (Optional, default: false) - shall the simulation of the spawned objects be enabled or not
+|p7= enableSimulation: [[Boolean]] - (Optional, default: false) shall the simulation of the spawned objects be enabled or not
-|r1=[[Array]] of created [[Object|Objects]]
+|r1= [[Array]] of created [[Object]]s
-|x1= <code>_randomPos = [([[random]] 0.2) -0.1, ([[random]] 0.2) -0.1, 0];
+|x1= <sqf>
-_objects = [<nowiki/>[_table, "TOP"], "Box_NATO_Wps_F", 3, _randomPos,([[random]] 20)-10] [[call]] [[BIS_fnc_spawnObjects]];</code>
+private _randomPos = [(random 0.2) -0.1, (random 0.2) -0.1, 0];
+_objects = [[_table, "TOP"], "Box_NATO_Wps_F", 3, _randomPos,(random 20)-10] call BIS_fnc_spawnObjects;
+</sqf>
-|seealso= [[createVehicle]], [[createSimpleObject]], [[enableSimulation]]
+|seealso= [[createVehicle]] [[createSimpleObject]] [[enableSimulation]]
 }}
-[[Category:{{Name|arma3}}: Functions|{{uc:spawnObjects}}]]