ScummVM API documentation
Ultima::Ultima1::Widgets::OverworldWidget Class Reference

#include <overworld_widget.h>

Inheritance diagram for Ultima::Ultima1::Widgets::OverworldWidget:
Ultima::Shared::Maps::MapWidget Ultima::Shared::MessageTarget Ultima::Shared::BaseObject Ultima::Ultima1::Widgets::OverworldMonster Ultima::Ultima1::Widgets::Transport Ultima::Ultima1::Widgets::TransportOnFoot Ultima::Ultima1::Widgets::EnemyVessel Ultima::Ultima1::Widgets::Aircar Ultima::Ultima1::Widgets::Cart Ultima::Ultima1::Widgets::Frigate Ultima::Ultima1::Widgets::Horse Ultima::Ultima1::Widgets::Raft Ultima::Ultima1::Widgets::Shuttle Ultima::Ultima1::Widgets::TimeMachine

Public Member Functions

 OverworldWidget (Shared::Game *game, Shared::Maps::MapBase *map, uint tileNum, const Point &pt, Shared::Maps::Direction dir=Shared::Maps::DIR_NONE)
 
 OverworldWidget (Shared::Game *game, Shared::Maps::MapBase *map)
 
uint getTileNum () const override
 
void synchronize (Common::Serializer &s) override
 
CanMove canMoveTo (const Point &destPos) override
 
- Public Member Functions inherited from Ultima::Shared::Maps::MapWidget
 MapWidget (Game *game, MapBase *map)
 
 MapWidget (Game *game, MapBase *map, const Point &pt, Direction dir=DIR_NONE)
 
 MapWidget (Game *game, MapBase *map, const Common::String &name, const Point &pt, Direction dir=DIR_NONE)
 
 ~MapWidget () override
 
virtual const char * getClassName () const
 
void addInfoMsg (const Common::String &text, bool newLine=true, bool replaceLine=false)
 
virtual bool isBlocking () const
 
virtual void update (bool isPreUpdate)
 
virtual void moveTo (const Point &destPos, Direction dir=DIR_NONE)
 
- Public Member Functions inherited from Ultima::Shared::BaseObject
virtual ::Ultima::Shared::ClassDef getType () const
 
bool isInstanceOf (const ClassDef &classDef) const
 

Public Attributes

Common::String _name
 
uint _tileNum
 
- Public Attributes inherited from Ultima::Shared::Maps::MapWidget
Point _position
 
Direction _direction
 
Common::String _name
 
 CLASSDEF
 
- Public Attributes inherited from Ultima::Shared::MessageTarget
 CLASSDEF
 

Protected Member Functions

Ultima1GamegetGame () const
 
Maps::MapBasegetMap () const
 
- Protected Member Functions inherited from Ultima::Shared::MessageTarget
virtual const Ultima::Shared::MSGMAPgetMessageMap () const
 

Additional Inherited Members

- Public Types inherited from Ultima::Shared::Maps::MapWidget
enum  CanMove { UNSET = 0, YES = 1, NO = 2 }
 
- Static Public Member Functions inherited from Ultima::Shared::Maps::MapWidget
static Direction directionFromKey (Common::KeyCode keycode)
 
- Static Public Member Functions inherited from Ultima::Shared::BaseObject
::Ultima::Shared::ClassDef type ()
 
- Static Protected Member Functions inherited from Ultima::Shared::MessageTarget
static const Ultima::Shared::MSGMAPgetThisMessageMap ()
 
- Protected Attributes inherited from Ultima::Shared::Maps::MapWidget
Game_game
 
MapBase_map
 

Detailed Description

Encapsulated class for drawing widgets within dungeons

Constructor & Destructor Documentation

◆ OverworldWidget() [1/2]

Ultima::Ultima1::Widgets::OverworldWidget::OverworldWidget ( Shared::Game game,
Shared::Maps::MapBase map,
uint  tileNum,
const Point pt,
Shared::Maps::Direction  dir = Shared::Maps::DIR_NONE 
)
inline

Constructor

◆ OverworldWidget() [2/2]

Ultima::Ultima1::Widgets::OverworldWidget::OverworldWidget ( Shared::Game game,
Shared::Maps::MapBase map 
)
inline

Constructor

Member Function Documentation

◆ getGame()

Ultima1Game* Ultima::Ultima1::Widgets::OverworldWidget::getGame ( ) const
protected

Gets the Ultima 1 game

◆ getMap()

Maps::MapBase* Ultima::Ultima1::Widgets::OverworldWidget::getMap ( ) const
protected

Gets the Ultima 1 map

◆ getTileNum()

◆ synchronize()

void Ultima::Ultima1::Widgets::OverworldWidget::synchronize ( Common::Serializer s)
overridevirtual

Handles loading and saving games

Reimplemented from Ultima::Shared::Maps::MapWidget.

Reimplemented in Ultima::Ultima1::Widgets::Shuttle.

◆ canMoveTo()

CanMove Ultima::Ultima1::Widgets::OverworldWidget::canMoveTo ( const Point destPos)
overridevirtual

Returns true if the given widget can move to a given position on the map

Reimplemented from Ultima::Shared::Maps::MapWidget.


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