ludiloom

Ludiloom API

last updated on 2009, May 22nd

Base Concepts	Scene Objects		Data Interface	Gui Overlays
Arena Object ObjectTemplate Presence PresenceTemplate RuleBook System	BillBoard Camera Effect HighlightDecal Light Material MeshDecal	Model Plane River Road Sound StaticFlora Terrain	HashTable InterModel Matrix MediaItem Vector	Button Checkbox CodeEditbox ComboBox Editbox Listbox MenuBar MenuItem	MenuPopup MultiColumn MultilineEditbox ProgressBar RadioButton ScrollBar ScrollPane SliderBar	Spinner StaticImage StaticText TabPane ToggleButton Tree Window

Effect

Method Summary
`number`	`getBillboardRendererRotationType ()`
`number`	`getBillboardRendererType ()`
`nil`	`getDirection (number x, number y, number z)`
`number`	`getEmitterAngle (number index)`
`number, number, number, number, number, number, number, number`	`getEmitterColourRange (number index)`
`number, number`	`getEmitterDelayRange (number index)`
`number, number, number`	`getEmitterDirection (number index)`
`number, number`	`getEmitterDurationRange (number index)`
`number`	`getEmitterEmissionRate (number index)`
`number, number, number`	`getEmitterInnerSize (number index)`
`number, number`	`getEmitterLifeSpan (number index)`
`number, number, number`	`getEmitterPosition (number index)`
`number, number`	`getEmitterRingInnerSize (number index)`
`number, number, number`	`getEmitterSize (number index)`
`number`	`getEmitterType (number index)`
`number, number`	`getEmitterVelocityRange (number index)`
`string`	`getID ()`
`number`	`getInterval ()`
`string`	`getMaterial ()`
`number, number`	`getParticleSize ()`
`number, number, number`	`getPosition ()`
`number`	`getQuota ()`
`number`	`getTimeout ()`
`number`	`getType ()`
`nil`	`getUpVector (number x, number y, number z)`
`boolean`	`isAccurateFacing ()`
`boolean`	`isCullEach ()`
`boolean`	`isLocalSpace ()`
`boolean`	`isPointRendering ()`
`boolean`	`isSorted ()`
`boolean`	`isVisible ()`
`nil`	`print ()`
`nil`	`removeAffector (number index)`
`nil`	`removeAllAffectors ()`
`nil`	`removeAllEmitters ()`
`nil`	`removeEmitter (number index)`
`nil`	`setAccurateFacing (boolean facing)`
`nil`	`setAffectorColourFader (number index)`
`nil`	`setAffectorColourFader (number index, number red, number green, number blue, number alpha)`
`nil`	`setAffectorColourFader2 (number index)`
`nil`	`setAffectorColourFader2 (number index, number red1, number green1, number blue1, number alpha1, number red2, number green2, number blue2, number alpha2, number stateChange)`
`nil`	`setAffectorColourImage (number index, mediaItemKey image)`
`nil`	`setAffectorColourInterpolator (number index)`
`nil`	`setAffectorColourInterpolator (number index, number red1, number green1, number blue1, number alpha1, number time1, number red2, number green2, number blue2, number alpha2, number time2, number red3, number green3, number blue3, number alpha3, number time3, number red4, number green4, number blue4, number alpha4, number time4, number red5, number green5, number blue5, number alpha5, number time5, number red6, number green6, number blue6, number alpha6, number time6)`
`nil`	`setAffectorDeflectorPlane (number index)`
`nil`	`setAffectorDeflectorPlane (number index, number pX, number pY, number pZ, number nX, number nY, number nZ, number bounce)`
`nil`	`setAffectorLinearForce (number index)`
`nil`	`setAffectorLinearForce (number index, number fX, number fY, number fZ, boolean average)`
`nil`	`setAffectorRandomiser (number index)`
`nil`	`setAffectorRandomiser (number index, number variation, number scope, boolean keepVelocity)`
`nil`	`setAffectorRotator (number index)`
`nil`	`setAffectorRotator (number index, number rotationStart, number rotationEnd, number speedStart, number speedEnd)`
`nil`	`setAffectorScaler (number index)`
`nil`	`setAffectorScaler (number index, number rate)`
`nil`	`setBillboardRendererRotationType (number rotationType)`
`nil`	`setBillboardRendererType (number billboardRenderer)`
`nil`	`setCullEach (boolean cullEach)`
`nil`	`setDirection (number x, number y, number z)`
`nil`	`setEmitterAngle (number index, number angle)`
`nil`	`setEmitterBox (number index)`
`nil`	setEmitterBox (number index, number angle, number startColourRangeRed, number startColourRangeGreen, number startColourRangeBlue, number startColourRangeAlpha, number endColourRangeRed, number endColourRangeGreen, number endColourRangeBlue, number endColourRangeAlpha, number dirX, number dirY, number dirZ, number emissionRate, number posX, number posY, number posZ, number velocityMin, number velocityMax, number timeToLiveMin, number timeToLiveMax, number durationMin, number durationMax, number repeatDelayMin, number repeatDelayMax, number width, number height, number depth)
`nil`	`setEmitterColourRange (number index, number startColourRangeRed, number startColourRangeGreen, number startColourRangeBlue, number startColourRangeAlpha, number endColourRangeRed, number endColourRangeGreen, number endColourRangeBlue, number endColourRangeAlpha)`
`nil`	`setEmitterCylinder (number index)`
`nil`	setEmitterCylinder (number index, number angle, number startColourRangeRed, number startColourRangeGreen, number startColourRangeBlue, number startColourRangeAlpha, number endColourRangeRed, number endColourRangeGreen, number endColourRangeBlue, number endColourRangeAlpha, number dirX, number dirY, number dirZ, number emissionRate, number posX, number posY, number posZ, number velocityMin, number velocityMax, number timeToLiveMin, number timeToLiveMax, number durationMin, number durationMax, number repeatDelayMin, number repeatDelayMax, number width, number height, number depth)
`nil`	`setEmitterDelayRange (number index, number repeatDelayMin, number repeatDelayMax)`
`nil`	`setEmitterDirection (number index, number dirX, number dirY, number dirZ)`
`nil`	`setEmitterDurationRange (number index, number durationMin, number durationMax)`
`nil`	`setEmitterEllipsoid (number index)`
`nil`	setEmitterEllipsoid (number index, number angle, number startColourRangeRed, number startColourRangeGreen, number startColourRangeBlue, number startColourRangeAlpha, number endColourRangeRed, number endColourRangeGreen, number endColourRangeBlue, number endColourRangeAlpha, number dirX, number dirY, number dirZ, number emissionRate, number posX, number posY, number posZ, number velocityMin, number velocityMax, number timeToLiveMin, number timeToLiveMax, number durationMin, number durationMax, number repeatDelayMin, number repeatDelayMax, number width, number height, number depth)
`nil`	`setEmitterEmissionRate (number index, number emissionRate)`
`nil`	`setEmitterHollowEllipsoid (number index)`
`nil`	setEmitterHollowEllipsoid (number index, number angle, number startColourRangeRed, number startColourRangeGreen, number startColourRangeBlue, number startColourRangeAlpha, number endColourRangeRed, number endColourRangeGreen, number endColourRangeBlue, number endColourRangeAlpha, number dirX, number dirY, number dirZ, number emissionRate, number posX, number posY, number posZ, number velocityMin, number velocityMax, number timeToLiveMin, number timeToLiveMax, number durationMin, number durationMax, number repeatDelayMin, number repeatDelayMax, number width, number height, number depth, number innerWidth, number innerHeight, number innerDepth)
`nil`	`setEmitterInnerSize (number index, number innerWidth, number innerHeight, number innerDepth)`
`nil`	`setEmitterLifeSpan (number index, number timeToLiveMin, number timeToLiveMax)`
`nil`	`setEmitterPoint (number index)`
`nil`	setEmitterPoint (number index, number angle, number startColourRangeRed, number startColourRangeGreen, number startColourRangeBlue, number startColourRangeAlpha, number endColourRangeRed, number endColourRangeGreen, number endColourRangeBlue, number endColourRangeAlpha, number dirX, number dirY, number dirZ, number emissionRate, number posX, number posY, number posZ, number velocityMin, number velocityMax, number timeToLiveMin, number timeToLiveMax, number durationMin, number durationMax, number repeatDelayMin, number repeatDelayMax)
`nil`	`setEmitterPosition (number index, number posX, number posY, number posZ)`
`nil`	`setEmitterRing (number index)`
`nil`	setEmitterRing (number index, number angle, number startColourRangeRed, number startColourRangeGreen, number startColourRangeBlue, number startColourRangeAlpha, number endColourRangeRed, number endColourRangeGreen, number endColourRangeBlue, number endColourRangeAlpha, number dirX, number dirY, number dirZ, number emissionRate, number posX, number posY, number posZ, number velocityMin, number velocityMax, number timeToLiveMin, number timeToLiveMax, number durationMin, number durationMax, number repeatDelayMin, number repeatDelayMax, number width, number height, number depth, number sizeInnerRingWidth, number sizeInnerRingHeight)
`nil`	`setEmitterRingInnerSize (number index, number sizeInnerRingWidth, number sizeInnerRingHeight)`
`nil`	`setEmitterSize (number index, number width, number height, number depth)`
`nil`	`setEmitterVelocityRange (number index, number velocityMin, number velocityMax)`
`nil`	`setInterval (number interval)`
`nil`	`setLocalSpace (boolean localSpace)`
`nil`	`setMaterial (string material)`
`nil`	`setParticleSize (number w, number h)`
`nil`	`setPointRendering (boolean pointRendering)`
`nil`	`setPosition (number x, number y, number z)`
`nil`	`setQuota (number quota)`
`nil`	`setSorted (boolean sorted)`
`nil`	`setTimeout (number timeout)`
`nil`	`setUpVector (number x, number y, number z)`
`nil`	`setVisible (boolean visible)`

