Client Scripting API - ParticleSystem
From Multiverse
NOTE: You can create a new particle system with the Client scripting API; however there is currently no way to access to an existing particle system (such as one created in the world editor and sent from the server to the client).
ParticleSystem is a class in the Client Scripting API that represents a set of animated particles that are visible in the 3D world.
Contents |
[edit]
Constructor
ParticleSystem(name, particleSystem)
Returns
A new ParticleSystem object.
Parameters
| Parameter | Datatype | Default Value | Description |
|---|---|---|---|
| name | string | None | The name of the ParticleSystem instance. Must be unique. |
| particleSystem | string | None | The name of the particle effect script to run. |
[edit]
Example
glowPrimaryParticle = ClientAPI.ParticleSystem.ParticleSystem('glowPrimary' + str(ClientAPI.GetLocalOID()), 'glow')
[edit]
Methods
[edit]
ScaleVelocity
ScaleVelocity(scaleFactor)
Scale the velocity of all particles in the particle system.
Returns
None
Parameters
| Parameter | Datatype | Default Value | Description |
|---|---|---|---|
| scaleFactor | float | None | The amount to scale the velocity of particles. |
[edit]
Properties
| Property | Datatype | Description |
|---|---|---|
| ParentNode | SceneNode
| The SceneNode that this object is attached to. |
| Name | string | Name of the WorldObject. Must be unique. |
| DefaultWidth | float | The default width for particles in this particle system. |
| DefaultHeight | float | The default height for particles in this particle system. |
| ParticleQuota | int | The maximum number of particles that can be active in this particle system. |
| ParticleCount | int | The number of particles currently active in this particle system |
| Color | ColorEx
| The base color of the particles. |
