TerrainAccess Class Reference

This class is used by buildings, vehicles and objects to specify which terrain it can move to / be built on. More...

#include <terraintype.h>

List of all members.

Public Member Functions
	TerrainAccess (void)
int	accessible (const TerrainBits &bts) const
	checks whether a field with the given terrainbits is accessible.
void	read (tnstream &stream)
void	write (tnstream &stream) const
void	runTextIO (PropertyContainer &pc)
ASCString	toString (bool brief=true) const
Public Attributes
TerrainBits	terrain
	at least one of these bits must match on of the terrain
TerrainBits	terrainreq
	ALL these bits must be set in the terrain.
TerrainBits	terrainnot
	if one of these bits is set, the field will NOT be accessible
TerrainBits	terrainkill
	if a terrain is not accessible AND one of these bits is matched, the unit will be destroyed

---

Detailed Description

This class is used by buildings, vehicles and objects to specify which terrain it can move to / be built on.

Definition at line 42 of file terraintype.h.

---

Constructor & Destructor Documentation

TerrainAccess::TerrainAccess

(

void

)

Definition at line 390 of file terraintype.cpp.

References terrain.

---

Member Function Documentation

int TerrainAccess::accessible

(

const TerrainBits &

bts

)

const

checks whether a field with the given terrainbits is accessible.

Returns:

1 if the field is accessible; 0 if it is not accessible -1 if it is not accessible and the unit is killed by it

Definition at line 395 of file terraintype.cpp.

References terrain, terrainkill, terrainnot, and terrainreq.

Referenced by ConstructBuildingCommand::buildingFits(), BuildingItem::place(), VehicleItem::place(), stu_height(), and terrainaccessible2().

void TerrainAccess::read

(

tnstream &

stream

)

Definition at line 73 of file terraintype.cpp.

References TerrainBits::read(), tnstream::readInt(), terrain, terrainkill, terrainnot, and terrainreq.

Referenced by VehicleType::read(), and BuildingType::read().

void TerrainAccess::write

(

tnstream &

stream

)

const

Definition at line 85 of file terraintype.cpp.

References terrain, terrainkill, terrainnot, terrainreq, TerrainBits::write(), and tnstream::writeInt().

Referenced by VehicleType::write(), and BuildingType::write().

void TerrainAccess::runTextIO

(

PropertyContainer &

pc

)

Definition at line 95 of file terraintype.cpp.

References PropertyContainer::addTagArray(), terrain, terrainkill, terrainnot, terrainProperties, terrainPropertyNum, and terrainreq.

Referenced by VehicleType::runTextIO(), ObjectType::FieldModification::runTextIO(), and BuildingType::runTextIO().

ASCString TerrainAccess::toString

(

bool

brief = true

)

const

Definition at line 583 of file terraintype.cpp.

References TerrainBits::appendToString(), terrain, terrainkill, terrainnot, and terrainreq.

Referenced by GuiFunctions::BuildVehicleCommand::execute().

---

Member Data Documentation

TerrainBits TerrainAccess::terrain

at least one of these bits must match on of the terrain

Definition at line 47 of file terraintype.h.

Referenced by accessible(), VehicleType::read(), read(), runTextIO(), TerrainAccess(), toString(), and write().

TerrainBits TerrainAccess::terrainreq

ALL these bits must be set in the terrain.

Definition at line 50 of file terraintype.h.

Referenced by accessible(), VehicleType::read(), read(), runTextIO(), toString(), and write().

TerrainBits TerrainAccess::terrainnot

if one of these bits is set, the field will NOT be accessible

Definition at line 53 of file terraintype.h.

Referenced by accessible(), VehicleType::read(), read(), runTextIO(), toString(), and write().

TerrainBits TerrainAccess::terrainkill

if a terrain is not accessible AND one of these bits is matched, the unit will be destroyed

Definition at line 56 of file terraintype.h.

Referenced by accessible(), VehicleType::read(), read(), runTextIO(), toString(), and write().

---

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

• terraintype.h
• terraintype.cpp

---