stingray.ScatterSystem object reference

Description

Used to spawn large number of units.

The units are pooled internally, and only the units within a certain distance will be visible.

Constructors and accessors

stingray.World.scatter_system()

Related sample code

Appkit: /camera_wrapper.lua

Other related reference items

Units

Functions

destroy_all_brushes ( self ) Destroys all brushes in the scatter system.

Parameters

self :

stingray.ScatterSystem

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

destroy_brush ( self, brush_id ) Destroys the specified brush and all units spawned by it.

Parameters

self :	stingray.ScatterSystem	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
brush_id :	integer	The index of the brush to destroy.

Returns

This function does not return any values.

destroy_observer ( self, observer_id ) Destroys the observer with the specified index.

Parameters

self :	stingray.ScatterSystem	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
observer_id :	integer	The index of the observer to destroy.

Returns

This function does not return any values.

Related sample code

Appkit: /camera_wrapper.lua

make_brush ( self, settings ) : integer Creates a new brush that spawns a particular kind of unit.

Parameters

self :	stingray.ScatterSystem	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
settings :	scatter_system_brush	A table that provides settings for the new brush.

Returns

integer

The index of the newly created brush.

Other related reference items

scatter_system_brush

make_observer ( self, position, rotation ) : integer Creates a new observer for the brush system.

Parameters

self :	stingray.ScatterSystem	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
position :	stingray.Vector3	The position of the observer.
rotation :	stingray.Quaternion?	Optional; the rotation of the observer. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

integer

The index of the newly created observer.

Observers determine which units are visible. There must be at least one observer in order for any brush units to be visible. Typically, you create a single observer and move it manually in order to synchronize it with the position of the viewing camera. You can also create multiple observers if you need the spawning of units to be controlled from multiple positions.

Related sample code

Appkit: /camera_wrapper.lua

move_observer ( self, observer_id, position, rotation ) Moves the observer to the specified position and rotation, and updates unit visibility accordingly.

Parameters

self :	stingray.ScatterSystem	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
observer_id :	integer	The index of the observer to move.
position :	stingray.Vector3	The new position for the observer.
rotation :	stingray.Quaternion?	Optional; the new rotation for the observer. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

This function does not return any values.

Related sample code

Appkit: /camera_wrapper.lua

spawn ( self, brush_id, position, rotation ) : integer Spawns a unit using the specified brush at the specified position and rotation, and returns an index that you can use in a call to unspawn().

Parameters

self :	stingray.ScatterSystem	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
brush_id :	integer	The index of the brush to use.
position :	stingray.Vector3	The position at which the unit is spawned.
rotation :	stingray.Quaternion?	Optional; the starting rotation of the new unit. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

integer

The index of the newly spawned unit.

unspawn ( self, unit_id ) Unspawns the unit with the specified id.

Parameters

self :	stingray.ScatterSystem	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
unit_id :	integer	The index of the unit to unspawn.

Returns

This function does not return any values.

Other related reference items

stingray.ScatterSystem.spawn()