FX

CreateEffectType( string nameNew, string nameBase)
nameNew: name of the new effect type
nameBase: name of effect the new one is derived from

Sound()
Required
Sound which is generated when the FX are triggered.

File(string filename)
Optional(none)
filename: Name of sound file to be played.

Priority(float priority)
Optional(1.0)
priority: Priority of the sound. Higher priority sounds displace lower priority sounds.

MaxDistance(int distance)
Optional(200), Range(1, 1000)
distance: The maximum distance at which this sound can be heard.

MinDistance(int distance)
Optional(1), Range(1, MaxDistance)
distance: The distance at which this sound is at its loudest.

UseOwner(bool owner)
Optional(FALSE)
owner: When set, the owner (map object) of the sound cannot be playing other sounds which also have the UseOwner flag specified. This can to prevent talking out of both sides of ones mouth.

AlwaysHear(bool hear)
Optional(FALSE)
hear: When set, this sound can be heard even if its under the fog/shroud or very far away.

Loop(bool loop)
Optional(FALSE)
loop: When set, this sound will be looped over and over during the duration of the effect.

Particles()
Required
Particles which are generated when the FX are triggered.

Add(int count)
Multiple
count: Number of this type of particle to add.

Particle(string particle)
Required
particle: Name of particle to be generated. (see particle definition).

Destroy(bool flag)
Optional(0)
flag: Can be used to destroy the particle when the FX are destroyed. This is only useful for particles which do not decay (and hence cleanup) themselves.

Delay(float interval)
Optional(0)
interval: Time interval between particles being released. Only applies when particles are being continually released.

DelayVariation(float interval)
Optional(0)
interval: A random amount up to this value will be added to Delay to make continual particle generation more random.

CodeDelay(bool flag)
Optional(0)
flag: Is the delay a factor that gets controled by code (used for boat wakes).

SingleParticle(bool flag)
Optional(0)
flag: If set only a single particle is generated regardless of the delay and delay variation values.

Point(string point)
Optional(none)
point: Hard Point to generated particles from.

VelocityPosition(float x, float y, float z)
Optional(0, 0, 0)
x,y,z: Positional velocity of the particles.

VelocityAngular(float x, float y, float z)
Optional(0, 0, 0)
x,y,z: Rotational velocity of the particles

Random(string type)
Optional("XYZ")
type: "XYZ", "XY", "XZ"; values in VelocityPosition and VelocityAngular are maximums for random generation.
"XYZ" : all components from -max to max.
"XY" : x from -max to max, y from 0 to max, z explict.
"XZ" : x and z from -max to max, y from 0 to max.

RandomVertex(bool flag)
Optional(0)
flag: Should the particle be produced from a randomly choosen vertex on the model

SurfaceSample(string hardpoint)
Optional
hardpoint: Name of the hard point to take the surface sample from.

Surface(string surface)
Multiple
surface: Name of the surface to test for. If the sample hardpoint is over this surface then the FX contained within this scope will be generated. If no sample is matched then the default FX are generated.

MeshEffect()
Optional(null)
Effect on the mesh which is generated when the FX are triggered.

LifeTime( float life)
Required
life: duration of the effect

Base Effects
Color: change the base color of the object
TextureCrossFade: color animate with another texture color animation overlayed
Glow: overlay a color animation
Scale: animate the model's size
Resource: glow with scale

ScaleKey( float key, float scale)
Multiple, Optional(null)
key: active time for this key
scale: scale of the mesh at this key

NoX( bool flag)
Optional(0)
flag: don't scale in X

NoY( bool flag)
Optional(0)
flag: don't scale in Y

NoZ( bool flag)
Optional(0)
flag: don't scale in Z

NoRestore( bool flag)
Optional(0)
flag: don't restore the mesh to its pre-effect state when the effect is done

ColorKey( float key, int r, int g, int b, int a)
Multiple, Optional(null)
key: active time for this key
r: red component of color
g: green component of color
b: blue component of color
a: alpha component of color

ColorKey2( float key, int r, int g, int b, int a)
Multiple, Optional(null)
key: active time for this key
r: red component of color
g: green component of color
b: blue component of color
a: alpha component of color

TextureKey( float key, string name)
Multiple, Optional(null)
key: active time for this key
name: name of the texture file

TextureKey2( float key, string name)
Multiple, Optional(null)
key: active time for this key
name: name of the texture file

TextureListAnim( string name)
Optional(null)
name: base name of a list of animating textures like "name0.bmp", "name1.bmp", etc

TextureAnim( string name)
Multiple, Optional(null)
name: name of a single texture file in an animating list

TextureReduce( int reduce)
Optional(2)
reduce: 0 for no reduction, 1 for some reduction, 2 for full reduction

TextureBlend( string blend)
Optional( srcalpha invsrcalpha modulatealpha)
blend: a string specifing sourceblend destblend and textureblend

AnimRate( float rate)
Optional(1)
rate: how quickly does the texture and color animate