BIS fnc spawnObjects: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling)
m (template:command argument fix)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Create a stack of objects at given position or on top of given object (eg. table). |= Description
| Create a stack of objects at given position or on top of given object (eg. table). |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [position, className, count, offsetMatrix, offsetDir, dirNoise, enableSimulation] call [[BIS_fnc_spawnObjects]] |= Syntax
| [position, className, count, offsetMatrix, offsetDir, dirNoise, enableSimulation] call [[BIS_fnc_spawnObjects]] |SYNTAX=


|p1= position: [[PositionASL]], or [[Array]] as [referenceObject, placement]
|p1= position: [[PositionASL]], or [[Array]] as [referenceObject, placement]
Line 19: Line 19:
** "TOP" = top of the objects boundingbox
** "TOP" = top of the objects boundingbox
** "GROUND" = sitting just on the ground
** "GROUND" = sitting just on the ground
** "ROADWAY" = sitting just on the ground |= Parameter 1
** "ROADWAY" = sitting just on the ground |PARAMETER1=


|p2= className: [[String]] - class of the object(s) to spawn; all will use the same class |= Parameter 2
|p2= className: [[String]] - class of the object(s) to spawn; all will use the same class |PARAMETER2=


|p3= count: [[Number]] (Optional, default: 1) - how many objects will be spawned |= Parameter 3
|p3= count: [[Number]] (Optional, default: 1) - how many objects will be spawned |PARAMETER3=


|p4= offsetMatrix: [[Array]] (Optional, default: [0,0,0]) - starting spawning position offset |= Parameter 4
|p4= offsetMatrix: [[Array]] (Optional, default: [0,0,0]) - starting spawning position offset |PARAMETER4=


|p5= offsetDir: [[Number]] (Optional, default: 0) - starting spawning direction offset |= Parameter 5
|p5= offsetDir: [[Number]] (Optional, default: 0) - starting spawning direction offset |PARAMETER5=


|p6= dirNoise: [[Code]] (Optional, default: {0}) - spawned object direction delta from the starting direction, defined as code returning dir delta value |= Parameter 6
|p6= dirNoise: [[Code]] (Optional, default: {0}) - spawned object direction delta from the starting direction, defined as code returning dir delta value |PARAMETER6=


|p7= enableSimulation: [[Boolean]] (Optional, default: false) - shall the simulation of the spawned objects be enabled or not |= Parameter 7
|p7= enableSimulation: [[Boolean]] (Optional, default: false) - shall the simulation of the spawned objects be enabled or not |PARAMETER7=


| [[Array]] of created [[Object|Objects]] |= Return value
| [[Array]] of created [[Object|Objects]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>_randomPos = [([[random]] 0.2) -0.1, ([[random]] 0.2) -0.1, 0];
|x1= <code>_randomPos = [([[random]] 0.2) -0.1, ([[random]] 0.2) -0.1, 0];
_objects = <nowiki>[</nowiki>[_table, "TOP"], "Box_NATO_Wps_F", 3, _randomPos,([[random]] 20)-10] [[call]] [[BIS_fnc_spawnObjects]];</code> |= Example 1
_objects = <nowiki>[</nowiki>[_table, "TOP"], "Box_NATO_Wps_F", 3, _randomPos,([[random]] 20)-10] [[call]] [[BIS_fnc_spawnObjects]];</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[createVehicle]], [[createSimpleObject]], [[enableSimulation]] |= See also
| [[createVehicle]], [[createSimpleObject]], [[enableSimulation]] |SEEALSO=


}}
}}

Revision as of 14:33, 7 April 2019


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:
Uncategorised

Syntax

Syntax:
[position, className, count, offsetMatrix, offsetDir, dirNoise, enableSimulation] call BIS_fnc_spawnObjects
Parameters:
position: 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:
_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:
createVehiclecreateSimpleObjectenableSimulation

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

Notes

Bottom Section