terminus::AbstractPlayer Class Reference

The AbstractPlayer class is the base class for interacting with a train and a camera. More...

#include <abstractplayer.h>

Inheritance diagram for terminus::AbstractPlayer:

Public Member Functions
	AbstractPlayer (World &world, Train *train)
Camera &	camera ()
Train *	train ()
bool	hasWon ()
bool	hasLost ()
void	toggleCameraLock ()
unsigned int	selectedWagonIndex () const
void	switchToNextWagon ()
void	switchToPreviousWagon ()
void	switchToWagon (unsigned int wagonIndex)
virtual void	primaryAction ()
	Triggers the primary action of the currently selected wagon. More...
virtual void	primaryActionDebug ()
	Triggers the primary debug action of the currently selected wagon (typically the primary action without cooldown limitations etc.) More...
virtual void	animateHit ()
virtual void	update ()

Protected Member Functions
AbstractWagon *	selectedWagon ()

Protected Attributes
World &	m_world
Camera	m_camera
Train *	m_train
bool	m_animationInProgress
Timer::TimerID	m_animationTimer
unsigned int	m_selectedWagonIndex

Detailed Description

The AbstractPlayer class is the base class for interacting with a train and a camera.

Constructor & Destructor Documentation

terminus::AbstractPlayer::AbstractPlayer	(	World &	world,
		Train *	train
	)

Member Function Documentation

void terminus::AbstractPlayer::animateHit ( )

virtual

Camera & terminus::AbstractPlayer::camera

(

)

bool terminus::AbstractPlayer::hasLost

(

)

bool terminus::AbstractPlayer::hasWon

(

)

void terminus::AbstractPlayer::primaryAction ( )

virtual

Triggers the primary action of the currently selected wagon.

void terminus::AbstractPlayer::primaryActionDebug ( )

virtual

Triggers the primary debug action of the currently selected wagon (typically the primary action without cooldown limitations etc.)

AbstractWagon * terminus::AbstractPlayer::selectedWagon ( )

protected

unsigned int terminus::AbstractPlayer::selectedWagonIndex

(

)

const

void terminus::AbstractPlayer::switchToNextWagon

(

)

void terminus::AbstractPlayer::switchToPreviousWagon

(

)

void terminus::AbstractPlayer::switchToWagon

(

unsigned int

wagonIndex

)

void terminus::AbstractPlayer::toggleCameraLock

(

)

terminus::Train * terminus::AbstractPlayer::train

(

)

void terminus::AbstractPlayer::update ( )

virtual

Reimplemented in terminus::AIPlayer.

Member Data Documentation

bool terminus::AbstractPlayer::m_animationInProgress

protected

Timer::TimerID terminus::AbstractPlayer::m_animationTimer

protected

Camera terminus::AbstractPlayer::m_camera

protected

unsigned int terminus::AbstractPlayer::m_selectedWagonIndex

protected

Train* terminus::AbstractPlayer::m_train

protected

World& terminus::AbstractPlayer::m_world

protected

---

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

• source/player/abstractplayer.h
• source/player/abstractplayer.cpp