OpenXcom::MapData Class Reference

MapData is the smallest piece of a Battlescape terrain, holding info about a certain object, wall, floor, ... More...

#include <MapData.h>

Public Member Functions
	MapData (MapDataSet *dataset)
	Creates a new Map Data Object. More...
	~MapData ()
	Destroys the object.
MapDataSet *	getDataset () const
	Gets the dataset this object belongs to. More...
int	getSprite (int frameID) const
	Gets the sprite index for a certain frame. More...
void	setSprite (int frameID, int value)
	Sets the sprite index for a certain frame. More...
bool	isUFODoor () const
	Gets whether this is an animated ufo door. More...
bool	isNoFloor () const
	Gets whether this is a floor. More...
int	getBigWall () const
	Gets whether this is a big wall, which blocks all surrounding paths. More...
bool	isDoor () const
	Gets whether this is a normal door. More...
bool	isGravLift () const
	Gets whether this is a grav lift. More...
void	setFlags (bool isUfoDoor, bool stopLOS, bool isNoFloor, int bigWall, bool isGravLift, bool isDoor, bool blockFire, bool blockSmoke, bool baseModule)
	Sets all kinds of flags. More...
int	getBlock (ItemDamageType type) const
	Gets the amount of blockage of a certain type. More...
void	setBlockValue (int lightBlock, int visionBlock, int HEBlock, int smokeBlock, int fireBlock, int gasBlock)
	Sets the amount of blockage for all types. More...
void	setHEBlock (int HEBlock)
	Sets the amount of HE blockage. More...
int	getYOffset () const
	Gets the offset on the Y axis when drawing this object. More...
void	setYOffset (int value)
	Sets the offset on the Y axis for drawing this object. More...
void	setObjectType (TilePart type)
	Set the type of tile. More...
TilePart	getObjectType () const
	Get the type of tile. More...
SpecialTileType	getSpecialType () const
	Gets info about special tile types. More...
void	setSpecialType (int value, TilePart otype)
	Sets a special tile type and object type. More...
int	getTUCost (MovementType movementType) const
	Gets the TU cost to move over the object. More...
void	setTUCosts (int walk, int fly, int slide)
	Sets the TU cost to move over the object. More...
int	getTerrainLevel () const
	Adds this to the graphical Y offset of units or objects on this tile. More...
void	setTerrainLevel (int value)
	Sets Y offset for units/objects on this tile. More...
int	getFootstepSound () const
	Gets the index to the footstep sound. More...
void	setFootstepSound (int value)
	Sets the index to the footstep sound. More...
int	getAltMCD () const
	Gets sthe alternative object ID. More...
void	setAltMCD (int value)
	Sets the alternative object ID. More...
int	getDieMCD () const
	Gets the dead object ID. More...
void	setDieMCD (int value)
	Sets the dead object ID. More...
int	getLightSource () const
	Gets the amount of light the object is emitting. More...
void	setLightSource (int value)
	Sets the amount of light the object is emitting. More...
int	getArmor () const
	Gets the amount of armor. More...
void	setArmor (int value)
	Sets the amount of armor. More...
int	getFlammable () const
	Gets the amount of flammable. More...
void	setFlammable (int value)
	Sets the amount of flammable. More...
int	getFuel () const
	Gets the amount of fuel. More...
void	setFuel (int value)
	Sets the amount of fuel. More...
int	getLoftID (int layer) const
	Gets the loft index for a certain layer. More...
void	setLoftID (int loft, int layer)
	Sets the loft index for a certain layer. More...
int	getExplosive () const
	Gets the amount of explosive. More...
void	setExplosive (int value)
	Sets the amount of explosive. More...
int	getExplosiveType () const
	Gets the type of explosive. More...
void	setExplosiveType (int value)
	Sets the type of explosive. More...
void	setMiniMapIndex (unsigned short i)
	Sets the MiniMap index. More...
unsigned short	getMiniMapIndex () const
	Gets the MiniMap index. More...
void	setBigWall (const int bigWall)
	Sets the bigwall value. More...
void	setTUWalk (const int TUWalk)
	Sets the TUWalk value. More...
void	setTUFly (const int TUFly)
	Sets the TUFly value. More...
void	setTUSlide (const int TUSlide)
	Sets the TUSlide value. More...
bool	isBaseModule () const
	Check if this is an xcom base object. More...
void	setNoFloor (bool isNoFloor)
	Sets this tile as not a floor (water, etc.) More...
void	setStopLOS (bool stopLOS)
	Sets this tile as not stopping LOS. More...

Detailed Description

MapData is the smallest piece of a Battlescape terrain, holding info about a certain object, wall, floor, ...

See also

MapDataSet.

Constructor & Destructor Documentation

MapData()

OpenXcom::MapData::MapData

(

MapDataSet *

dataset

)

Creates a new Map Data Object.

Parameters

dataset

The dataset this object belongs to.

Member Function Documentation

getAltMCD()

int OpenXcom::MapData::getAltMCD

(

)

const

Gets sthe alternative object ID.

Gets the alternative object ID.

Returns

The alternative object ID.

getArmor()

