Got::Events Class Reference

#include <events.h>

Inheritance diagram for Got::Events:

Public Member Functions
virtual bool	isDemo () const =0
void	runGame ()
void	replaceView (UIElement *ui, bool replaceAllViews=false, bool fadeOutIn=false) override
void	replaceView (const Common::String &name, bool replaceAllViews=false, bool fadeOutIn=false) override
void	addView (UIElement *ui) override
void	addView (const Common::String &name) override
void	clearViews ()
void	popView ()
UIElement *	focusedView () const
UIElement *	priorView () const
UIElement *	firstView () const
bool	isPresent (const Common::String &name) const
bool	isInCombat () const
Graphics::Screen *	getScreen () const
void	drawElements () override
void	draw () override
bool	tick () override
void	close () override
Public Member Functions inherited from Got::UIElement
	UIElement (const Common::String &name, UIElement *uiParent)
	UIElement (const Common::String &name)
bool	needsRedraw () const
void	redraw ()
void	addView ()
void	open ()
int	getRandomNumber (int minNumber, int maxNumber)
int	getRandomNumber (int maxNumber)
virtual void	setBounds (const Common::Rect &r)
Common::Rect	getBounds () const
const Common::String &	getName () const
Gfx::GfxSurface	getSurface (bool innerBounds=false) const
virtual UIElement *	findView (const Common::String &name)
bool	send (const MouseMoveMessage &msg)
bool	send (const Common::String &viewName, const FocusMessage &msg)
bool	send (const FocusMessage &msg)
bool	send (const Common::String &viewName, const UnfocusMessage &msg)
bool	send (const UnfocusMessage &msg)
bool	send (const Common::String &viewName, const MouseEnterMessage &msg)
bool	send (const MouseEnterMessage &msg)
bool	send (const Common::String &viewName, const MouseLeaveMessage &msg)
bool	send (const MouseLeaveMessage &msg)
bool	send (const Common::String &viewName, const KeypressMessage &msg)
bool	send (const KeypressMessage &msg)
bool	send (const Common::String &viewName, const MouseDownMessage &msg)
bool	send (const MouseDownMessage &msg)
bool	send (const Common::String &viewName, const MouseUpMessage &msg)
bool	send (const MouseUpMessage &msg)
bool	send (const Common::String &viewName, const ActionMessage &msg)
bool	send (const ActionMessage &msg)
bool	send (const Common::String &viewName, const GameMessage &msg)
bool	send (const GameMessage &msg)
bool	send (const Common::String &viewName, const ValueMessage &msg)
bool	send (const ValueMessage &msg)

Protected Member Functions
virtual bool	shouldQuit () const =0
bool	msgAction (const ActionMessage &e) override
bool	msgFocus (const FocusMessage &e) override
bool	msgUnfocus (const UnfocusMessage &e) override
bool	msgMouseEnter (const MouseEnterMessage &e) override
bool	msgMouseLeave (const MouseLeaveMessage &e) override
bool	msgKeypress (const KeypressMessage &e) override
bool	msgMouseDown (const MouseDownMessage &e) override
bool	msgMouseUp (const MouseUpMessage &e) override
bool	msgMouseMove (const MouseMoveMessage &e) override
Protected Member Functions inherited from Got::UIElement
bool	isDelayActive () const
void	cancelDelay ()
virtual void	timeout ()
void	stopTextToSpeech ()
virtual bool	msgGame (const GameMessage &e)
virtual bool	msgValue (const ValueMessage &e)

Additional Inherited Members
Protected Attributes inherited from Got::UIElement
UIElement *	_parent
Common::Array< UIElement * >	_children
Common::Rect	_innerBounds
Bounds	_bounds
bool	_needsRedraw = true
Common::String	_name
Common::String	_previousSaid

Detailed Description

Main events and view manager. This is kept separate from the engine class because the engine may add a lot of globals and bring in other classes. So to save on compilation time, classes that only need to access basic view management methods like addView or replaceView only need to include events.h rather than the whole engine.

Member Function Documentation

shouldQuit()

virtual bool Got::Events::shouldQuit ( ) const

protectedpure virtual

Returns true if the game should quit

Implemented in Got::GotEngine.

msgMouseMove()

bool Got::Events::msgMouseMove ( const MouseMoveMessage &  msg )

inlineoverrideprotectedvirtual

Handles events

Reimplemented from Got::UIElement.

runGame()

void Got::Events::runGame

(

)

Main game loop

replaceView()

void Got::Events::replaceView ( UIElement *  ui, bool  replaceAllViews = false, bool  fadeOutIn = false  )

overridevirtual

Sets the focus to a new view

Reimplemented from Got::UIElement.

addView()

void Got::Events::addView ( UIElement *  ui )

overridevirtual

Adds a focused view to the view stack without replacing current one

Reimplemented from Got::UIElement.

clearViews()

void Got::Events::clearViews

(

)

Clears the view list

popView()

void Got::Events::popView

(

)

Pops a view from the view stack

focusedView()

UIElement* Got::Events::focusedView ( ) const

inline

Returns the currently focused view, if any

priorView()

UIElement* Got::Events::priorView ( ) const

inline

Returns the view prior to the current view, if any

firstView()

UIElement* Got::Events::firstView ( ) const

inline

Returns the first view in the stack

isPresent()

bool Got::Events::isPresent

(

const Common::String &

name

)

const

Returns true if a view of a given name is present at all in the visible view stack

isInCombat()

bool Got::Events::isInCombat ( ) const

inline

Returns true if combat is active

getScreen()

Graphics::Screen* Got::Events::getScreen ( void  ) const

inline

Returns the underlying screen

drawElements()

void Got::Events::drawElements ( )

overridevirtual

Draws the focused view

Reimplemented from Got::UIElement.

draw()

void Got::Events::draw ( )

inlineoverridevirtual

Events manager doesn't have any intrinsic drawing

Reimplemented from Got::UIElement.

tick()

bool Got::Events::tick ( )

inlineoverridevirtual

Called once every game frame

Reimplemented from Got::UIElement.

close()

void Got::Events::close ( )

inlineoverridevirtual

Calling the close method for g_events closes the active view

Reimplemented from Got::UIElement.

---

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

• engines/got/events.h