Method Detail

getBillboardRendererRotationType

number getBillboardRendererRotationType ()

Gets the billboard renderer rotation type of the effect.

Returns:: number - rotationType Type of billboard renderer rotation. It can be PR_BILLBOARD_ROTATION_VERTEX (default) or PR_BILLBOARD_ROTATION_TEXCOORD.

getBillboardRendererType

number getBillboardRendererType ()

Gets the type of billboard renderer of the effect.

Returns:: number - billboardRenderer Type of billboard renderer. It can be PR_BILLBOARD_POINT, PR_BILLBOARD_POINT, PR_BILLBOARD_ORIENTED_SELF, PR_BILLBOARD_PERPENDICULAR_COMMON or PR_PERPENDICULAR_SELF.

getDirection

nil getDirection (number x, number y, number z)

Gets the direction of the effect.

Parameters:: number x - X direction coordinate.; number y - Y direction coordinate.; number z - Z direction coordinate.

getEmitterAngle

number getEmitterAngle (number index)

Gets the maximum angle (in degrees) which emitted particles may deviate from the direction (see setEmitterDirection) of the emitter. A value of 180 means emit in any direction, whilst 0 means emit always exactly in the direction of the emitter.

Parameters:: number index - Index of the emitter to change.

Returns:: number - angle Maximum angle (in degrees) which emitted particles may deviate from the direction of the emitter (see setEmitterAngle).

getEmitterColourRange

number, number, number, number, number, number, number, number getEmitterColourRange (number index)

Gets the range of colours available to emitted particles. The actual colour will be randomly chosen between the start colour and end colour values.

Parameters:: number index - Index of the emitter to change.

Returns:: number - startColourRangeRed Red value of the colour range start, between 0 and 255.; number - startColourRangeGreen Green value of the colour range start, between 0 and 255.; number - startColourRangeBlue Blue value of the colour range start, between 0 and 255.; number - startColourRangeAlpha Alpha value of the colour range start, between 0 and 255.; number - endColourRangeRed Red value of the colour range end, between 0 and 255.; number - endColourRangeGreen Green value of the colour range end, between 0 and 255.; number - endColourRangeBlue Blue value of the colour range end, between 0 and 255.; number - endColourRangeAlpha Alpha value of the colour range end, between 0 and 255.

getEmitterDelayRange

number, number getEmitterDelayRange (number index)

Sets the number of seconds to wait before the emission is repeated when stopped by a limited duration (see setEmitterDurationRange). Each time the emitter is started it gets a random value within this range.

Parameters:: number index - Index of the emitter to change.

Returns:: number - repeatDelayMin Minimum number of seconds to wait before the emission is repeated when stopped by a limited duration.; number - repeatDelayMax Maximum number of seconds to wait before the emission is repeated when stopped by a limited duration.

getEmitterDirection

number, number, number getEmitterDirection (number index)

Gets the direction of the emitter. This is relative to the direction of the effect.

Parameters:: number index - Index of the emitter to change.

Returns:: number - dirX X value of the direction vector of the emitter.; number - dirY Y value of the direction vector of the emitter.; number - dirZ Z value of the direction vector of the emitter.

getEmitterDurationRange

number, number getEmitterDurationRange (number index)

Gets the number of seconds the emitter is active. The emitter can be started again (see setEmitterDelayRange). The duration will be set within this range each time the emitter is started.

Parameters:: number index - Index of the emitter to change.

Returns:: number - durationMin Minimum number of seconds the emitter is active. A value of 0 means infinite duration.; number - durationMax Maximum number of seconds the emitter is active. A value of 0 means infinite duration.

getEmitterEmissionRate

number getEmitterEmissionRate (number index)

Gets how many particles per second should be emitted.

Parameters:: number index - Index of the emitter to change.

Returns:: number - emissionRate Number of particles emitted per second.

getEmitterInnerSize

number, number, number getEmitterInnerSize (number index)

Gets the size of the inner hollow ellipsoid. Only valid for hollow ellipsoid emitters.

Parameters:: number index - Index of the emitter to change.

Returns:: number - innerWidth Width value of the hollow.; number - innerHeight Height of the hollow.; number - innerDepth Depth of the hollow.

getEmitterLifeSpan

number, number getEmitterLifeSpan (number index)

Gets the number of seconds each particle will 'live' for before being destroyed. Each particle gets a random time to live within this range.

Parameters:: number index - Index of the emitter to change.

Returns:: number - timeToLiveMin Minimum time a particle will 'live', in seconds.; number - timeToLiveMax Maximum time a particle will 'live', in seconds.

getEmitterPosition

number, number, number getEmitterPosition (number index)

Gets the position of the emitter relative to the effect it is attached to.

Parameters:: number index - Index of the emitter to change.

Returns:: number - posX X value of the relative position of the emitter.; number - posY Y value of the relative position of the emitter.; number - posZ Z value of the relative position of the emitter.

getEmitterRingInnerSize

number, number getEmitterRingInnerSize (number index)

Gets the size of the inner hollow ring. Only valid for ring emitters.

Parameters:: number index - Index of the emitter to change.

Returns:: number - sizeInnerRingWidth Width of the hollow.; number - sizeInnerRingHeight Height of the hollow.

getEmitterSize

number, number, number getEmitterSize (number index)

Gets the size of the emitter. Not valid for point emitters..

Parameters:: number index - Index of the emitter to change.

Returns:: number - width Width of the emitter.; number - height Height of the emitter.; number - depth Depth of the emitter.

getEmitterType

number getEmitterType (number index)

Gets the type of the emitter.

Parameters:: number index - Index of the emitter.

Returns:: number - type Type of the emitter. Point=1, box=2, cylinder=3, ellipsoid=3, hollow ellipsoid=4, ring=5.

getEmitterVelocityRange

number, number getEmitterVelocityRange (number index)

Gets the velocity of the particles. Each particle is emitted with a random velocity within this range.

Parameters:: number index - Index of the emitter to change.

Returns:: number - velocityMin Minimum velocity each particle will be emitted, in world units per second.; number - velocityMax Maximum velocity each particle will be emitted, in world units per second.

getID

string getID ()

Returns the representation ID.

Returns:: string - Representation ID.

getInterval

number getInterval ()

Gets the time interval between each particle, in seconds.

Returns:: number - Time interval between each particle, in seconds.

getMaterial

string getMaterial ()

Gets the material name of the effect.

Returns:: string - Material name.

getParticleSize

number, number getParticleSize ()

Returns the size of the particles.

Returns:: number - w Width of the particles.; number - h Height of the particles.

getPosition

number, number, number getPosition ()

Returns the position of the Effect.

Returns:: number - The position of the Effect in the X coordinate.; number - The position of the Effect in the Y coordinate.; number - The position of the Effect in the Z coordinate.

getQuota

number getQuota ()

Gets the maximum number of particles that may exist simultaneously.

Returns:: number - Maximum number of particles that may exist simultaneously.

getTimeout

number getTimeout ()

Gets the timeout to stop updating the effect after it is no longer visible. Setting the value to 0 will deactivate the timeout.

Returns:: number - Timeout to stop updating the effect after it is no longer visible.

getType

number getType ()

Returns the representation type:
2 - MODEL,
3 - LIGHT,
4 - EFFECT,
5 - PLANE,
6 - WATER,
7 - SOUND,
8 - TERRAIN_MESH_DECAL,
9 - TERRAIN_HIGHLIGHTING_DECAL,
10 - BILLBOARD,
11 - OVERLAY

Returns:: number - The type of the representation.

getUpVector

nil getUpVector (number x, number y, number z)

Gets the direction of the up vector of the effect.

Parameters:: number x - X direction coordinate.; number y - Y direction coordinate.; number z - Z direction coordinate.

isAccurateFacing

boolean isAccurateFacing ()

Returns whether each particle is constantly facing the camera.

Returns:: boolean - facing Whether each particle is constantly facing the camera.

isCullEach

boolean isCullEach ()

Returns whether the effect culls each particle individually or not.

Returns:: boolean - Whether the effect culls each particle or not.

isLocalSpace

boolean isLocalSpace ()

Returns whether the particles' position is attached to the emitter.

Returns:: boolean - sorted Whether the particles' position is attached to the emitter.

isPointRendering

boolean isPointRendering ()

Returns whether the effect uses point rendering.

Returns:: boolean - pointRendering Whether the effect uses point rendering.

isSorted

boolean isSorted ()

Returns whether the effect sorts the particle or not.

Returns:: boolean - sorted Whether the effect sorts the particle or not.

isVisible

boolean isVisible ()

Returns 'true' if the representation is visible, 'false' otherwise.

Returns:: boolean - Whether the Effect is visible or not.

print

nil print ()

Prints the Effect data and attributes to the console.

removeAffector

nil removeAffector (number index)

Removes an affector from the effect.

Parameters:: number index - Index of the emitter to delete.

removeAllAffectors

nil removeAllAffectors ()

Removes all affectors from the effect.

removeAllEmitters

nil removeAllEmitters ()

Removes all emitters from the effect.

removeEmitter

nil removeEmitter (number index)

Removes an emitter from the effect.

Parameters:: number index - Index of the emitter to delete.

setAccurateFacing

nil setAccurateFacing (boolean facing)

Sets whether each particle is constantly facing the camera. The extra calculations degrade the effect's performance.

Parameters:: boolean facing - Whether each particle is constantly facing the camera.

setAffectorColourFader

nil setAffectorColourFader (number index)

Adds or changes a colour fader affector to the effect with the default parameters: red=0, green=0, blue=0 and alpha=0. This affector modifies the colour of particles in flight.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.

setAffectorColourFader

nil setAffectorColourFader (number index, number red, number green, number blue, number alpha)

Adds or changes a colour fader affector to the effect. This affector modifies the colour of particles in flight.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.; number red - Red value of the colour, between 0 and 255.; number green - Green value of the colour, between 0 and 255.; number blue - Blue value of the colour, between 0 and 255.; number alpha - Alpha value of the colour, between 0 and 255.

setAffectorColourFader2

nil setAffectorColourFader2 (number index)

Adds or changes a colour fader affector to the effect with the default parameters: red=0, green=0, blue=0, alpha=0 and state change=1. This affector modifies the colour of particles in flight.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.

setAffectorColourFader2

nil setAffectorColourFader2 (number index, number red1, number green1, number blue1, number alpha1, number red2, number green2, number blue2, number alpha2, number stateChange)

Adds or changes an affector with two colour faders to the effect. This affector modifies the colour of particles in flight. It introduces two states of colour changes as opposed to just one. The second colour change state is activated once a specified amount of time remains in the particles life.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.; number red1 - Red value of the first fade colour, between 0 and 255.; number green1 - Green value of the first fade colour, between 0 and 255.; number blue1 - Blue value of the first fade colour, between 0 and 255.; number alpha1 - Alpha value of the first fade colour, between 0 and 255.; number red2 - Red value of the second fade colour, between 0 and 255.; number green2 - Green value of the second fade colour, between 0 and 255.; number blue2 - Blue value of the second fade colour, between 0 and 255.; number alpha2 - Alpha value of the second fade colour, between 0 and 255.; number stateChange - Remaing time of life of a particle after which the particle will start fading to the second colour (in seconds).

