OpenXcom::Explosion Class Reference

A class that represents an explosion animation. More...

#include <Explosion.h>

Public Member Functions
	Explosion (Position _position, int startFrame, int frameDelay=0, bool big=false, bool hit=false)
	Creates a new Explosion. More...
	~Explosion ()
	Cleans up the Explosion. More...
bool	animate ()
	Moves the Explosion on one frame. More...
Position	getPosition () const
	Gets the current position in voxel space. More...
int	getCurrentFrame () const
	Gets the current frame. More...
bool	isBig () const
	Checks if this is a real explosion. More...
bool	isHit () const
	Checks if this is a melee or psi hit. More...

Detailed Description

A class that represents an explosion animation.

Map is the owner of an instance of this class during its short life. It represents both a bullet hit, as a real explosion animation.

Constructor & Destructor Documentation

Explosion()

OpenXcom::Explosion::Explosion	(	Position	position,
		int	startFrame,
		int	frameDelay = 0,
		bool	big = false,
		bool	hit = false
	)

Creates a new Explosion.

Sets up a Explosion sprite with the specified size and position.

Parameters

position	Explosion center position in voxel x/y/z.
startFrame	A startframe - can be used to offset different explosions at different frames.
big	Flag to indicate it is a bullet hit (false), or a real explosion (true).
hit	True for melee and psi attacks.

~Explosion()

OpenXcom::Explosion::~Explosion

(

)

Cleans up the Explosion.

Deletes the Explosion.

Member Function Documentation

animate()

bool OpenXcom::Explosion::animate

(

)

Moves the Explosion on one frame.

Animates the explosion further.

Returns

false If the animation is finished.

getCurrentFrame()

int OpenXcom::Explosion::getCurrentFrame

(

)

const

Gets the current frame.

Gets the current frame in the animation.

Returns

frame number.

getPosition()

Position OpenXcom::Explosion::getPosition

(

)

const

Gets the current position in voxel space.

Returns

position in voxel space.

isBig()

bool OpenXcom::Explosion::isBig

(

)

const

Checks if this is a real explosion.

Returns flag to indicate if it is a bullet hit (false), or a real explosion (true).

Returns

True if it is a real explosion, false if it is a bullet hit.

isHit()

bool OpenXcom::Explosion::isHit

(

)

const

Checks if this is a melee or psi hit.

Returns flag to indicate if it is a melee or psi hit.

Returns

True if it is a melee hit or psi hit.

---

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

• Explosion.h
• Explosion.cpp