int OpenXcom::MapData::getArmor

(

)

const

Gets the amount of armor.

Returns

The amount of armor.

getBigWall()

int OpenXcom::MapData::getBigWall

(

)

const

Gets whether this is a big wall, which blocks all surrounding paths.

Return value key: 0: not a bigWall 1: regular bigWall 2: allows movement in ne/sw direction 3: allows movement in nw/se direction 4: acts as a west wall 5: acts as a north wall 6: acts as an east wall 7: acts as a south wall 8: acts as a south and east wall. 9: acts as a north and west wall.

Returns

An integer representing what kind of bigwall this is.

getBlock()

int OpenXcom::MapData::getBlock

(

ItemDamageType

type

)

const

Gets the amount of blockage of a certain type.

Parameters

type

Type.

Returns

The blockage (0-255).

getDataset()

MapDataSet * OpenXcom::MapData::getDataset

(

)

const

Gets the dataset this object belongs to.

Returns

Pointer to MapDataSet.

getDieMCD()

int OpenXcom::MapData::getDieMCD

(

)

const

Gets the dead object ID.

Returns

The dead object ID.

getExplosive()

int OpenXcom::MapData::getExplosive

(

)

const

Gets the amount of explosive.

Returns

The amount of explosive.

getExplosiveType()

int OpenXcom::MapData::getExplosiveType

(

)

const

Gets the type of explosive.

Returns

The amount of explosive.

getFlammable()

int OpenXcom::MapData::getFlammable

(

)

const

Gets the amount of flammable.

Gets the amount of flammable (how flammable this object is).

Returns

The amount of flammable.

getFootstepSound()

int OpenXcom::MapData::getFootstepSound

(

)

const

Gets the index to the footstep sound.

Returns

The sound ID.

getFuel()

int OpenXcom::MapData::getFuel

(

)

const

Gets the amount of fuel.

Returns

The amount of fuel.

getLightSource()

int OpenXcom::MapData::getLightSource

(

)

const

Gets the amount of light the object is emitting.

Returns

The amount of light emitted.

getLoftID()

int OpenXcom::MapData::getLoftID

(

int

layer

)

const

Gets the loft index for a certain layer.

Parameters

layer

The layer.

Returns

The loft index.

getMiniMapIndex()

unsigned short OpenXcom::MapData::getMiniMapIndex

(

)

const

Gets the MiniMap index.

Gets the SCANG.DAT index for minimap.

Returns

The minimap index.

getObjectType()

TilePart OpenXcom::MapData::getObjectType

(

)

const

Get the type of tile.

Gets the type of object.

Returns

Type of the part of the tile.

getSpecialType()

SpecialTileType OpenXcom::MapData::getSpecialType

(

)

const

Gets info about special tile types.

Returns

The special tile type.

getSprite()

int OpenXcom::MapData::getSprite

(

int

frameID

)

const

Gets the sprite index for a certain frame.

Gets the sprite index.

Parameters

frameID

Animation frame 0-7.

Returns

The original sprite index.

getTerrainLevel()

int OpenXcom::MapData::getTerrainLevel

(

)

const

Adds this to the graphical Y offset of units or objects on this tile.

Returns

The Y offset.

getTUCost()

int OpenXcom::MapData::getTUCost

(

MovementType

movementType

)

const

Gets the TU cost to move over the object.

Gets the TU cost to walk over the object.

Parameters

movementType

The movement type.

Returns

The TU cost.

getYOffset()

int OpenXcom::MapData::getYOffset

(

)

const

Gets the offset on the Y axis when drawing this object.

Gets the Y offset for drawing.

Returns

The height in pixels.

isBaseModule()

bool OpenXcom::MapData::isBaseModule

(

)

const

Check if this is an xcom base object.

check if this is an xcom base object.

Returns

if it is a base object.

isDoor()

bool OpenXcom::MapData::isDoor

(

)

const

Gets whether this is a normal door.

Returns

True if this is a normal door.

isGravLift()

bool OpenXcom::MapData::isGravLift

(

)

const

Gets whether this is a grav lift.

Returns

True if this is a grav lift.

isNoFloor()

bool OpenXcom::MapData::isNoFloor

(

)

const

Gets whether this is a floor.

Returns

True if this is a floor.

isUFODoor()

bool OpenXcom::MapData::isUFODoor

(

)

const

Gets whether this is an animated ufo door.

Returns

True if this is an animated ufo door.

setAltMCD()

void OpenXcom::MapData::setAltMCD

(

int

value

)

Sets the alternative object ID.

Parameters

value

The alternative object ID.

setArmor()

void OpenXcom::MapData::setArmor

(

int

value

)

Sets the amount of armor.

Parameters

value

The amount of armor.

setBigWall()

void OpenXcom::MapData::setBigWall

(

const int

bigWall

)

Sets the bigwall value.

Sets the bigWall value.

Parameters

bigWall

The new bigWall value.

setBlockValue()

void OpenXcom::MapData::setBlockValue	(	int	lightBlock,
		int	visionBlock,
		int	HEBlock,
		int	smokeBlock,
		int	fireBlock,
		int	gasBlock
	)

Sets the amount of blockage for all types.

Parameters

lightBlock	The light blockage.
visionBlock	The vision blockage.
HEBlock	The high explosive blockage.
smokeBlock	The smoke blockage.
fireBlock	The fire blockage.
gasBlock	The gas blockage.

setDieMCD()

void OpenXcom::MapData::setDieMCD

(

int

value

)

Sets the dead object ID.

Parameters

value

The dead object ID.

setExplosive()

void OpenXcom::MapData::setExplosive

(

int

value

)

Sets the amount of explosive.

Parameters

value

The amount of explosive.

setExplosiveType()

void OpenXcom::MapData::setExplosiveType

(

int

value

)

Sets the type of explosive.

Parameters

value

The type of explosive.

setFlags()

void OpenXcom::MapData::setFlags	(	bool	isUfoDoor,
		bool	stopLOS,
		bool	isNoFloor,
		int	bigWall,
		bool	isGravLift,
		bool	isDoor,
		bool	blockFire,
		bool	blockSmoke,
		bool	baseModule
	)

Sets all kinds of flags.

Parameters

isUfoDoor	True if this is a ufo door.
stopLOS	True if this stops line of sight.
isNoFloor	True if this is a floor.
bigWall	True if this is a bigWall.
isGravLift	True if this is a grav lift.
isDoor	True if this is a normal door.
blockFire	True if this blocks fire.
blockSmoke	True if this blocks smoke.
baseModule	True if this is a base module item.

setFlammable()

void OpenXcom::MapData::setFlammable

(

int

value

)

Sets the amount of flammable.

Sets the amount of flammable (how flammable this object is).

Parameters

value

The amount of flammable.

setFootstepSound()

void OpenXcom::MapData::setFootstepSound

(

int

value

)

Sets the index to the footstep sound.

Parameters

value

The sound ID.

setFuel()

void OpenXcom::MapData::setFuel

(

int

value

)

Sets the amount of fuel.

Parameters

value

The amount of fuel.

setHEBlock()

void OpenXcom::MapData::setHEBlock

(

int

HEBlock

)

Sets the amount of HE blockage.

Parameters

HEBlock

The high explosive blockage.

setLightSource()

void OpenXcom::MapData::setLightSource

(

int

value

)

Sets the amount of light the object is emitting.

Parameters

value

The amount of light emitted.

setLoftID()

void OpenXcom::MapData::setLoftID	(	int	loft,
		int	layer
	)

Sets the loft index for a certain layer.

Parameters

loft	The loft index.
layer	The layer.

setMiniMapIndex()

void OpenXcom::MapData::setMiniMapIndex

(

unsigned short

i

)

Sets the MiniMap index.

Sets the SCANG.DAT index for minimap.

Parameters

i	The minimap index.

setNoFloor()

void OpenXcom::MapData::setNoFloor

(

bool

isNoFloor

)

Sets this tile as not a floor (water, etc.)

set the "no floor" flag.

Parameters

isNoFloor

set the flag to THIS.

setObjectType()

void OpenXcom::MapData::setObjectType

(

TilePart

type

)

Set the type of tile.

Sets the type of object.

Parameters

type	New type of the object.

setSpecialType()

void OpenXcom::MapData::setSpecialType	(	int	value,
		TilePart	otype
	)

Sets a special tile type and object type.

Parameters

value	Special tile type.
otype	Object type.

setSprite()

void OpenXcom::MapData::setSprite	(	int	frameID,
		int	value
	)

Sets the sprite index for a certain frame.

Parameters

frameID	Animation frame
value	The sprite index in the surfaceset of the mapdataset.

setStopLOS()

void OpenXcom::MapData::setStopLOS

(

bool

stopLOS

)

Sets this tile as not stopping LOS.

set the "stops LOS" flag.

Parameters

stopLOS

set the flag to THIS.

setTerrainLevel()

void OpenXcom::MapData::setTerrainLevel

(

int

value

)

Sets Y offset for units/objects on this tile.

Sets the Y offset for units/objects on this tile.

Parameters

value

The Y offset.

setTUCosts()

void OpenXcom::MapData::setTUCosts	(	int	walk,
		int	fly,
		int	slide
	)

Sets the TU cost to move over the object.

Parameters

walk	The walking TU cost.
fly	The flying TU cost.
slide	The sliding TU cost.

setTUFly()

void OpenXcom::MapData::setTUFly

(

const int

TUFly

)

Sets the TUFly value.

Parameters

TUFly

The new TUFly value.

setTUSlide()

void OpenXcom::MapData::setTUSlide

(

const int

TUSlide

)

Sets the TUSlide value.

Parameters

TUSlide

The new TUSlide value.

setTUWalk()

void OpenXcom::MapData::setTUWalk

(

const int

TUWalk

)

Sets the TUWalk value.

Parameters

TUWalk

The new TUWalk value.

setYOffset()

void OpenXcom::MapData::setYOffset

(

int

value

)

Sets the offset on the Y axis for drawing this object.

Parameters

value

The offset.

---

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

• MapData.h
• MapData.cpp