setAffectorColourImage

nil setAffectorColourImage (number index, mediaItemKey image)

Adds or changes an image colour affector to the effect. This affector that modifies the colour of particles in flight, where the colours are taken from a specified image MediaItem. The range of colour values begins from the left side of the image and move to the right over the lifetime of the particle, therefore only the horizontal dimension of the image is used.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.; mediaItemKey image - Image that defines the colours of the particles in flight. The range of colour values begins from the left side of the image and move to the right over the lifetime of the particle, therefore only the horizontal dimension of the image is used.

setAffectorColourInterpolator

nil setAffectorColourInterpolator (number index)

Adds or changes a colour fader affector to the effect with the default parameters. This affector modifies the colour of particles in flight through six defined stages.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.

setAffectorColourInterpolator

nil setAffectorColourInterpolator (number index, number red1, number green1, number blue1, number alpha1, number time1, number red2, number green2, number blue2, number alpha2, number time2, number red3, number green3, number blue3, number alpha3, number time3, number red4, number green4, number blue4, number alpha4, number time4, number red5, number green5, number blue5, number alpha5, number time5, number red6, number green6, number blue6, number alpha6, number time6)

Adds or changes a colour fader affector to the effect with the default parameters. This affector modifies the colour of particles in flight through six defined stages.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.; number red1 - Red value of the first fade colour, between 0 and 255.; number green1 - Green value of the first fade colour, between 0 and 255.; number blue1 - Blue value of the first fade colour, between 0 and 255.; number alpha1 - Alpha value of the first fade colour, between 0 and 255.; number time1 - Duration of the first stage, in seconds.; number red2 - Red value of the first second colour, between 0 and 255.; number green2 - Green value of the second fade colour, between 0 and 255.; number blue2 - Blue value of the second fade colour, between 0 and 255.; number alpha2 - Alpha value of the second fade colour, between 0 and 255.; number time2 - Duration of the second stage, in seconds.; number red3 - Red value of the third second colour, between 0 and 255.; number green3 - Green value of the third fade colour, between 0 and 255.; number blue3 - Blue value of the third fade colour, between 0 and 255.; number alpha3 - Alpha value of the third fade colour, between 0 and 255.; number time3 - Duration of the third stage, in seconds.; number red4 - Red value of the first forth colour, between 0 and 255.; number green4 - Green value of the forth fade colour, between 0 and 255.; number blue4 - Blue value of the forth fade colour, between 0 and 255.; number alpha4 - Alpha value of the forth fade colour, between 0 and 255.; number time4 - Duration of the forth stage, in seconds.; number red5 - Red value of the fifth forth colour, between 0 and 255.; number green5 - Green value of the fifth fade colour, between 0 and 255.; number blue5 - Blue value of the fifth fade colour, between 0 and 255.; number alpha5 - Alpha value of the fifth fade colour, between 0 and 255.; number time5 - Duration of the fifth stage, in seconds.; number red6 - Red value of the sixth forth colour, between 0 and 255.; number green6 - Green value of the sixth fade colour, between 0 and 255.; number blue6 - Blue value of the sixth fade colour, between 0 and 255.; number alpha6 - Alpha value of the sixth fade colour, between 0 and 255.; number time6 - Duration of the sixth stage, in seconds.

setAffectorDeflectorPlane

nil setAffectorDeflectorPlane (number index)

Adds or changes a deflector plane affector to the effect with the default values. This affector defines a plane which deflects particles that collide with it.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.

setAffectorDeflectorPlane

nil setAffectorDeflectorPlane (number index, number pX, number pY, number pZ, number nX, number nY, number nZ, number bounce)

Adds or changes a deflector plane affector to the effect. The point and normal vector define a plane which deflects particles that collide with it.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.; number pX - X coordinate of a point on the deflector plane.; number pY - Y coordinate of a point on the deflector plane.; number pZ - Z coordinate of a point on the deflector plane.; number nX - X value of the normal vector of the deflector plane.; number nY - Y value of the normal vector of the deflector plane.; number nZ - Z value of the normal vector of the deflector plane.; number bounce - The amount of bouncing when a particle is deflected. 0 means no deflection and 1 stands for 100 percent reflection.

setAffectorLinearForce

nil setAffectorLinearForce (number index)

Adds or changes a linear force affector to the effect with the default parameters: force vector = 0,-100,0 and average = false. This affector applies a force vector to all particles to modify their trajectory. Can be used for gravity, wind, or any other linear force.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.

setAffectorLinearForce

nil setAffectorLinearForce (number index, number fX, number fY, number fZ, boolean average)

Adds or changes a linear force affector to the effect. This affector applies a force vector to all particles to modify their trajectory. Can be used for gravity, wind, or any other linear force.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.; number fX - X value of the force vector of the affector.; number fY - Y value of the force vector of the affector.; number fZ - Z value of the force vector of the affector.; boolean average - Whether the resulting momentum is the average of the force vector and the particle's current motion. Is self-stabilising but the speed at which the particle changes direction is non-linear.

setAffectorRandomiser

nil setAffectorRandomiser (number index)

Adds or changes a randomiser affector to the effect with the default values. This affector applies randomness to the movement of the particles.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.

setAffectorRandomiser

nil setAffectorRandomiser (number index, number variation, number scope, boolean keepVelocity)

Adds or changes a randomiser affector to the effect with the default values. This affector applies randomness to the movement of the particles.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.; number variation - The amount of randomness to introduce in each axial direction, in degrees.; number scope - The percentage of particles affected in each run of the affector.; boolean keepVelocity - Whether the velocity of particles is unchanged.

setAffectorRotator

nil setAffectorRotator (number index)

Adds or changes a rotator affector to the effect with the all set to 0. This affector rotates the particles in flight.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.

setAffectorRotator

nil setAffectorRotator (number index, number rotationStart, number rotationEnd, number speedStart, number speedEnd)

Adds or changes a rotator affector to the effect. This affector rotates the particles in flight.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.; number rotationStart - The start of a range of rotation angles to be assigned to emitted particles (in degrees).; number rotationEnd - The end of a range of rotation angles to be assigned to emitted particles (in degrees).; number speedStart - The start of a range of rotation speeds to be assigned to emitted particles (in degrees per second).; number speedEnd - The end of a range of rotation speeds to be assigned to emitted particles (in degrees per second).

setAffectorScaler

nil setAffectorScaler (number index)

Adds or changes a scaler affector to the effect with the default scale rate of 0. This affector scales particles in flight.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.

setAffectorScaler

nil setAffectorScaler (number index, number rate)

Adds or changes a scaler affector to the effect. This affector scales particles in flight.

Parameters:: number index - Index of the affector. This index is the identifier of the affector. It must be a value between 0 and 39.; number rate - The amount by which to scale the particles in both the x and y direction per second.

setBillboardRendererRotationType

nil setBillboardRendererRotationType (number rotationType)

Sets the billboard renderer rotation type of the effect.

