OpenXcom::Particle Class Reference

Public Member Functions
	Particle (float xOffset, float yOffset, float density, Uint8 color, Uint8 opacity)
	Create a particle. More...
	~Particle ()
	Destroy a particle. More...
bool	animate ()
	Animate a particle. More...
int	getSize () const
	Get the size value.
Uint8	getColor () const
	Get the color.
Uint8	getOpacity () const
	Get the opacity.
float	getX () const
	Get the horizontal shift.
float	getY () const
	Get the vertical shift.

Constructor & Destructor Documentation

Particle()

OpenXcom::Particle::Particle	(	float	xOffset,
		float	yOffset,
		float	density,
		Uint8	color,
		Uint8	opacity
	)

Create a particle.

Creates a particle.

Parameters

xOffset	the horizontal offset for this particle (relative to the tile in screen space)
yOffset	the vertical offset for this particle (relative to the tile in screen space)
density	the density of the particle dictates the speed at which it moves upwards, and is inversely proportionate to its size.
color	the color set to use from the transparency LUTs
opacity	another reference for the LUT, this one is divided by 5 for the actual offset to use.

~Particle()

OpenXcom::Particle::~Particle

(

)

Destroy a particle.

Cleans up a particle.

Member Function Documentation

animate()

bool OpenXcom::Particle::animate

(

)

Animate a particle.

Animates the particle.

Returns

if we are done animating this particle yet.

---

The documentation for this class was generated from the following files:

• Particle.h
• Particle.cpp