Xeen::Locations::BaseLocation Class Reference

Inheritance diagram for Xeen::Locations::BaseLocation:

Public Member Functions
	BaseLocation (LocationAction action)
virtual int	show ()
void	drawAnim (bool flag)
int	wait ()
Public Member Functions inherited from Xeen::ButtonContainer
	ButtonContainer (XeenEngine *vm)
void	saveButtons ()
void	clearButtons ()
void	restoreButtons ()
void	addButton (const Common::Rect &bounds, int val, SpriteResource *sprites=nullptr)
void	addButton (const Common::Rect &bounds, int val, int frameNum, SpriteResource *sprites=nullptr)
void	addPartyButtons (XeenEngine *vm)
void	drawButtons (XSurface *surface)
void	clearEvents ()

Protected Member Functions
void	drawWindow ()
virtual Common::String	createLocationText (Character &ch)
virtual void	drawBackground ()
virtual Character *	doOptions (Character *c)
virtual void	farewell ()
Protected Member Functions inherited from Xeen::ButtonContainer
bool	checkEvents (XeenEngine *vm)
bool	doScroll (bool rollUp, bool fadeIn) override
void	loadStrings (const Common::String &name)
void	loadStrings (const Common::String &name, int ccMode)
void	setWaitBounds ()
Protected Member Functions inherited from Xeen::Cutscenes
	Cutscenes (XeenEngine *vm)
uint	getSpeakingFrame (uint minFrame, uint maxFrame)

Protected Attributes
LocationAction	_locationActionId
Common::Array< SpriteResource >	_townSprites
SpriteResource	_icons1
SpriteResource	_icons2
int	_townMaxId
const int &	_ccNum
int	_animFrame
Common::String	_vocName
Common::String	_songName
Common::Point	_animPos
int	_drawFrameIndex
uint	_farewellTime
int	_drawCtr1
int	_drawCtr2
bool	_exitToUi
Protected Attributes inherited from Xeen::ButtonContainer
Common::Array< UIButton >	_buttons
Common::StringArray	_textStrings
Common::Rect	_waitBounds
int	_buttonValue
Protected Attributes inherited from Xeen::Cutscenes
XeenEngine *	_vm

Member Function Documentation

drawWindow()

void Xeen::Locations::BaseLocation::drawWindow ( )

protected

Draw the window

createLocationText()

virtual Common::String Xeen::Locations::BaseLocation::createLocationText ( Character &  ch )

inlineprotectedvirtual

Generates the display text for the location, for a given character

Reimplemented in Xeen::Locations::TrainingLocation, Xeen::Locations::TempleLocation, Xeen::Locations::TavernLocation, Xeen::Locations::GuildLocation, Xeen::Locations::BlacksmithLocation, and Xeen::Locations::BankLocation.

drawBackground()

virtual void Xeen::Locations::BaseLocation::drawBackground ( )

protectedvirtual

Draw the visual background

Reimplemented in Xeen::Locations::BankLocation.

doOptions()

virtual Character* Xeen::Locations::BaseLocation::doOptions ( Character *  c )

inlineprotectedvirtual

Handles options for the particular location

Reimplemented in Xeen::Locations::TrainingLocation, Xeen::Locations::TempleLocation, Xeen::Locations::TavernLocation, Xeen::Locations::GuildLocation, Xeen::Locations::BlacksmithLocation, and Xeen::Locations::BankLocation.

farewell()

virtual void Xeen::Locations::BaseLocation::farewell ( )

inlineprotectedvirtual

Handle any farewell

Reimplemented in Xeen::Locations::TavernLocation, and Xeen::Locations::BlacksmithLocation.

show()

virtual int Xeen::Locations::BaseLocation::show ( )

virtual

Show the town location

Reimplemented in Xeen::Locations::PyramidLocation, Xeen::Locations::SphinxCutscene, Xeen::Locations::DwarfCutscene, Xeen::Locations::GolemCutscene, Xeen::Locations::ReaperCutscene, and Xeen::Locations::ArenaLocation.

drawAnim()

void Xeen::Locations::BaseLocation::drawAnim

(

bool

flag

)

Draws the animated parts

wait()

int Xeen::Locations::BaseLocation::wait

(

)

Waits for a brief pause, checking for any key or mouse events

---

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

• engines/xeen/locations.h