Parameters:: number rotationType - Type of billboard renderer rotation. It can be PR_BILLBOARD_ROTATION_VERTEX (default) or PR_BILLBOARD_ROTATION_TEXCOORD.

setBillboardRendererType

nil setBillboardRendererType (number billboardRenderer)

Sets the type of billboard renderer type of the effect.

Parameters:: number billboardRenderer - Type of billboard renderer. It can be PR_BILLBOARD_POINT (default), PR_BILLBOARD_POINT, PR_BILLBOARD_ORIENTED_SELF, PR_BILLBOARD_PERPENDICULAR_COMMON or PR_PERPENDICULAR_SELF.

setCullEach

nil setCullEach (boolean cullEach)

Sets whether the effect culls each particle individually or not. Set this to true when it's most likely that only part of the particles are actually visible (e.g. rain). In most cases, it's far more efficient to cull them together, (e.g. candle fires).

Parameters:: boolean cullEach - Whether the effect culls each particle or not.

setDirection

nil setDirection (number x, number y, number z)

Sets the direction of the effect.

Parameters:: number x - X direction coordinate.; number y - Y direction coordinate.; number z - Z direction coordinate.

setEmitterAngle

nil setEmitterAngle (number index, number angle)

Sets the maximum angle (in degrees) which emitted particles may deviate from the direction (see setEmitterDirection) of the emitter. A value of 180 means emit in any direction, whilst 0 means emit always exactly in the direction of the emitter.

Parameters:: number index - Index of the emitter to change.; number angle - Maximum angle (in degrees) which emitted particles may deviate from the direction of the emitter (see setEmitterAngle).

setEmitterBox

nil setEmitterBox (number index)

Adds or changes a box emitter to the effect. Every parameter will be set to default. This emitter emits particles from a random location within a 3-dimensional box.

Parameters:: number index - Index of the emitter. This index is the identifier of the emitter. It must be a value between 0 and 39.

setEmitterBox

nil setEmitterBox (number index, number angle, number startColourRangeRed, number startColourRangeGreen, number startColourRangeBlue, number startColourRangeAlpha, number endColourRangeRed, number endColourRangeGreen, number endColourRangeBlue, number endColourRangeAlpha, number dirX, number dirY, number dirZ, number emissionRate, number posX, number posY, number posZ, number velocityMin, number velocityMax, number timeToLiveMin, number timeToLiveMax, number durationMin, number durationMax, number repeatDelayMin, number repeatDelayMax, number width, number height, number depth)

Adds or changes a box emitter to the effect. This emitter emits particles from a random location within a 3-dimensional box.

Parameters:: number index - Index of the emitter. This index is the identifier of the emitter. It must be a value between 0 and 39.; number angle - Maximum angle (in degrees) which emitted particles may deviate from the direction of the emitter (see setEmitterAngle).A value of 180 means emit in any direction, whilst 0 means emit always exactly in the direction of the emitter.; number startColourRangeRed - Red value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeGreen - Green value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeBlue - Blue value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeAlpha - Alpha value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number endColourRangeRed - Red value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeGreen - Green value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeBlue - Blue value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeAlpha - Alpha value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number dirX - X value of the direction vector of the emitter (see setEmitterDirection).; number dirY - Y value of the direction vector of the emitter (see setEmitterDirection).; number dirZ - Z value of the direction vector of the emitter (see setEmitterDirection).; number emissionRate - Number of particles emitted per second (see setEmitterEmissioRate).; number posX - X value of the relative position of the emitter (see setEmitterPosition).; number posY - Y value of the relative position of the emitter (see setEmitterPosition).; number posZ - Z value of the relative position of the emitter (see setEmitterPosition).; number velocityMin - Minimum velocity each particle will be emitted, in world units per second (see setEmitterVelocityRange).; number velocityMax - Maximum velocity each particle will be emitted, in world units per second (see setEmitterVelocityRange).; number timeToLiveMin - Minimum time a particle will 'live', in seconds (see setEmitterTimeToLiveRange).; number timeToLiveMax - Maximum time a particle will 'live', in seconds (see setEmitterTimeToLiveRange).; number durationMin - Minimum number of seconds the emitter is active (see setEmitterDurationRange). A value of 0 means infinite duration.; number durationMax - Maximum number of seconds the emitter is active (see setEmitterDurationRange). A value of 0 means infinite duration.; number repeatDelayMin - Minimum number of seconds to wait before the emission is repeated when stopped by a limited duration (see setEmitterDelayRange).; number repeatDelayMax - Maximum number of seconds to wait before the emission is repeated when stopped by a limited duration (see setEmitterDelayRange).; number width - Width of the box (see setEmitterSize).; number height - Height of the box (see setEmitterSize).; number depth - Depth of the box (see setEmitterSize).

setEmitterColourRange

nil setEmitterColourRange (number index, number startColourRangeRed, number startColourRangeGreen, number startColourRangeBlue, number startColourRangeAlpha, number endColourRangeRed, number endColourRangeGreen, number endColourRangeBlue, number endColourRangeAlpha)

Sets the range of colours available to emitted particles. The actual colour will be randomly chosen between the start colour and end colour values.

Parameters:: number index - Index of the emitter to change.; number startColourRangeRed - Red value of the colour range start, between 0 and 255.; number startColourRangeGreen - Green value of the colour range start, between 0 and 255.; number startColourRangeBlue - Blue value of the colour range start, between 0 and 255.; number startColourRangeAlpha - Alpha value of the colour range start, between 0 and 255.; number endColourRangeRed - Red value of the colour range end, between 0 and 255.; number endColourRangeGreen - Green value of the colour range end, between 0 and 255.; number endColourRangeBlue - Blue value of the colour range end, between 0 and 255.; number endColourRangeAlpha - Alpha value of the colour range end, between 0 and 255.

setEmitterCylinder

nil setEmitterCylinder (number index)

Adds or changes a cylinder emitter to the effect. Every parameter will be set to default. This emitter emits particles from a random location within a 3-dimensional box.

Parameters:: number index - Index of the emitter. This index is the identifier of the emitter. It must be a value between 0 and 39.

setEmitterCylinder

nil setEmitterCylinder (number index, number angle, number startColourRangeRed, number startColourRangeGreen, number startColourRangeBlue, number startColourRangeAlpha, number endColourRangeRed, number endColourRangeGreen, number endColourRangeBlue, number endColourRangeAlpha, number dirX, number dirY, number dirZ, number emissionRate, number posX, number posY, number posZ, number velocityMin, number velocityMax, number timeToLiveMin, number timeToLiveMax, number durationMin, number durationMax, number repeatDelayMin, number repeatDelayMax, number width, number height, number depth)

Adds or changes a box emitter to the effect. This emitter emits particles from a random location within a 3-dimensional cylinder oriented along the Z-axis.

