| |
| Project Mercury API Reference |
| LineEmitter Members |
| LineEmitter Class Constructors Methods Fields Properties Events See Also Send Feedback |
[This is preliminary documentation and is subject to change.]
The LineEmitter type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | LineEmitter | Initializes a new instance of the LineEmitter class |
Methods
| Name | Description | |
|---|---|---|
 | CopyBaseFields |
Copies the fields of the Emitter base class into the specified Emitter.
(Inherited from Emitter.) |
| DeepCopy |
Returns an unitialised deep copy of the Emitter.
(Overrides Emitter..::.DeepCopy()()().) |
| Equals | (Inherited from Object.) |
| Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| ForceNextTrigger |
Forces the Emitter to execute its next trigger, even if it has a minimum trigger period and is
currently 'cooling down'.
(Inherited from Emitter.) |
| GenerateOffsetAndForce |
Generates an offset vector and force vector for a Particle when it is released.
(Overrides Emitter..::.GenerateOffsetAndForce(Vector2%, Vector2%).) |
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) |
| Initialise | Overloaded. |
| LoadContent |
Loads resources required by the Emitter via a ContentManager.
(Inherited from Emitter.) |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| OnNameChanged |
Raises the NameChanged event.
(Inherited from Emitter.) |
| OnParticleReleased |
Raises the ParticleReleased event.
(Inherited from Emitter.) |
| OnParticleRetired |
Raises the ParticleRetired event.
(Inherited from Emitter.) |
| Terminate |
Terminates the emitter immediately.
(Inherited from Emitter.) |
| ToString | (Inherited from Object.) |
| Trigger | Overloaded. |
| Update |
Updates the Emitter and all Particles within.
(Inherited from Emitter.) |
Extension Methods
| Name | Description | |
|---|---|---|
 | Initialize |
Initializes the Emitter.
(Defined by EmitterCompatibilityExtensions.) |
| Update |
Updates the Emitter.
(Defined by EmitterCompatibilityExtensions.) |
Fields
| Name | Description | |
|---|---|---|
 | BlendMode |
The blending mode to be used by Renderers when rendering this Emitter.
(Inherited from Emitter.) |
| EmitBothWays |
If true, will emit particles both ways. Only work when Rectilinear is enabled.
|
| Enabled |
Gets or sets a value indicating wether or not the Emitter is enabled (can be triggered).
(Inherited from Emitter.) |
| MinimumTriggerPeriod |
Defines the minimum amount of time between triggers for the Emitter, expressed in
whole and fractional seconds. Triggers which occur during this period will be ignored.
(Inherited from Emitter.) |
| Modifiers |
Gets the collection of Modifiers which are acting upon the Emitter.
(Inherited from Emitter.) |
| Particles |
Gets or sets the array of particles managed by the emitter.
(Inherited from Emitter.) |
| ParticleTexture |
Gets or sets the Texture2D used to display the Particles.
(Inherited from Emitter.) |
| ParticleTextureAssetName |
Gets the asset name of a texture to load in the LoadContent method.
(Inherited from Emitter.) |
| Rectilinear |
If true, will emit particles perpendicular to the angle of the line.
|
| ReleaseColour |
Gets or sets the colour of released Particles.
(Inherited from Emitter.) |
| ReleaseImpulse |
Gets or sets the initial impulse applied to Particles as they are relased.
(Inherited from Emitter.) |
| ReleaseOpacity |
Gets or sets the opacity of released Particles.
(Inherited from Emitter.) |
| ReleaseRotation |
Gets or sets the rotation of released Particles.
(Inherited from Emitter.) |
| ReleaseScale |
Gets or sets the scale of released particles.
(Inherited from Emitter.) |
| ReleaseSpeed |
Gets or sets the speed at which Particles travel when they are released.
(Inherited from Emitter.) |
| TriggerOffset |
The Emitters trigger offset in relation to the ParticleEffect.
(Inherited from Emitter.) |
Properties
| Name | Description | |
|---|---|---|
 | ActiveParticlesCount |
Gets the number of Particles which are currently active.
(Inherited from Emitter.) |
| Angle |
Gets or sets the rotation of the line around its middle point.
|
| Budget |
Gets or sets the number of Particles which are available to the Emitter.
(Inherited from Emitter.) |
| Initialised |
True if the Emitter object has been initialised, else false.
(Inherited from Emitter.) |
| Length |
Gets or sets the length of the line.
|
| Name |
Gets or sets the name of the Emitter.
(Inherited from Emitter.) |
| ReleaseQuantity |
Gets or sets the number of Particles which will be released on each trigger.
(Inherited from Emitter.) |
| Term |
Gets or sets the length of time that released Particles will remain active, in whole and fractional seconds.
(Inherited from Emitter.) |
Events
| Name | Description | |
|---|---|---|
 | NameChanged |
Raised when the name of the Emitter has been changed.
(Inherited from Emitter.) |
| ParticleReleased |
Raised when a Particle is released by the Emitter.
(Inherited from Emitter.) |
| ParticleRetired |
Raised when a Particle expires.
(Inherited from Emitter.) |
