_________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          T H E   W A R   B E G I N S
                   Stratagus - A free fantasy real time strategy game engine

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
CMapField Class Reference

Describes a field of the map. More...

#include <tile.h>

Public Member Functions

unsigned int getGraphicTile () const
 
unsigned char getCost () const
 
unsigned int getFlag () const
 
void setGraphicTile (unsigned int tile)
 
mapfield.cpp - The map field.
 CMapField ()
 
void Save (CFile &file) const
 
void parse (lua_State *l)
 
void setTileIndex (const CTileset &tileset, unsigned int tileIndex, int value)
 
bool CheckMask (int mask) const
 Check if a field flags. More...
 
bool WaterOnMap () const
 Returns true, if water on the map tile field. More...
 
bool CoastOnMap () const
 Returns true, if coast on the map tile field. More...
 
bool ForestOnMap () const
 Returns true, if water on the map tile field. More...
 
bool RockOnMap () const
 Returns true, if coast on the map tile field. More...
 
bool isAWall () const
 
bool isHuman () const
 
bool isAHumanWall () const
 
bool isAOrcWall () const
 
bool IsTerrainResourceOnMap (int resource) const
 
bool IsTerrainResourceOnMap () const
 

Public Attributes

unsigned short Flags
 graphic tile number More...
 
unsigned char Value
 unit cost to move in this tile More...
 
CUnitCache UnitCache
 HP for walls/ Wood Regeneration. More...
 
CMapFieldPlayerInfo playerInfo
 A unit on the map field. More...
 

Detailed Description

Describes a field of the map.

#include "tile.h"

CMapFieldPlayerInfo::SeenTile

This is the tile number, that the player sitting on the computer currently knows. Idea: Can be uses for illusions.

CMapFieldPlayerInfo::Visible[]

Counter how many units of the player can see this field. 0 the field is not explored, 1 explored, n-1 unit see it. Currently no more than 253 units can see a field.

CMapFieldPlayerInfo::VisCloak[]

Visiblity for cloaking.

CMapFieldPlayerInfo::Radar[]

Visiblity for radar.

CMapFieldPlayerInfo::RadarJammer[]

Jamming capabilities.

#include "tile.h"

This class contains all information about a field on map. It contains its look, properties and content.

The map-field class members:

CMapField::Tile

Tile is number defining the graphic image display for the map-field. 65535 different tiles are supported. A tile is currently 32x32 pixels. In the future is planned to support animated tiles.

CMapField::Flags

Contains special information of that tile. What units are on this field, what units could be placed on this field.

This is the list of all flags currently used:

::MapFieldVisible field is visible. ::MapFieldExplored field is explored. MapFieldHuman human player is the owner of the field used for walls. MapFieldLandAllowed land units are allowed. MapFieldCoastAllowed coast units (transporter) and coast buildings (shipyard) are allowed. MapFieldWaterAllowed water units allowed. MapFieldNoBuilding no buildings allowed. MapFieldUnpassable field is movement blocked. MapFieldWall field contains wall. MapFieldRocks field contains rocks. MapFieldForest field contains forest. MapFieldLandUnit land unit on field. MapFieldAirUnit air unit on field. MapFieldSeaUnit water unit on field. MapFieldBuilding building on field.

Note: We want to add support for more unit-types like under ground units.

CMapField::Cost

Unit cost to move in this tile.

CMapField::Value

Extra value for each tile. This currently only used for walls, contains the remaining hit points of the wall and for forest, contains the frames until they grow.

CMapField::UnitCache

Contains a vector of all units currently on this field. Note: currently units are only inserted at the insert point. This means units of the size of 2x2 fields are inserted at the top and right most map coordinate.

Constructor & Destructor Documentation

CMapField::CMapField ( )

Member Function Documentation

bool CMapField::CheckMask ( int  mask) const

Check if a field flags.

bool CMapField::CoastOnMap ( ) const

Returns true, if coast on the map tile field.

bool CMapField::ForestOnMap ( ) const

Returns true, if water on the map tile field.

unsigned char CMapField::getCost ( ) const
inline
unsigned int CMapField::getFlag ( ) const
inline
unsigned int CMapField::getGraphicTile ( ) const
inline
bool CMapField::isAHumanWall ( ) const
bool CMapField::isAOrcWall ( ) const
bool CMapField::isAWall ( ) const
bool CMapField::isHuman ( ) const
bool CMapField::IsTerrainResourceOnMap ( int  resource) const
bool CMapField::IsTerrainResourceOnMap ( ) const
void CMapField::parse ( lua_State *  l)
bool CMapField::RockOnMap ( ) const

Returns true, if coast on the map tile field.

void CMapField::Save ( CFile file) const
void CMapField::setGraphicTile ( unsigned int  tile)
inline
void CMapField::setTileIndex ( const CTileset tileset,
unsigned int  tileIndex,
int  value 
)
bool CMapField::WaterOnMap ( ) const

Returns true, if water on the map tile field.

Member Data Documentation

unsigned short CMapField::Flags

graphic tile number

CMapFieldPlayerInfo CMapField::playerInfo

A unit on the map field.

CUnitCache CMapField::UnitCache

HP for walls/ Wood Regeneration.

unsigned char CMapField::Value

unit cost to move in this tile


The documentation for this class was generated from the following files:
(C) Copyright 1998-2012 by The Stratagus Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.