Parameters:: number index - Index of the emitter. This index is the identifier of the emitter. It must be a value between 0 and 39.; number angle - Maximum angle (in degrees) which emitted particles may deviate from the direction of the emitter (see setEmitterAngle).A value of 180 means emit in any direction, whilst 0 means emit always exactly in the direction of the emitter.; number startColourRangeRed - Red value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeGreen - Green value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeBlue - Blue value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeAlpha - Alpha value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number endColourRangeRed - Red value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeGreen - Green value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeBlue - Blue value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeAlpha - Alpha value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number dirX - X value of the direction vector of the emitter (see setEmitterDirection).; number dirY - Y value of the direction vector of the emitter (see setEmitterDirection).; number dirZ - Z value of the direction vector of the emitter (see setEmitterDirection).; number emissionRate - Number of particles emitted per second (see setEmitterEmissioRate).; number posX - X value of the relative position of the emitter (see setEmitterPosition).; number posY - Y value of the relative position of the emitter (see setEmitterPosition).; number posZ - Z value of the relative position of the emitter (see setEmitterPosition).; number velocityMin - Minimum velocity each particle will be emitted, in world units per second (see setEmitterVelocityRange).; number velocityMax - Maximum velocity each particle will be emitted, in world units per second (see setEmitterVelocityRange).; number timeToLiveMin - Minimum time a particle will 'live', in seconds (see setEmitterTimeToLiveRange).; number timeToLiveMax - Maximum time a particle will 'live', in seconds (see setEmitterTimeToLiveRange).; number durationMin - Minimum number of seconds the emitter is active (see setEmitterDurationRange). A value of 0 means infinite duration.; number durationMax - Maximum number of seconds the emitter is active (see setEmitterDurationRange). A value of 0 means infinite duration.; number repeatDelayMin - Minimum number of seconds to wait before the emission is repeated when stopped by a limited duration (see setEmitterDelayRange).; number repeatDelayMax - Maximum number of seconds to wait before the emission is repeated when stopped by a limited duration (see setEmitterDelayRange).; number width - Width of the cylinder (see setEmitterSize).; number height - Height of the cylinder (see setEmitterSize).; number depth - Depth of the cylinder (see setEmitterSize).

setEmitterDelayRange

nil setEmitterDelayRange (number index, number repeatDelayMin, number repeatDelayMax)

Parameters:: number index - Index of the emitter to change.; number repeatDelayMin - Minimum number of seconds to wait before the emission is repeated when stopped by a limited duration.; number repeatDelayMax - Maximum number of seconds to wait before the emission is repeated when stopped by a limited duration.

setEmitterDirection

nil setEmitterDirection (number index, number dirX, number dirY, number dirZ)

Sets the direction of the emitter. This is relative to the direction of the effect.

Parameters:: number index - Index of the emitter to change.; number dirX - X value of the direction vector of the emitter.; number dirY - Y value of the direction vector of the emitter.; number dirZ - Z value of the direction vector of the emitter.

setEmitterDurationRange

nil setEmitterDurationRange (number index, number durationMin, number durationMax)

Sets the number of seconds the emitter is active. The emitter can be started again (see setEmitterDelayRange). The duration will be set within this range each time the emitter is started.

Parameters:: number index - Index of the emitter to change.; number durationMin - Minimum number of seconds the emitter is active. A value of 0 means infinite duration.; number durationMax - Maximum number of seconds the emitter is active. A value of 0 means infinite duration.

setEmitterEllipsoid

nil setEmitterEllipsoid (number index)

Adds or changes an ellipsoid emitter to the effect. Every parameter will be set to default. This emitter emits particles from a random location within a 3-dimensional ellipsoid (or sphere).

Parameters:: number index - Index of the emitter. This index is the identifier of the emitter. It must be a value between 0 and 39.

setEmitterEllipsoid

nil setEmitterEllipsoid (number index, number angle, number startColourRangeRed, number startColourRangeGreen, number startColourRangeBlue, number startColourRangeAlpha, number endColourRangeRed, number endColourRangeGreen, number endColourRangeBlue, number endColourRangeAlpha, number dirX, number dirY, number dirZ, number emissionRate, number posX, number posY, number posZ, number velocityMin, number velocityMax, number timeToLiveMin, number timeToLiveMax, number durationMin, number durationMax, number repeatDelayMin, number repeatDelayMax, number width, number height, number depth)

Adds or changes an ellipsoid emitter to the effect. This emitter emits particles from a random location within a 3-dimensional ellipsoid (or sphere).

Parameters:: number index - Index of the emitter. This index is the identifier of the emitter. It must be a value between 0 and 39.; number angle - Maximum angle (in degrees) which emitted particles may deviate from the direction of the emitter (see setEmitterAngle).A value of 180 means emit in any direction, whilst 0 means emit always exactly in the direction of the emitter.; number startColourRangeRed - Red value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeGreen - Green value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeBlue - Blue value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeAlpha - Alpha value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number endColourRangeRed - Red value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeGreen - Green value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeBlue - Blue value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeAlpha - Alpha value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number dirX - X value of the direction vector of the emitter (see setEmitterDirection).; number dirY - Y value of the direction vector of the emitter (see setEmitterDirection).; number dirZ - Z value of the direction vector of the emitter (see setEmitterDirection).; number emissionRate - Number of particles emitted per second (see setEmitterEmissionRate).; number posX - X value of the relative position of the emitter (see setEmitterPosition).; number posY - Y value of the relative position of the emitter (see setEmitterPosition).; number posZ - Z value of the relative position of the emitter (see setEmitterPosition).; number velocityMin - Minimum velocity each particle will be emitted, in world units per second (see setEmitterVelocityRange).; number velocityMax - Maximum velocity each particle will be emitted, in world units per second (see setEmitterVelocityRange).; number timeToLiveMin - Minimum time a particle will 'live', in seconds (see setEmitterTimeToLiveRange).; number timeToLiveMax - Maximum time a particle will 'live', in seconds (see setEmitterTimeToLiveRange).; number durationMin - Minimum number of seconds the emitter is active (see setEmitterDurationRange). A value of 0 means infinite duration.; number durationMax - Maximum number of seconds the emitter is active (see setEmitterDurationRange). A value of 0 means infinite duration.; number repeatDelayMin - Minimum number of seconds to wait before the emission is repeated when stopped by a limited duration (see setEmitterDelayRange).; number repeatDelayMax - Maximum number of seconds to wait before the emission is repeated when stopped by a limited duration (see setEmitterDelayRange).; number width - Width of the ellipsoid (see setEmitterSize).; number height - Height of the ellipsoid (see setEmitterSize).; number depth - Depth of the ellipsoid (see setEmitterSize).

setEmitterEmissionRate

nil setEmitterEmissionRate (number index, number emissionRate)

Sets how many particles per second should be emitted.

Parameters:: number index - Index of the emitter to change.; number emissionRate - Number of particles emitted per second.

setEmitterHollowEllipsoid

nil setEmitterHollowEllipsoid (number index)

Adds or changes a hollow ellipsoid emitter to the effect. Every parameter will be set to default. This emitter is just like the Ellipsoid Emitter except that there is a hollow area in the centre of the ellipsoid from which no particles are emitted.

Parameters:: number index - Index of the emitter. This index is the identifier of the emitter. It must be a value between 0 and 39.

setEmitterHollowEllipsoid

