Language:
Page Info
Tags:
Engine Version:

Orbit Modules

Choose your OS:

Orbit modules allow for rendering particle sprites offset/rotated away from the actual particle center.

Orbit

This is the only orbit module implemented. It allows for offsetting and rotating the sprite from the actual particle position. Multiple orbit modules can be chained together in a variety of ways.

Property

Description

Chaining

Chain Mode

An enumeration that describes how this module is chained together with other modules in the emitter. The combination of the module with the one prior to it is defined by setting this value. It can be one of the following:

Mode

Description

EOChainMode_Add

Add the module values with the previous results.

EOChainMode_Scale

Mutliply the module values with the previous results.

EOChainMode_Link

'Break' the chain and apply the values from the previous results.

Offset

Offset Amount

A vector distribution giving the offset of the sprite from the particle 'center'.

Offset Options

The options associated with the Offset Amount. Options include:

Option

Description

Process During Spawn

If true, the associated piece of data will be processed during the spawning of a particle.

Process During Update

If true, the associated piece of data will be processed during the update of a particle.

Use Emitter Time

If true, the EmitterTime will be used when retrieving the associated piece of data. If false, then the particle RelativeTime will be used.

Rotation

Rotation Amount

A vector distribution giving the amount to rotate the offset about the particle position. It is in 'turns', meaning 0 = no rotation, 0.5 = 180 degrees, 1.0 = 360 degrees.

Rotation Options

The options associated with the Rotation Amount. Options include:

Option

Description

Process During Spawn

If true, the associated piece of data will be processed during the spawning of a particle.

Process During Update

If true, the associated piece of data will be processed during the update of a particle.

Use Emitter Time

If true, the EmitterTime will be used when retrieving the associated piece of data. If false, then the particle RelativeTime will be used.

RotationRate

Rotation Rate Amount

A vector distribution giving the rate at which to rotate the offset about the particle position. In 'turns'.

Rotation Rate Options

The options associated with the Rotation Rate Amount. Options include:

Option

Description

Process During Spawn

If true, the associated piece of data will be processed during the spawning of a particle.

Process During Update

If true, the associated piece of data will be processed during the update of a particle.

Use Emitter Time

If true, the EmitterTime will be used when retrieving the associated piece of data. If false, then the particle RelativeTime will be used.

Tags