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

#include <annotation.h>

Public Member Functions

Annotationadd (Coords coords, MapTile tile, bool visual=false, bool isCoverUp=false)
 
Annotation::List allAt (Coords pos)
 
Common::List< Annotation * > ptrsToAllAt (Coords pos)
 
void clear ()
 
void passTurn ()
 
void remove (Coords pos, MapTile tile)
 
void remove (Annotation &)
 
void remove (Annotation::List)
 
int size () const
 

Detailed Description

Manages annotations for the current map. This includes adding and removing annotations, as well as finding annotations and managing their existence.

Member Function Documentation

◆ add()

Annotation* Ultima::Ultima4::AnnotationMgr::add ( Coords  coords,
MapTile  tile,
bool  visual = false,
bool  isCoverUp = false 
)

Adds an annotation to the current map

◆ allAt()

Annotation::List Ultima::Ultima4::AnnotationMgr::allAt ( Coords  pos)

Returns all annotations found at the given map coordinates

◆ ptrsToAllAt()

Common::List<Annotation *> Ultima::Ultima4::AnnotationMgr::ptrsToAllAt ( Coords  pos)

Returns pointers to all annotations found at the given map coordinates

◆ clear()

void Ultima::Ultima4::AnnotationMgr::clear ( )

Removes all annotations on the map

◆ passTurn()

void Ultima::Ultima4::AnnotationMgr::passTurn ( )

Passes a turn for annotations and removes any annotations whose TTL has expired

◆ remove() [1/2]

void Ultima::Ultima4::AnnotationMgr::remove ( Coords  pos,
MapTile  tile 
)

Removes an annotation from the current map

◆ remove() [2/2]

void Ultima::Ultima4::AnnotationMgr::remove ( Annotation::List  )

Removes an entire list of annotations

◆ size()

int Ultima::Ultima4::AnnotationMgr::size ( ) const

Returns the number of annotations on the map


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