Bottle 2D - Lua API 1.0.0
All you need to create games using bottle2D.
Public Member Functions

ParticleModel Class Reference

A particle model defines the variable of the particle. More...

#include <header.hpp>

List of all members.

Public Member Functions

 ParticleModel ()
 Constructor.
 ParticleModel (number lifeTimeMin, number lifeTimeMax)
 Constructor.
nil AddFixedParam (string name, number value)
 Add a fixed value for parameter "name".
nil AddMutableParam (string name, number begin, number end)
 Add a mutable value for parameter "name".
nil AddRandomParam (string name, number min, number max)
 Add a random value for parameter "name".
nil AddMutableRandomParam (string name, number begin_min, number begin_max, number end_min, number end_max)
 Add a random and mutable value for parameter "name".
nil SetLifeTime (number min, number max)
 Set the particle life time.

Detailed Description

A particle model defines the variable of the particle.

The more numerous the variable are, the bigger memory size will be used by the ParticleSource.


Constructor & Destructor Documentation

ParticleModel::ParticleModel ( )

Constructor.

ParticleModel::ParticleModel ( number  lifeTimeMin,
number  lifeTimeMax 
)

Constructor.


Member Function Documentation

nil ParticleModel::AddFixedParam ( string  name,
number  value 
)

Add a fixed value for parameter "name".


Note: Name can be either "red", "green", "blue" or "alpha".

nil ParticleModel::AddMutableParam ( string  name,
number  begin,
number  end 
)

Add a mutable value for parameter "name".

This value will change from start to end during the particle life time.
Note: Name can be either "red", "green", "blue" or "alpha".

nil ParticleModel::AddMutableRandomParam ( string  name,
number  begin_min,
number  begin_max,
number  end_min,
number  end_max 
)

Add a random and mutable value for parameter "name".

For each particle a value will be chosen between begin_min and begin_max. At end of life, the value will be between end_min and end_max.
Note: Name can be either "red", "green", "blue" or "alpha".

nil ParticleModel::AddRandomParam ( string  name,
number  min,
number  max 
)

Add a random value for parameter "name".

For each particle a value will be chosen between min and max.
Note: Name can be either "red", "green", "blue" or "alpha".

nil ParticleModel::SetLifeTime ( number  min,
number  max 
)

Set the particle life time.

A random value will be chosen between min and max for each particle.


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables