scatter_system_brush table reference

Description

This type of table defines the settings for new scatter brushes.

You can create tables with any or all of these members and pass them in calls to stingray.ScatterSystem.make_brush().

Other related reference items

	stingray.ScatterSystem.make_brush()
	Units

Data Members

fade_from : number For the SLIDE_Z method, this is the starting position of the unit when fading in.

A value of -2 means that the unit starts sliding from 2 meters below its final position.

fade_method : string The method used for fading objects in and out when spawned.

Possible values are:

• POP: Units will pop in and out of existence.
• SLIDE_Z: Units will slide into existence along their z-axis.
• SCALE Units will scale into existence.

fade_range : number The distance in meters that the user must move for the unit to be faded in completely when a method other than POP is used.

fade_to : number The final value that the the unit will fade to.

Typically you don't have to set this, because it is set to reasonable values by default: 0 meters for SLIDE_Z, and 1.0 for SCALE.

spawn_distance : number The distance from an observer at which units become visible, in meters.

Other related reference items

scatter_system_brush.unspawn_distance

unit : string The type of the unit that the brush spawns.

unspawn_distance : number The distance from an observer at which the units become invisible, in meters.

Usually this value is slightly higher than spawn_distance in order to prevent units from flickering on and off when the player moves. For example, spawn_distance might be 50 meters and unspawn_distance might be 55 meters.