ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Stark::GameInterface Class Reference

Facade object for the user interface to interact with the game world. More...

#include <gameinterface.h>

List of all members.

Public Member Functions

 GameInterface ()
 ~GameInterface ()
bool skipCurrentSpeeches ()
 Skip currently playing speeches.
void walkTo (const Common::Point &mouse)
 Make April try to go to the location under the cursor.
VisualImageXMGgetActionImage (uint32 itemIndex, bool active)
VisualImageXMGgetCursorImage (uint32 itemIndex)
bool itemHasAction (Resources::ItemVisual *item, int32 action)
 Can the item be used for an action.
bool itemHasActionAt (Resources::ItemVisual *item, const Common::Point &position, int32 action)
int32 itemGetDefaultActionAt (Resources::ItemVisual *item, const Common::Point &position)
 Get the item's default action.
void itemDoAction (Resources::ItemVisual *item, uint32 action)
 Do an action on the item.
void itemDoActionAt (Resources::ItemVisual *item, uint32 action, const Common::Point &position)
Common::String getItemTitle (Resources::ItemVisual *object)
 Get the item's name.
Common::String getItemTitleAt (Resources::ItemVisual *object, const Common::Point &pos)
Resources::ActionArray listActionsPossibleForObject (Resources::ItemVisual *item)
 List the actions available for an item in the current game state.
Resources::ActionArray listActionsPossibleForObjectAt (Resources::ItemVisual *item, const Common::Point &pos)
Resources::ActionArray listStockActionsPossibleForObject (Resources::ItemVisual *item)
 List the stock actions available for an item in the current game state (hand, mouth, eye).
Resources::ActionArray listStockActionsPossibleForObjectAt (Resources::ItemVisual *item, const Common::Point &pos)
bool isAprilWalking () const
 Check if April is doing a walk movement.
void setAprilRunning ()
 Make April run if she is walking.
Common::Array< Common::PointlistExitPositions ()
 List all the exit positions.

Detailed Description

Facade object for the user interface to interact with the game world.

Definition at line 42 of file gameinterface.h.


Constructor & Destructor Documentation

Stark::GameInterface::GameInterface (  ) 

Definition at line 47 of file gameinterface.cpp.

Stark::GameInterface::~GameInterface (  ) 

Definition at line 50 of file gameinterface.cpp.


Member Function Documentation

VisualImageXMG * Stark::GameInterface::getActionImage ( uint32  itemIndex,
bool  active 
)

Definition at line 109 of file gameinterface.cpp.

VisualImageXMG * Stark::GameInterface::getCursorImage ( uint32  itemIndex  ) 

Definition at line 120 of file gameinterface.cpp.

Common::String Stark::GameInterface::getItemTitle ( Resources::ItemVisual object  ) 

Get the item's name.

Definition at line 169 of file gameinterface.cpp.

Common::String Stark::GameInterface::getItemTitleAt ( Resources::ItemVisual object,
const Common::Point pos 
)

Definition at line 173 of file gameinterface.cpp.

bool Stark::GameInterface::isAprilWalking (  )  const

Check if April is doing a walk movement.

Definition at line 238 of file gameinterface.cpp.

void Stark::GameInterface::itemDoAction ( Resources::ItemVisual item,
uint32  action 
)

Do an action on the item.

Definition at line 160 of file gameinterface.cpp.

void Stark::GameInterface::itemDoActionAt ( Resources::ItemVisual item,
uint32  action,
const Common::Point position 
)

Definition at line 164 of file gameinterface.cpp.

int32 Stark::GameInterface::itemGetDefaultActionAt ( Resources::ItemVisual item,
const Common::Point position 
)

Get the item's default action.

Definition at line 150 of file gameinterface.cpp.

bool Stark::GameInterface::itemHasAction ( Resources::ItemVisual item,
int32  action 
)

Can the item be used for an action.

-1 for all actions

Definition at line 131 of file gameinterface.cpp.

bool Stark::GameInterface::itemHasActionAt ( Resources::ItemVisual item,
const Common::Point position,
int32  action 
)

Definition at line 140 of file gameinterface.cpp.

Resources::ActionArray Stark::GameInterface::listActionsPossibleForObject ( Resources::ItemVisual item  ) 

List the actions available for an item in the current game state.

Definition at line 178 of file gameinterface.cpp.

Resources::ActionArray Stark::GameInterface::listActionsPossibleForObjectAt ( Resources::ItemVisual item,
const Common::Point pos 
)

Definition at line 191 of file gameinterface.cpp.

Common::Array< Common::Point > Stark::GameInterface::listExitPositions (  ) 

List all the exit positions.

Definition at line 272 of file gameinterface.cpp.

Resources::ActionArray Stark::GameInterface::listStockActionsPossibleForObject ( Resources::ItemVisual item  ) 

List the stock actions available for an item in the current game state (hand, mouth, eye).

Definition at line 210 of file gameinterface.cpp.

Resources::ActionArray Stark::GameInterface::listStockActionsPossibleForObjectAt ( Resources::ItemVisual item,
const Common::Point pos 
)

Definition at line 223 of file gameinterface.cpp.

void Stark::GameInterface::setAprilRunning (  ) 

Make April run if she is walking.

Definition at line 262 of file gameinterface.cpp.

bool Stark::GameInterface::skipCurrentSpeeches (  ) 

Skip currently playing speeches.

Returns:
true if at least one speech was skipped

Definition at line 53 of file gameinterface.cpp.

void Stark::GameInterface::walkTo ( const Common::Point mouse  ) 

Make April try to go to the location under the cursor.

Definition at line 79 of file gameinterface.cpp.


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


Generated on Sat Jan 19 2019 05:07:30 for ResidualVM by doxygen 1.7.1
curved edge   curved edge