Platform Class Reference

This class is the base class for platforms that tux can stand on. More...

#include <platform.hpp>

Inherits MovingSprite, and ScriptInterface.

Inherited by HurtingPlatform.

List of all members.

Public Member Functions
	Platform (const Reader &reader)
	Platform (const Platform &platform)
virtual HitResponse	collision (GameObject &other, const CollisionHit &hit)
	this function is called when the object collided with any other object
virtual void	update (float elapsed_time)
	This function is called once per frame and allows the object to update it's state.
const Vector &	get_speed () const
virtual void	expose (HSQUIRRELVM vm, SQInteger table_idx)
virtual void	unexpose (HSQUIRRELVM vm, SQInteger table_idx)
Path &	get_path ()
Scriptable Methods
void	goto_node (int node_no)
	Move platform until at given node, then stop.
void	start_moving ()
	Start moving platform.
void	stop_moving ()
	Stop platform at next node.
Private Attributes
std::auto_ptr< Path >	path
std::auto_ptr< PathWalker >	walker
Vector	speed
bool	automatic
	true if Platform will automatically pick a destination based on collisions and current Player position
bool	player_contact
	true if a Player touched the Platform during the last round of collision detections
bool	last_player_contact
	true if a Player touched the Platform during the round before the last round of collision detections

---

Detailed Description

This class is the base class for platforms that tux can stand on.

Definition at line 27 of file platform.hpp.

---

Constructor & Destructor Documentation

Platform::Platform

(

const Reader &

reader

)

Definition at line 26 of file platform.cpp.

References automatic, MovingObject::bbox, lisp::Lisp::get(), lisp::Lisp::get_lisp(), GameObject::name, path, Rectf::set_pos(), and walker.

                                       :
  MovingSprite(reader, Vector(0,0), LAYER_OBJECTS, COLGROUP_STATIC), 
  path(),
  walker(),
  speed(Vector(0,0)), 
  automatic(false), 
  player_contact(false), 
  last_player_contact(false)
{
  bool running = true;
  reader.get("name", name);
  reader.get("running", running);
  if ((name == "") && (!running)) automatic=true;
  const lisp::Lisp* pathLisp = reader.get_lisp("path");
  if(pathLisp == NULL)
    throw std::runtime_error("No path specified for platform");
  path.reset(new Path());
  path->read(*pathLisp);
  walker.reset(new PathWalker(path.get(), running));
  bbox.set_pos(path->get_base());
}

Platform::Platform

(

const Platform &

platform

)

---

Member Function Documentation

HitResponse Platform::collision	(	GameObject &	other,
		const CollisionHit &	hit
	)			[virtual]

this function is called when the object collided with any other object

Implements MovingObject.

Reimplemented in HurtingPlatform.

Definition at line 65 of file platform.cpp.

References FORCE_MOVE, and player_contact.

{
  if (dynamic_cast<Player*>(&other)) player_contact = true;
  return FORCE_MOVE;
}

void Platform::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)

Reimplemented from MovingSprite.

Definition at line 72 of file platform.cpp.

References automatic, Sector::current(), Sector::get_players(), MovingObject::get_pos(), goto_node(), last_player_contact, MovingObject::movement, path, player_contact, speed, and walker.

{
  // check if Platform should automatically pick a destination
  if (automatic) {

    if (!player_contact && !walker->is_moving()) {
      // Player doesn't touch platform and Platform is not moving

      // Travel to node nearest to nearest player
      // FIXME: does not really use nearest player
      Player* player = 0;      
      std::vector<Player*> players = Sector::current()->get_players();
      for (std::vector<Player*>::iterator playerIter = players.begin(); playerIter != players.end(); ++playerIter) {
        player = *playerIter;
      }
      if (player) {
        int nearest_node_id = path->get_nearest_node_no(player->get_bbox().p2);
        if (nearest_node_id != -1) {
          goto_node(nearest_node_id);
        }
      }
    } 

    if (player_contact && !last_player_contact && !walker->is_moving()) {
      // Player touched platform, didn't touch last frame and Platform is not moving

      // Travel to node farthest from current position
      int farthest_node_id = path->get_farthest_node_no(get_pos());
      if (farthest_node_id != -1) {
        goto_node(farthest_node_id);
      } 
    }

    // Clear player_contact flag set by collision() method
    last_player_contact = player_contact;
    player_contact = false;
  }

  movement = walker->advance(elapsed_time) - get_pos();
  speed = movement / elapsed_time;
}

const Vector& Platform::get_speed

(

)

const [inline]

Definition at line 37 of file platform.hpp.

References speed.

  {
    return speed;
  }

void Platform::goto_node

(

int

node_no

)

Move platform until at given node, then stop.

Definition at line 115 of file platform.cpp.

References walker.

Referenced by scripting::Platform::goto_node(), and update().

{
  walker->goto_node(node_no);
}

void Platform::start_moving

(

)

Start moving platform.

Definition at line 121 of file platform.cpp.

References walker.

Referenced by scripting::Platform::start_moving().

{
  walker->start_moving();
}

void Platform::stop_moving

(

)

Stop platform at next node.

Definition at line 127 of file platform.cpp.

References walker.

Referenced by scripting::Platform::stop_moving().

{
  walker->stop_moving();
}

void Platform::expose	(	HSQUIRRELVM	vm,
		SQInteger	table_idx
	)			[virtual]

Implements ScriptInterface.

Definition at line 133 of file platform.cpp.

References scripting::expose_object(), and GameObject::name.

{
  if (name.empty()) return;
  scripting::Platform* _this = new scripting::Platform(this);
  expose_object(vm, table_idx, _this, name, true);
}

void Platform::unexpose	(	HSQUIRRELVM	vm,
		SQInteger	table_idx
	)			[virtual]

Implements ScriptInterface.

Definition at line 141 of file platform.cpp.

References GameObject::name, and scripting::unexpose_object().

{
  if (name.empty()) return;
  scripting::unexpose_object(vm, table_idx, name);
}

Path& Platform::get_path

(

)

[inline]

Definition at line 63 of file platform.hpp.

References path.

Referenced by FlipLevelTransformer::transform_platform().

                   {
    return *path.get();
  }

---

Member Data Documentation

std::auto_ptr<Path> Platform::path [private]

Definition at line 68 of file platform.hpp.

Referenced by get_path(), Platform(), and update().

std::auto_ptr<PathWalker> Platform::walker [private]

Definition at line 69 of file platform.hpp.

Referenced by goto_node(), Platform(), start_moving(), stop_moving(), and update().

Vector Platform::speed [private]

Definition at line 71 of file platform.hpp.

Referenced by get_speed(), and update().

bool Platform::automatic [private]

true if Platform will automatically pick a destination based on collisions and current Player position

Definition at line 73 of file platform.hpp.

Referenced by Platform(), and update().

bool Platform::player_contact [private]

true if a Player touched the Platform during the last round of collision detections

Definition at line 74 of file platform.hpp.

Referenced by collision(), and update().

bool Platform::last_player_contact [private]

true if a Player touched the Platform during the round before the last round of collision detections

Definition at line 75 of file platform.hpp.

Referenced by update().

---

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

• src/object/platform.hpp
• src/object/platform.cpp

---