nil setEmitterHollowEllipsoid (number index, number angle, number startColourRangeRed, number startColourRangeGreen, number startColourRangeBlue, number startColourRangeAlpha, number endColourRangeRed, number endColourRangeGreen, number endColourRangeBlue, number endColourRangeAlpha, number dirX, number dirY, number dirZ, number emissionRate, number posX, number posY, number posZ, number velocityMin, number velocityMax, number timeToLiveMin, number timeToLiveMax, number durationMin, number durationMax, number repeatDelayMin, number repeatDelayMax, number width, number height, number depth, number innerWidth, number innerHeight, number innerDepth)

Adds or changes a hollow ellipsoid emitter to the effect. This emitter is just like the ellipsoid emitter except that there is a hollow inner area in the centre of the ellipsoid from which no particles are emitted.

Parameters:: number index - Index of the emitter. This index is the identifier of the emitter. It must be a value between 0 and 39.; number angle - Maximum angle (in degrees) which emitted particles may deviate from the direction of the emitter (see setEmitterAngle).A value of 180 means emit in any direction, whilst 0 means emit always exactly in the direction of the emitter.; number startColourRangeRed - Red value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeGreen - Green value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeBlue - Blue value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeAlpha - Alpha value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number endColourRangeRed - Red value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeGreen - Green value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeBlue - Blue value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeAlpha - Alpha value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number dirX - X value of the direction vector of the emitter (see setEmitterDirection).; number dirY - Y value of the direction vector of the emitter (see setEmitterDirection).; number dirZ - Z value of the direction vector of the emitter (see setEmitterDirection).; number emissionRate - Number of particles emitted per second (see setEmitterEmissioRate).; number posX - X value of the relative position of the emitter (see setEmitterPosition).; number posY - Y value of the relative position of the emitter (see setEmitterPosition).; number posZ - Z value of the relative position of the emitter (see setEmitterPosition).; number velocityMin - Minimum velocity each particle will be emitted, in world units per second (see setEmitterVelocityRange).; number velocityMax - Maximum velocity each particle will be emitted, in world units per second (see setEmitterVelocityRange).; number timeToLiveMin - Minimum time a particle will 'live', in seconds (see setEmitterTimeToLiveRange).; number timeToLiveMax - Maximum time a particle will 'live', in seconds (see setEmitterTimeToLiveRange).; number durationMin - Minimum number of seconds the emitter is active (see setEmitterDurationRange). A value of 0 means infinite duration.; number durationMax - Maximum number of seconds the emitter is active (see setEmitterDurationRange). A value of 0 means infinite duration.; number repeatDelayMin - Minimum number of seconds to wait before the emission is repeated when stopped by a limited duration (see setEmitterDelayRange).; number repeatDelayMax - Maximum number of seconds to wait before the emission is repeated when stopped by a limited duration (see setEmitterDelayRange).; number width - Width of the ellipsoid (see setEmitterSize).; number height - Height of the ellipsoid size (see setEmitterSize).; number depth - Depth of the ellipsoid size (see setEmitterSize).; number innerWidth - Width value of the hollow (see setEmitterInnerSize).; number innerHeight - Height of the hollow (see setEmitterInnerSize).; number innerDepth - Depth of the hollow (see setEmitterInnerSize).

setEmitterInnerSize

nil setEmitterInnerSize (number index, number innerWidth, number innerHeight, number innerDepth)

Sets the size of the emitter inner hollow of the emitter. Only valid for hollow ellipsoid emitters.

Parameters:: number index - Index of the emitter to change.; number innerWidth - Width value of the hollow.; number innerHeight - Height of the hollow.; number innerDepth - Depth of the hollow.

setEmitterLifeSpan

nil setEmitterLifeSpan (number index, number timeToLiveMin, number timeToLiveMax)

Sets the number of seconds each particle will 'live' for before being destroyed. Each particle gets a random time to live within this range.

Parameters:: number index - Index of the emitter to change.; number timeToLiveMin - Minimum time a particle will 'live', in seconds.; number timeToLiveMax - Maximum time a particle will 'live', in seconds.

setEmitterPoint

nil setEmitterPoint (number index)

Adds or changes a point emitter to the effect. Every parameter will be set to default.

Parameters:: number index - Index of the emitter. This index is the identifier of the emitter. It must be a value between 0 and 39.

setEmitterPoint

nil setEmitterPoint (number index, number angle, number startColourRangeRed, number startColourRangeGreen, number startColourRangeBlue, number startColourRangeAlpha, number endColourRangeRed, number endColourRangeGreen, number endColourRangeBlue, number endColourRangeAlpha, number dirX, number dirY, number dirZ, number emissionRate, number posX, number posY, number posZ, number velocityMin, number velocityMax, number timeToLiveMin, number timeToLiveMax, number durationMin, number durationMax, number repeatDelayMin, number repeatDelayMax)

Adds or changes a point emitter to the effect.

Parameters:: number index - Index of the emitter. This index is the identifier of the emitter. It must be a value between 0 and 39.; number angle - Maximum angle (in degrees) which emitted particles may deviate from the direction of the emitter (see setEmitterAngle).A value of 180 means emit in any direction, whilst 0 means emit always exactly in the direction of the emitter.; number startColourRangeRed - Red value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeGreen - Green value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeBlue - Blue value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeAlpha - Alpha value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number endColourRangeRed - Red value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeGreen - Green value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeBlue - Blue value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeAlpha - Alpha value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number dirX - X value of the direction vector of the emitter (see setEmitterDirection).; number dirY - Y value of the direction vector of the emitter (see setEmitterDirection).; number dirZ - Z value of the direction vector of the emitter (see setEmitterDirection).; number emissionRate - Number of particles emitted per second (see setEmitterEmissioRate).; number posX - X value of the relative position of the emitter (see setEmitterPosition).; number posY - Y value of the relative position of the emitter (see setEmitterPosition).; number posZ - Z value of the relative position of the emitter (see setEmitterPosition).; number velocityMin - Minimum velocity each particle will be emitted, in world units per second (see setEmitterVelocityRange).; number velocityMax - Maximum velocity each particle will be emitted, in world units per second (see setEmitterVelocityRange).; number timeToLiveMin - Minimum time a particle will 'live', in seconds (see setEmitterTimeToLiveRange).; number timeToLiveMax - Maximum time a particle will 'live', in seconds (see setEmitterTimeToLiveRange).; number durationMin - Minimum number of seconds the emitter is active (see setEmitterDurationRange). A value of 0 means infinite duration.; number durationMax - Maximum number of seconds the emitter is active (see setEmitterDurationRange). A value of 0 means infinite duration.; number repeatDelayMin - Minimum number of seconds to wait before the emission is repeated when stopped by a limited duration (see setEmitterDelayRange).; number repeatDelayMax - Maximum number of seconds to wait before the emission is repeated when stopped by a limited duration (see setEmitterDelayRange).

setEmitterPosition

nil setEmitterPosition (number index, number posX, number posY, number posZ)

Sets the position of the emitter relative to the effect it is attached to.

Parameters:: number index - Index of the emitter to change.; number posX - X value of the relative position of the emitter.; number posY - Y value of the relative position of the emitter.; number posZ - Z value of the relative position of the emitter.

