Main Page   Modules   File List   File Members  

LuaFX.cpp File Reference


Detailed Description

Functions to spawn FX.

System: Scar

>


Functions

size_t FX_PlayEffect (const char *effectName, const char *volumeName, real32 scale)
 Spawns the given effect at the position of the given volume or SOBGroup. Scales the effect by 'scale'. Returns the id of the effect which can be stopped with FX_StopEffect.

size_t FX_PlayEffectBetweenPoints (const char *effectName, const char *volumeName1, const char *volumeName2, real32 scale)
 Spawns the given effect at between the two given points. Scales the effect by 'scale'. Returns the 'handle' of the effect which can be used to stop it.

void FX_StopEffect (size_t index)
 stop the effect previously created by FX_PlayEffectBetweenPoints

udword FX_PlayEffectOnBackground (const char *effectName, vector3 direction, real32 scale)
 Spawns the given effect on the background.

udword FX_PlayEffectOnBackgroundVolume (const char *effectName, const char *volumeName, real32 scale)
 Spawns the given effect on the background, in the direction, with the orientation specified by the volume.

void FX_StopEffectOnBackground (udword handle)
 Stops an effect playing on the background.

void FX_DestroyEffectOnBackground (udword handle)
 Destroy an effect playing on the background.

void FX_StartEvent (const char *sobGroupName, const char *eventName)
 Start playing an effect event.

void FX_StopEvent (const char *sobGroupName, const char *eventName)
 Stop playing an effect event.

void FX_Flush ()
 Flushes all loaded FX. They will be reloaded when played next.

void FX_FlushLod ()
 Flushes all loaded FX lods. They will be reloaded when played next.

void FX_Lights (int maxPriority)
 set the maximum visible light priority. -1 is no lights.


Generated on Fri Oct 31 04:05:39 2003 for Scar by doxygen1.3-rc3