Class ParticleConeShapeOptions

Information describing a ParticleEmitterConeShape.

Index

Constructors

Properties

_angle _arc _length _mode _radius _thickness _type

Accessors

angle arc length mode radius thickness type

Methods

assign clone isEqual isEqual

Constructors

constructor

new ParticleConeShapeOptions(type?, radius?, angle?, length?, thickness?, arc?, mode?): ParticleConeShapeOptions
Parameters
- Optionaltype: EnumValue<ParticleEmitterConeType, number>
- Optionalradius: number
- Optionalangle: rsx.Degree
- Optionallength: number
- Optionalthickness: number
- Optionalarc: rsx.Degree
- Optionalmode: Immutable<ParticleEmissionMode>
Returns ParticleConeShapeOptions

Properties

`Protected`_angle

_angle: rsx.Degree

`Protected`_arc

_arc: rsx.Degree

`Protected`_length

_length: number

`Protected`_mode

_mode: ParticleEmissionMode

`Protected`_radius

_radius: number

`Protected`_thickness

_thickness: number

`Protected`_type

_type: EnumValue<ParticleEmitterConeType, number>

Accessors

angle

get angle(): rsx.Degree
Angle of the cone.

Returns rsx.Degree
set angle(value): void
Parameters
- value: rsx.Degree
Returns void

arc

get arc(): rsx.Degree
Angular portion of the cone from which to emit particles from, in degrees.

Returns rsx.Degree
set arc(value): void
Parameters
- value: rsx.Degree
Returns void

length

get length(): number
Length of the cone. Irrelevant if emission type is Base.

Returns number
set length(value): void
Parameters
- value: number
Returns void

mode

get mode(): ParticleEmissionMode
Determines how will particle positions on the shape be generated.

Returns ParticleEmissionMode
set mode(value): void
Parameters
- value: Immutable<ParticleEmissionMode>
Returns void

radius

get radius(): number
Radius of the cone base.

Returns number
set radius(value): void
Parameters
- value: number
Returns void

thickness

get thickness(): number
Proportion of the volume that can emit particles. Thickness of 0 results in particles being emitted only from the edge of the cone, while thickness of 1 results in particles being emitted from the entire volume. In-between values will use a part of the volume.

Returns number
set thickness(value): void
Parameters
- value: number
Returns void

type

get type(): EnumValue<ParticleEmitterConeType, number>
Determines where on the cone are the particles emitter from.

Returns EnumValue<ParticleEmitterConeType, number>
set type(value): void
Parameters
- value: EnumValue<ParticleEmitterConeType, number>
Returns void

Methods

assign

assign(other): ParticleConeShapeOptions
Copies all properties defined by the prototype of ParticleConeShapeOptions from other to this instance.
Parameters
- other: Immutable<ParticleConeShapeOptions>
Returns ParticleConeShapeOptions

clone

clone(): ParticleConeShapeOptions
Clones this instance and returns a new ParticleConeShapeOptions with identical values.

Returns ParticleConeShapeOptions

isEqual

isEqual(this, other): boolean
Determines if this ParticleConeShapeOptions instance is equal to the other instance.
Parameters
- this: Immutable<ParticleConeShapeOptions>
- other: Immutable<ParticleConeShapeOptions>
Returns boolean

`Static`isEqual

isEqual(lhs, rhs): boolean
Determines if both ParticleConeShapeOptions instances are equal.
Parameters
- lhs: Immutable<ParticleConeShapeOptions>
- rhs: Immutable<ParticleConeShapeOptions>
Returns boolean