setEmitterRing

nil setEmitterRing (number index)

Parameters:: number index - Index of the emitter. This index is the identifier of the emitter. It must be a value between 0 and 39.

setEmitterRing

nil setEmitterRing (number index, number angle, number startColourRangeRed, number startColourRangeGreen, number startColourRangeBlue, number startColourRangeAlpha, number endColourRangeRed, number endColourRangeGreen, number endColourRangeBlue, number endColourRangeAlpha, number dirX, number dirY, number dirZ, number emissionRate, number posX, number posY, number posZ, number velocityMin, number velocityMax, number timeToLiveMin, number timeToLiveMax, number durationMin, number durationMax, number repeatDelayMin, number repeatDelayMax, number width, number height, number depth, number sizeInnerRingWidth, number sizeInnerRingHeight)

Adds or changes a hollow ellipsoid emitter to the effect. This emitter is just like the ellipsoid emitter except that there is a hollow area in the centre of the ellipsoid from which no particles are emitted.

Parameters:: number index - Index of the emitter. This index is the identifier of the emitter. It must be a value between 0 and 39.; number angle - Maximum angle (in degrees) which emitted particles may deviate from the direction of the emitter (see setEmitterAngle).A value of 180 means emit in any direction, whilst 0 means emit always exactly in the direction of the emitter.; number startColourRangeRed - Red value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeGreen - Green value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeBlue - Blue value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number startColourRangeAlpha - Alpha value of the colour range start, between 0 and 255 (see setEmitterColourRange).; number endColourRangeRed - Red value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeGreen - Green value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeBlue - Blue value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number endColourRangeAlpha - Alpha value of the colour range end, between 0 and 255 (see setEmitterColourRange).; number dirX - X value of the direction vector of the emitter (see setEmitterDirection).; number dirY - Y value of the direction vector of the emitter (see setEmitterDirection).; number dirZ - Z value of the direction vector of the emitter (see setEmitterDirection).; number emissionRate - Number of particles emitted per second (see setEmitterEmissioRate).; number posX - X value of the relative position of the emitter (see setEmitterPosition).; number posY - Y value of the relative position of the emitter (see setEmitterPosition).; number posZ - Z value of the relative position of the emitter (see setEmitterPosition).; number velocityMin - Minimum velocity each particle will be emitted, in world units per second (see setEmitterVelocityRange).; number velocityMax - Maximum velocity each particle will be emitted, in world units per second (see setEmitterVelocityRange).; number timeToLiveMin - Minimum time a particle will 'live', in seconds (see setEmitterTimeToLiveRange).; number timeToLiveMax - Maximum time a particle will 'live', in seconds (see setEmitterTimeToLiveRange).; number durationMin - Minimum number of seconds the emitter is active (see setEmitterDurationRange). A value of 0 means infinite duration.; number durationMax - Maximum number of seconds the emitter is active (see setEmitterDurationRange). A value of 0 means infinite duration.; number repeatDelayMin - Minimum number of seconds to wait before the emission is repeated when stopped by a limited duration (see setEmitterDelayRange).; number repeatDelayMax - Maximum number of seconds to wait before the emission is repeated when stopped by a limited duration (see setEmitterDelayRange).; number width - Width of the ring (see setEmitterSize).; number height - Height of the ring (see setEmitterSize).; number depth - Depth value of the ring (see setEmitterSize).; number sizeInnerRingWidth - Width of the hollow (see setEmitterRingInnerSize).; number sizeInnerRingHeight - Height of the hollow (see setEmitterRingInnerSize).

setEmitterRingInnerSize

nil setEmitterRingInnerSize (number index, number sizeInnerRingWidth, number sizeInnerRingHeight)

Sets the size of the inner hollow ring. Only valid for ring emitters.

Parameters:: number index - Index of the emitter to change.; number sizeInnerRingWidth - Width of the hollow.; number sizeInnerRingHeight - Height of the hollow.

setEmitterSize

nil setEmitterSize (number index, number width, number height, number depth)

Sets the size of the emitter. Not valid for point emitters.

Parameters:: number index - Index of the emitter to change.; number width - Width of the emitter.; number height - Height of the emitter.; number depth - Depth of the emitter.

setEmitterVelocityRange

nil setEmitterVelocityRange (number index, number velocityMin, number velocityMax)

Sets the velocity of the particles. Each particle is emitted with a random velocity within this range.

Parameters:: number index - Index of the emitter to change.; number velocityMin - Minimum velocity each particle will be emitted, in world units per second.; number velocityMax - Maximum velocity each particle will be emitted, in world units per second.

setInterval

nil setInterval (number interval)

Sets the time interval between each rentering, in seconds. Setting the value to 0 will render each frame.

Parameters:: number interval - Time interval between each rendering, in seconds.

setLocalSpace

nil setLocalSpace (boolean localSpace)

Sets whether particles' position is attached to the emitter or not. If set to 'true', the particles will follow the emitter, which may be useful in some effects.

Parameters:: boolean localSpace - Whether the particles' position is attached to the emitter.

setMaterial

nil setMaterial (string material)

Defines the material of the effect.

Parameters:: string material - Material name.

setParticleSize

nil setParticleSize (number w, number h)

Sets the size of the particles.

Parameters:: number w - Width of the particles.; number h - Height of the particles.

setPointRendering

nil setPointRendering (boolean pointRendering)

Sets whether the effect uses point rendering. Point rendering may be faster but has some restrictions such as the particles may not rotate or scale independently.

Parameters:: boolean pointRendering - Whether the effect uses point rendering.

setPosition

nil setPosition (number x, number y, number z)

Sets the position of the Effect in the 3D space (x,y,z).

Parameters:: number x - New position in the X axis.; number y - New position in the Y axis.; number z - New position in the Z axis.

setQuota

nil setQuota (number quota)

Sets the maximum number of particles that may exist simultaneously. Warning: After the effect is created, this value cannot be lowered.

Parameters:: number quota - Maximum number of particles that may exist simultaneously.

setSorted

nil setSorted (boolean sorted)

Sets whether the effect sorts the particle or not. If set to 'true', the particles will be sorted with respect to the camera, furthest first. There is a small overhead in sorting the particles, but it may improve some effects.

Parameters:: boolean sorted - Whether the effect sorts the particles or not.

setTimeout

nil setTimeout (number timeout)

Sets the timeout to stop updating the effect after it is no longer visible. Setting the value to 0 will deactivate the timeout.

Parameters:: number timeout - Timeout to stop updating the effect after it is no longer visible.

setUpVector

nil setUpVector (number x, number y, number z)

Sets the direction of the 'up vector' for particle renderers of the type PR_BILLBOARD_PERPENDICULAR_COMMON or PR_PERPENDICULAR_SELF.

Parameters:: number x - X direction coordinate.; number y - Y direction coordinate.; number z - Z direction coordinate.

setVisible

nil setVisible (boolean visible)

Makes the Effect visible or invisible.

Parameters:: boolean visible - Whether the Effect is visible or not.