Skyline Lua API  Version 1.0 RC1
Lua Script Reference for Skyline Game Engine.
LUA_API_Particle.h
Go to the documentation of this file.
1 // | _ ____ __ _
2 // | / \ _ _ _ __ __ _/ ___| ___ / _| |_
3 // | / _ \| | | | '__/ _` \___ \ / _ \| |_| __|
4 // | / ___ \ |_| | | | (_| |___) | (_) | _| |_
5 // | /_/ \_\__,_|_| \__,_|____/ \___/|_| \__|
6 // |
7 // | Aurasoft UK 2008 - 2016 http://www.aurasoft.co.uk
8 // |
9 // | Skyline Game Engine Lua API Documentation
10 // |
11 // | This file belongs to Aurasoft UK for the Skyline Game Engine of all versions.
12 // | This file is not for use in any other software that is not owned by Aurasoft UK and cannot be used by any other
13 // | person outside of the Skyline Game Engine development team.
14 // |
15 // | Copyright - Aurasoft UK & Skyline Game Engine 2008 - 2016
16 // |
17 
18 // SKYLINE LUA CLASS FOR API DOCUMENTATION
19 
71 class particle
72 {
73 public:
74 
101  void attach( int particleFX_HND, int EntityID, float x, float y, float z, int flipDirection );
102 
103 
104 
105 
119  void setEffectDuration(int duration);
120 
121 
122 
123 
136  void setEffectName(string name);
137 
138 
139 
140 
157  void setEffectFile(String filename);
158 
159 
160 
161 
179  int createParticleFX();
180 
181 
182 
183 
201  int createSkyParticleFX();
202 
203 
204 
205 
225  int spawnEffect(int particleFX_ID, float posx, float posy, float posz);
226 
227 
228 
229 
230 
254  int spawnSkyParticleEffect(int particleFX_ID, float posx, float posy, float posz);
255 
256 
257 
258 
259 
278  void deleteParticleFX(int particleFX_hnd);
279 
280 
281 
282 
299  void setParticlePosition(int particleFX_ID, float posx, float posy, float posz);
300 
317  void setEmitting(int particleFX_hnd, int state);
318 
319 
334  void setEmitterRate(int particleFX_hnd, int rate);
335 
349  void setParticleSpeed(int particleFX_hnd, float speed);
350 
365  void lookAtObj(int particleFX_ID, int objID);
366 
383  void lookAtPoint(int particleFX_ID, float x,float y,float z);
384 
385 
402  void setScale(int particleFX_ID, float scalex, float scaley, float scalez);
403 
421  void setRotation(int particleFX_ID, float rotw, float rotx, float roty, float rotz);
422 
423 
424 
439  void changeParticleData(int particleFX_ID, string filename);
440 
441 
458  void particle.setRenderOrder(hndl, order);
459 
460 
477  void setVisibleDistance(float distance);
478 
479 
480 
481 
512  int PU_Create();
513 
554  int PU_Run(int PU_ID, float posx, float posy, float posz);
555 
556 
557 
595  PU_Stop(int PU_ID, int fadeoutTime);
596 
597 
631  PU_Pause(int PU_ID, int pauseTime);
632 
633 
634 
644  PU_setRenderOrder(int PU_ID, int order);
645 };
void particle setRenderOrder(hndl, order)
particle.setRenderOrder(hndl, order);
PU_setRenderOrder(int PU_ID, int order)
This function will set the render order of a Particle Universe(PU) effect.
void deleteParticleFX(int particleFX_hnd)
This Function deletes a particle effect with the id of particleFX_ID.
void attach(int particleFX_HND, int EntityID, float x, float y, float z, int flipDirection)
This Function attaches the particle to another object.
void setEmitting(int particleFX_hnd, int state)
Sets whether a particle emitter is emitting particles or not.
void setRotation(int particleFX_ID, float rotw, float rotx, float roty, float rotz)
Set the Rotation of the particle effect whose ID equals particleFX_ID.
void setParticleSpeed(int particleFX_hnd, float speed)
Sets the Speed of the particle effects movements.
void changeParticleData(int particleFX_ID, string filename)
This Function Changes the template data for this sky particle to the data provide in the new file...
void setParticlePosition(int particleFX_ID, float posx, float posy, float posz)
Set the position of the particle effect whose ID equals particleFX_ID.
void setEffectName(string name)
This Function sets the name if the particle effect.
int createParticleFX()
Creates a new Ogre particle effect ready for spawning.
void setEffectDuration(int duration)
This Function sets a particle effects life time duration.
int createSkyParticleFX()
Creates a new SkyParticle effect ready for spawning.
void setEmitterRate(int particleFX_hnd, int rate)
Sets the rate of the particle emitter.
int spawnEffect(int particleFX_ID, float posx, float posy, float posz)
This function will spawn an existing Ogre particle system to the provided position.
int PU_Create()
Creates a new Particle Universe particle effect ready for spawning.
PU_Stop(int PU_ID, int fadeoutTime)
This function will Stop a running Particle Universe(PU) effect..
Definition: LUA_API_Particle.h:71
Definition: LUA_API_States.h:28
void setVisibleDistance(float distance)
Visible distance for the effect.
void lookAtObj(int particleFX_ID, int objID)
Aim the particle rotation towards an object.
void lookAtPoint(int particleFX_ID, float x, float y, float z)
Set the target position of the particle effect whose ID equals particleFX_ID.
int spawnSkyParticleEffect(int particleFX_ID, float posx, float posy, float posz)
This function will spawn an existing SkyParticle effect to the provided position. ...
int PU_Run(int PU_ID, float posx, float posy, float posz)
This function will Run an existing Particle Universe(PU) effect in the provided position.
void setScale(int particleFX_ID, float scalex, float scaley, float scalez)
Set the scale of the particle effect whose ID equals particleFX_ID.
void setEffectFile(String filename)
Set the file name of the particle effect to load.
PU_Pause(int PU_ID, int pauseTime)
This function will Pause a running Particle Universe(PU) effect for the time passed in the arg...