BIS fnc spawnObjects: Difference between revisions

Latest revision as of 14: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
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Object Manipulation
-|1.00|= Game version
+|descr= Create a stack of objects at given position or on top of given object (eg. table).
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [position, className, count, offsetMatrix, offsetDir, dirNoise, enableSimulation] call [[BIS_fnc_spawnObjects]]
-	Description:
+|p1= position: [[Array]] format [[Position#PositionASL|PositionASL]], or [[Array]] as [referenceObject, placement]
-	Creates an objects or stack of objects at given position or on top of given object (eg. table).
+* 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
-	Parameter(s):
+|p2= className: [[String]] - class of the object(s) to spawn; all will use the same class
-: _positionASL:array				- ASL position where the objects will be spawned
-: [
+|p3= count: [[Number]] - (Optional, default: 1) how many objects will be spawned
-		_anchorObject:object,			  - anchor object (eg. table) defining where the objects will be spawned
-	 	_anchorPlacement:string (default = "TOP") - anchor placement definition, valid values are "BOTTOM","TOP","GROUND"
-	 							"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 objects; all need to have same class
+|p4= offsetMatrix: [[Array]] - (Optional, default: [0,0,0]) starting spawning position offset
-: _count:scalar (default = 1)			- number of the object; if > 1 object will be spawned of top of each other
-: _offsetMatrix:array (default = [0,0,0])	- starting spawning position offset
-: _offsetDir:scalar (default = 0)		- starting spawning direction offset
-: _dirNoise:code (default = {0})		- spawned object direction delta from the starting direction, defined as code returning dir delta value
-: _enableSimulation:bool (default = false)	- shall the simulation of the spawned objects be enabled or not?
-	Returns:
+|p5= offsetDir: [[Number]] - (Optional, default: 0) starting spawning direction offset
-	array of created objects
-	Example:
+|p6= dirNoise: [[Code]] - (Optional, default: {0}) spawned object direction delta from the starting direction, defined as code returning dir delta value
-	_objects = [_position:array,_className:string,_count:scalar,_offsetMatrix:array,_offsetDir:scalar,_dirNoise:code,_enableSimulation:bool] call BIS_fnc_spawnObjects;
-	_objects = [[_table,"TOP"],"Box_NATO_Wps_F",1,[(random 0.2)-0.1,(random 0.2)-0.1,0],(random 20)-10] call BIS_fnc_spawnObjects;
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|p7= enableSimulation: [[Boolean]] - (Optional, default: false) shall the simulation of the spawned objects be enabled or not
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_spawnObjects]]; --> |= Syntax
+|r1= [[Array]] of created [[Object]]s
-|p1= |= Parameter 1
+|x1= <sqf>
+private _randomPos = [(random 0.2) -0.1, (random 0.2) -0.1, 0];
-| |= Return value
+_objects = [[_table, "TOP"], "Box_NATO_Wps_F", 3, _randomPos,(random 20)-10] call BIS_fnc_spawnObjects;
-____________________________________________________________________________________________
+</sqf>
-|x1= <code></code> |=
-____________________________________________________________________________________________
-| |= See also
+|seealso= [[createVehicle]] [[createSimpleObject]] [[enableSimulation]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Objects|{{uc:spawnObjects}}]]
-[[Category:Functions|{{uc:spawnObjects}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:spawnObjects}}]]