EndSequence Class Reference

#include <endsequence.hpp>

Inherits GameObject.

Inherited by EndSequenceFireworks, EndSequenceWalkLeft, and EndSequenceWalkRight.

List of all members.

Public Member Functions
	EndSequence ()
virtual	~EndSequence ()
virtual void	update (float elapsed_time)
	This function is called once per frame and allows the object to update it's state.
virtual void	draw (DrawingContext &context)
	The GameObject should draw itself onto the provided DrawingContext if this function is called.
void	start ()
	play EndSequence
void	stop_tux ()
	called when Tux has reached his final position
void	stop ()
	stop playing EndSequence, mark it as done playing
bool	is_tux_stopped ()
	returns true if Tux has reached his final position
bool	is_done ()
	returns true if EndSequence has finished playing
Protected Member Functions
virtual void	starting ()
	called when EndSequence starts
virtual void	running (float elapsed_time)
	called while the EndSequence is running
virtual void	stopping ()
	called when EndSequence stops
Protected Attributes
bool	isrunning
	true while EndSequence plays
bool	isdone
	true if EndSequence has finished playing
bool	tux_may_walk
	true while tux is allowed to walk
CodeController *	end_sequence_controller
Private Member Functions
	EndSequence (const EndSequence &)
EndSequence &	operator= (const EndSequence &)

---

Detailed Description

Definition at line 23 of file endsequence.hpp.

---

Constructor & Destructor Documentation

EndSequence::EndSequence

(

)

Definition at line 22 of file endsequence.cpp.

                         :
  isrunning(false), 
  isdone(false), 
  tux_may_walk(true),
  end_sequence_controller(0)
{  
}

EndSequence::~EndSequence

(

)

[virtual]

Definition at line 30 of file endsequence.cpp.

References end_sequence_controller.

{
  delete end_sequence_controller;
}

EndSequence::EndSequence

(

const EndSequence &

)

[private]

---

Member Function Documentation

void EndSequence::update

(

float

elapsed_time

)

[virtual]

This function is called once per frame and allows the object to update it's state.

The elapsed_time is the time since the last frame in seconds and should be the base for all timed calculations (don't use SDL_GetTicks directly as this will fail in pause mode)

Implements GameObject.

Definition at line 36 of file endsequence.cpp.

References isrunning, and running().

Referenced by GameSession::update().

{
  if (!isrunning) return;
  running(elapsed_time);
}

void EndSequence::draw

(

DrawingContext &

context

)

[virtual]

The GameObject should draw itself onto the provided DrawingContext if this function is called.

Implements GameObject.

Reimplemented in EndSequenceFireworks, EndSequenceWalkLeft, and EndSequenceWalkRight.

Definition at line 43 of file endsequence.cpp.

{
}

void EndSequence::start

(

)

play EndSequence

Definition at line 48 of file endsequence.cpp.

References Sector::current(), end_sequence_controller, isdone, isrunning, Sector::player, Player::set_controller(), Player::set_speedlimit(), and starting().

Referenced by GameSession::start_sequence().

{
  if (isrunning) return;
  isrunning = true;
  isdone = false;

  Player& tux = *Sector::current()->player;
  end_sequence_controller = new CodeController();
  tux.set_controller(end_sequence_controller);
  tux.set_speedlimit(230); //MAX_WALK_XM

  starting();
}

void EndSequence::stop_tux

(

)

called when Tux has reached his final position

Definition at line 63 of file endsequence.cpp.

References tux_may_walk.

Referenced by GameSession::start_sequence().

{
  tux_may_walk = false;
}

void EndSequence::stop

(

)

stop playing EndSequence, mark it as done playing

Definition at line 69 of file endsequence.cpp.

References isdone, isrunning, and stopping().

{
  if (!isrunning) return;
  isrunning = false;
  isdone = true;
  stopping();
}

bool EndSequence::is_tux_stopped

(

)

returns true if Tux has reached his final position

Definition at line 78 of file endsequence.cpp.

References tux_may_walk.

Referenced by GameSession::update().

{
  return !tux_may_walk;
}

bool EndSequence::is_done

(

)

returns true if EndSequence has finished playing

Definition at line 84 of file endsequence.cpp.

References isdone.

Referenced by GameSession::check_end_conditions().

{
  return isdone;
}

void EndSequence::starting

(

)

[protected, virtual]

called when EndSequence starts

Reimplemented in EndSequenceFireworks, EndSequenceWalkLeft, and EndSequenceWalkRight.

Definition at line 90 of file endsequence.cpp.

Referenced by start(), EndSequenceWalkRight::starting(), EndSequenceWalkLeft::starting(), and EndSequenceFireworks::starting().

{
}

void EndSequence::running

(

float

elapsed_time

)

[protected, virtual]

called while the EndSequence is running

Reimplemented in EndSequenceFireworks, EndSequenceWalkLeft, and EndSequenceWalkRight.

Definition at line 95 of file endsequence.cpp.

References end_sequence_controller, and CodeController::update().

Referenced by EndSequenceWalkRight::running(), EndSequenceWalkLeft::running(), EndSequenceFireworks::running(), and update().

{
  end_sequence_controller->update();
}

void EndSequence::stopping

(

)

[protected, virtual]

called when EndSequence stops

Reimplemented in EndSequenceFireworks, EndSequenceWalkLeft, and EndSequenceWalkRight.

Definition at line 101 of file endsequence.cpp.

Referenced by stop(), EndSequenceWalkRight::stopping(), EndSequenceWalkLeft::stopping(), and EndSequenceFireworks::stopping().

{
}

EndSequence& EndSequence::operator=

(

const EndSequence &

)

[private]

---

Member Data Documentation

bool EndSequence::isrunning [protected]

true while EndSequence plays

Definition at line 44 of file endsequence.hpp.

Referenced by start(), stop(), and update().

bool EndSequence::isdone [protected]

true if EndSequence has finished playing

Definition at line 45 of file endsequence.hpp.

Referenced by is_done(), EndSequenceWalkRight::running(), EndSequenceWalkLeft::running(), EndSequenceFireworks::running(), start(), and stop().

bool EndSequence::tux_may_walk [protected]

true while tux is allowed to walk

Definition at line 46 of file endsequence.hpp.

Referenced by is_tux_stopped(), EndSequenceWalkRight::running(), EndSequenceWalkLeft::running(), EndSequenceFireworks::running(), and stop_tux().

CodeController* EndSequence::end_sequence_controller [protected]

Definition at line 47 of file endsequence.hpp.

Referenced by EndSequenceWalkRight::running(), EndSequenceWalkLeft::running(), EndSequenceFireworks::running(), running(), start(), and ~EndSequence().

---

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

• src/object/endsequence.hpp
• src/object/endsequence.cpp

---