ScummVM API documentation
Ultima::Ultima4::Annotation Class Reference

#include <annotation.h>

Public Types

typedef Common::List< AnnotationList
 

Public Member Functions

 Annotation (const Coords &coords, MapTile tile, bool visual=false, bool coverUp=false)
 
void debug_output () const
 
const CoordsgetCoords () const
 
MapTilegetTile ()
 
bool isVisualOnly () const
 
int getTTL () const
 
bool isCoverUp () const
 
void setCoords (const Coords &c)
 
void setTile (const MapTile &t)
 
void setVisualOnly (bool v)
 
void setTTL (int turns)
 
void passTurn ()
 
bool operator== (const Annotation &) const
 

Detailed Description

Annotation are updates to a map. There are three types of annotations:

  • permanent: lasts until annotationClear is called
  • turn based: lasts a given number of cycles
  • time based: lasts a given number of time units (1/4 seconds)

Member Function Documentation

◆ getCoords()

const Coords& Ultima::Ultima4::Annotation::getCoords ( ) const
inline

Returns the coordinates of the annotation

◆ getTile()

MapTile& Ultima::Ultima4::Annotation::getTile ( )
inline

Returns the annotation's tile

◆ isVisualOnly()

bool Ultima::Ultima4::Annotation::isVisualOnly ( ) const
inline

Returns true for visual-only annotations

◆ getTTL()

int Ultima::Ultima4::Annotation::getTTL ( ) const
inline

Returns the number of turns the annotation has left to live

◆ setCoords()

void Ultima::Ultima4::Annotation::setCoords ( const Coords c)
inline

Sets the coordinates for the annotation

◆ setTile()

void Ultima::Ultima4::Annotation::setTile ( const MapTile t)
inline

Sets the tile for the annotation

◆ setVisualOnly()

void Ultima::Ultima4::Annotation::setVisualOnly ( bool  v)
inline

Sets whether or not the annotation is visual-only

◆ setTTL()

void Ultima::Ultima4::Annotation::setTTL ( int  turns)
inline

Sets the number of turns the annotation will live

◆ passTurn()

void Ultima::Ultima4::Annotation::passTurn ( )
inline

Passes a turn for the annotation


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