File: |
SimpleParticle.lib |
Version: |
1.0 |
Author: |
Marcus Johansson |
A library for simple particle effects.
Name |
Parameters |
Brief description |
|
procedure |
maxParticles |
Init library. |
|
procedure |
img, cel, addMode, x, y, srcDX#, srcDY#, dstDX#, dstDY#, srcAlpha#, dstAlpha#, speed#, pause |
Add a particle. |
|
procedure |
img, cel, x, y, particleCount, distance#, force#, speed#, addMode, fadeOut |
Add poof effect. |
|
procedure |
img, cel, x, y, particleCount, maxDistance#, maxForce#, maxSpeed#, addMode, fadeOut |
Add random poof effect. |
|
procedure |
ex#, ey# |
Set end vector for poof-generated particles. |
|
procedure |
x, y |
Add a particle with current settings. |
|
procedure |
img, cel, addMode |
Set particle image properties for 'SP_AddParticleAt'. |
|
procedure |
srcDX#, srcDY#, dstDX#, dstDY# |
Set particle directions for 'SP_AddParticleAt'. |
|
procedure |
srcAlpha#, dstAlpha# |
Set particle alpha for 'SP_AddParticleAt'. |
|
procedure |
speed# |
Set parameter speed for 'SP_AddParticleAt'. |
|
procedure |
pause |
Set delay for 'SP_AddParticleAt'. |
|
procedure |
Update all particles. |
||
procedure |
Draw all particles. |
||
procedure |
x, y |
Update all particles with an offset. |
|
procedure |
Update and draw all particles. |
||
procedure |
x, y |
Update and draw all particles with an offset. |
procedure SP_Init ( maxParticles )You must call this procedure before adding any particles. You can set the maximum number of active particles live at a time.
[ Back ] |
procedure SP_AddParticle ( img, cel, addMode, x, y, srcDX#, srcDY#, dstDX#, dstDY#, srcAlpha#, dstAlpha#, speed#, pause )The life time of a particle depends on the FPS at which your game is running. The particle uses a parameter that's increased by 'speed' every time you call 'SP_UpdateParticles' or 'SP_DoParticles'. It starts at 0 and when it reaches 1 the particle dies.
[ Back ] |
procedure SP_AddPoof ( img, cel, x, y, particleCount, distance#, force#, speed#, addMode, fadeOut )Add particles equaly spread around a growing circle.
[ Back ] |
procedure SP_AddRandomPoof ( img, cel, x, y, particleCount, maxDistance#, maxForce#, maxSpeed#, addMode, fadeOut )Works like 'SP_AddPoof', but with slightly randomized properties for particles.
[ Back ] |
procedure SP_SetPoofEndVector ( ex#, ey# )By default the end vector for poof-generated particles is (0, 0). If you want, for example, want a gravity effect, you could set the end vector to 0, 4.
[ Back ] |
procedure SP_AddParticleAt ( x, y )Add a particle with settings defined with 'SP_SetImage', 'SP_SetDirection', 'SP_SetAlpha', 'SP_SetSpeed' and 'SP_SetPause'.
[ Back ] |
procedure SP_SetImage ( img, cel, addMode )Set particle image properties for 'SP_AddParticleAt'.
[ Back ] |
procedure SP_SetDirection ( srcDX#, srcDY#, dstDX#, dstDY# )Set particle directions for 'SP_AddParticleAt'.
[ Back ] |
procedure SP_SetAlpha ( srcAlpha#, dstAlpha# )Set particle alpha for 'SP_AddParticleAt'.
[ Back ] |
procedure SP_SetSpeed ( speed# )Set parameter speed for 'SP_AddParticleAt'.
[ Back ] |
procedure SP_SetPause ( pause )Set delay for 'SP_AddParticleAt'.
[ Back ] |
procedure SP_UpdateParticles ( )Update all particles. [ Back ] |
procedure SP_DrawParticles ( )Draw all particles. [ Back ] |
procedure SP_DrawParticlesAt ( x, y )Update all particles with an offset.
[ Back ] |
procedure SP_DoParticles ( )Update and draw all particles. [ Back ] |
procedure SP_DoParticlesAt ( x, y )Update and draw all particles with an offset.
[ Back ] |
Generated with NLDoc 20140630.