ScummVM API documentation
Ultima::Ultima4::Dungeon Class Reference
Inheritance diagram for Ultima::Ultima4::Dungeon:
Ultima::Ultima4::Map

Public Member Functions

Common::String getName () override
 
DungeonToken tokenForTile (MapTile tile)
 
DungeonToken currentToken ()
 
byte currentSubToken ()
 
DungeonToken tokenAt (MapCoords coords)
 
byte subTokenAt (MapCoords coords)
 
bool ladderUpAt (MapCoords coords)
 
bool ladderDownAt (MapCoords coords)
 
bool validTeleportLocation (MapCoords coords)
 
- Public Member Functions inherited from Ultima::Ultima4::Map
ObjectobjectAt (const Coords &coords)
 
const PortalportalAt (const Coords &coords, int actionFlags)
 
MapTilegetTileFromData (const Coords &coords)
 
MapTiletileAt (const Coords &coords, int withObjects)
 
const TiletileTypeAt (const Coords &coords, int withObjects)
 
bool isWorldMap ()
 
bool isEnclosed (const Coords &party)
 
CreatureaddCreature (const class Creature *m, Coords coords)
 
ObjectaddObject (MapTile tile, MapTile prevTile, Coords coords)
 
ObjectaddObject (Object *obj, Coords coords)
 
void removeObject (const class Object *rem, bool deleteObject=true)
 
ObjectDeque::iterator removeObject (ObjectDeque::iterator rem, bool deleteObject=true)
 
void clearObjects ()
 
CreaturemoveObjects (MapCoords avatar)
 
void resetObjectAnimations ()
 
int getNumberOfCreatures ()
 
int getValidMoves (MapCoords from, MapTile transport)
 
bool move (Object *obj, Direction d)
 
void alertGuards ()
 
MapCoords getLabel (const Common::String &name) const
 
bool fillMonsterTable ()
 
MapTile translateFromRawTileIndex (int c) const
 
uint translateToRawTileIndex (MapTile &tile) const
 

Public Attributes

Common::String _name
 
uint _nRooms
 
Std::vector< byte > _dataSubTokens
 
DngRoom_rooms
 
CombatMap ** _roomMaps
 
int _currentRoom
 
byte _partyStartX [8]
 
byte _partyStartY [8]
 
- Public Attributes inherited from Ultima::Ultima4::Map
MapId _id
 
Common::Path _fname
 
Type _type
 
uint _width
 
uint _height
 
uint _levels
 
uint _chunkWidth
 
uint _chunkHeight
 
uint _offset
 
Source _baseSource
 
Common::List< Source_extraSources
 
CompressedChunkList _compressedChunks
 
BorderBehavior _borderBehavior
 
PortalList _portals
 
AnnotationMgr_annotations
 
int _flags
 
Music::Type _music
 
MapData _data
 
ObjectDeque _objects
 
Common::HashMap< Common::String, MapCoords_labels
 
Tileset_tileSet
 
TileMap_tileMap
 
MapTile _blank
 
SaveGameMonsterRecord _monsterTable [MONSTERTABLE_SIZE]
 

Additional Inherited Members

- Public Types inherited from Ultima::Ultima4::Map
enum  Type {
  WORLD, CITY, SHRINE, COMBAT,
  DUNGEON, XML
}
 
enum  BorderBehavior { BORDER_WRAP, BORDER_EXIT2PARENT, BORDER_FIXED }
 

Member Function Documentation

◆ getName()

Common::String Ultima::Ultima4::Dungeon::getName ( )
overridevirtual

Returns the name of the dungeon

Reimplemented from Ultima::Ultima4::Map.

◆ tokenForTile()

DungeonToken Ultima::Ultima4::Dungeon::tokenForTile ( MapTile  tile)

Returns the dungeon token associated with the given dungeon tile

◆ currentToken()

DungeonToken Ultima::Ultima4::Dungeon::currentToken ( )

Returns the dungeon token for the current location

◆ currentSubToken()

byte Ultima::Ultima4::Dungeon::currentSubToken ( )

Returns the dungeon sub-token for the current location

◆ tokenAt()

DungeonToken Ultima::Ultima4::Dungeon::tokenAt ( MapCoords  coords)

Returns the dungeon token for the given coordinates

◆ subTokenAt()

byte Ultima::Ultima4::Dungeon::subTokenAt ( MapCoords  coords)

Returns the dungeon sub-token for the given coordinates. The subtoken is encoded in the lower bits of the map raw data. For instance, for the raw value 0x91, returns FOUNTAIN_HEALING NOTE: This function will always need type-casting to the token type necessary

◆ ladderUpAt()

bool Ultima::Ultima4::Dungeon::ladderUpAt ( MapCoords  coords)

Returns true if a ladder-up is found at the given coordinates

◆ ladderDownAt()

bool Ultima::Ultima4::Dungeon::ladderDownAt ( MapCoords  coords)

Returns true if a ladder-down is found at the given coordinates


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