ScummVM API documentation
Ultima::Shared::Actions::Action Class Reference

#include <action.h>

Inheritance diagram for Ultima::Shared::Actions::Action:
Ultima::Shared::TreeItem Ultima::Shared::MessageTarget Ultima::Shared::BaseObject Ultima::Shared::Actions::Huh Ultima::Shared::Actions::Pass Ultima::Ultima1::Actions::Action Ultima::Ultima1::Actions::AttackFire Ultima::Ultima1::Actions::Cast Ultima::Ultima1::Actions::Move Ultima::Ultima1::Actions::Quit Ultima::Ultima1::Actions::Ready Ultima::Ultima1::Actions::Stats Ultima::Ultima1::Actions::Attack Ultima::Ultima1::Actions::Fire

Public Member Functions

 Action (TreeItem *parent)
 
 ~Action () override
 
GamegetGame ()
 
Maps::MapgetMap ()
 
void addInfoMsg (const Common::String &text, bool newLine=true, bool replaceLine=false)
 
void playFX (uint effectId)
 
- Public Member Functions inherited from Ultima::Shared::TreeItem
virtual const Common::String getName () const
 
virtual bool isEquals (const Common::String &name, int maxLen=0) const
 
virtual int compareTo (const Common::String &name, int maxLen=0) const
 
virtual void viewChange ()
 
TreeItemgetParent () const
 
GamegetGame ()
 
const GamegetGame () const
 
Gfx::VisualItemgetView ()
 
TreeItemgetNextSibling () const
 
TreeItemgetPriorSibling () const
 
TreeItemgetLastSibling ()
 
TreeItemgetFirstChild () const
 
TreeItemgetLastChild () const
 
TreeItemscan (TreeItem *item) const
 
TreeItemfindChildInstanceOf (const ClassDef &classDef) const
 
TreeItemfindNextInstanceOf (const ClassDef &classDef, TreeItem *startItem) const
 
void addUnder (TreeItem *newParent)
 
void addChild (TreeItem *child)
 
void setParent (TreeItem *newParent)
 
void addSibling (TreeItem *item)
 
void moveUnder (TreeItem *newParent)
 
void destroyAll ()
 
int destroyChildren ()
 
void detach ()
 
void attach (TreeItem *item)
 
NamedItemfindByName (const Common::String &name)
 
- Public Member Functions inherited from Ultima::Shared::BaseObject
virtual ::Ultima::Shared::ClassDef getType () const
 
bool isInstanceOf (const ClassDef &classDef) const
 

Protected Member Functions

void endOfTurn ()
 
- Protected Member Functions inherited from Ultima::Shared::MessageTarget
virtual const Ultima::Shared::MSGMAPgetMessageMap () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Ultima::Shared::BaseObject
::Ultima::Shared::ClassDef type ()
 
- Public Attributes inherited from Ultima::Shared::TreeItem
 CLASSDEF
 
- Public Attributes inherited from Ultima::Shared::MessageTarget
 CLASSDEF
 
- Static Protected Member Functions inherited from Ultima::Shared::MessageTarget
static const Ultima::Shared::MSGMAPgetThisMessageMap ()
 

Detailed Description

Base class for implementing the various actions the player can do, such as moving, climbing, entering, etc.

Constructor & Destructor Documentation

◆ Action()

Ultima::Shared::Actions::Action::Action ( TreeItem parent)

Constructor

◆ ~Action()

Ultima::Shared::Actions::Action::~Action ( )
inlineoverride

Destructor

Member Function Documentation

◆ endOfTurn()

void Ultima::Shared::Actions::Action::endOfTurn ( )
protected

Signals the end of the turn

◆ getGame()

Game* Ultima::Shared::Actions::Action::getGame ( )

Jumps up through the parents to find the root game

◆ getMap()

Maps::Map* Ultima::Shared::Actions::Action::getMap ( )

Return the game's map

◆ addInfoMsg()

void Ultima::Shared::Actions::Action::addInfoMsg ( const Common::String text,
bool  newLine = true,
bool  replaceLine = false 
)

Adds a text string to the info area

Parameters
textText to add
newLineWhether to apply a newline at the end

◆ playFX()

void Ultima::Shared::Actions::Action::playFX ( uint  effectId)

Play a sound effect


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