ScriptedObject Class Reference

#include <scripted_object.hpp>

Inherits MovingSprite, scripting::ScriptedObject, and ScriptInterface.

List of all members.

Public Member Functions
	ScriptedObject (const Reader &lisp)
virtual void	expose (HSQUIRRELVM vm, SQInteger table_idx)
virtual void	unexpose (HSQUIRRELVM vm, SQInteger table_idx)
void	update (float elapsed_time)
	This function is called once per frame and allows the object to update it's state.
void	draw (DrawingContext &context)
	The GameObject should draw itself onto the provided DrawingContext if this function is called.
void	collision_solid (const CollisionHit &hit)
	this function is called when the object collided with something solid
HitResponse	collision (GameObject &other, const CollisionHit &hit)
	this function is called when the object collided with any other object
void	set_action (const std::string &animation)
std::string	get_action ()
void	move (float x, float y)
void	set_pos (float x, float y)
float	get_pos_x ()
float	get_pos_y ()
void	set_velocity (float x, float y)
float	get_velocity_x ()
float	get_velocity_y ()
void	set_visible (bool visible)
bool	is_visible ()
void	set_solid (bool solid)
bool	is_solid ()
std::string	get_name ()
Private Attributes
Physic	physic
std::string	name
	a name for the gameobject, this is mostly a hint for scripts and for debugging, don't rely on names being set or being unique
bool	solid
bool	physic_enabled
bool	visible
bool	new_vel_set
Vector	new_vel

---

Detailed Description

Definition at line 25 of file scripted_object.hpp.

---

Constructor & Destructor Documentation

ScriptedObject::ScriptedObject

(

const Reader &

lisp

)

Definition at line 26 of file scripted_object.cpp.

References MovingObject::bbox, COLGROUP_DISABLED, COLGROUP_MOVING_STATIC, lisp::Lisp::get(), MovingSprite::layer, LAYER_OBJECTS, name, physic_enabled, reader_get_layer(), MovingObject::set_group(), Rectf::set_size(), solid, MovingSprite::sprite, and visible.

                                                 :
  MovingSprite(lisp, LAYER_OBJECTS, COLGROUP_MOVING_STATIC),
  physic(),
  name(),
  solid(true), 
  physic_enabled(true), 
  visible(true), 
  new_vel_set(false),
  new_vel()
{
  lisp.get("name", name);
  if(name == "")
    throw std::runtime_error("Scripted object must have a name specified");

  // FIXME: do we need this? bbox is already set via .sprite file
  float width = sprite->get_width();
  float height = sprite->get_height();
  lisp.get("width", width);
  lisp.get("height", height);
  bbox.set_size(width, height);

  lisp.get("solid", solid);
  lisp.get("physic-enabled", physic_enabled);
  lisp.get("visible", visible);
  layer = reader_get_layer (lisp, /* default = */ LAYER_OBJECTS);
  if( solid ){
    set_group( COLGROUP_MOVING_STATIC );
  } else {
    set_group( COLGROUP_DISABLED );
  }
}

---

Member Function Documentation

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

Implements ScriptInterface.

Definition at line 59 of file scripted_object.cpp.

References scripting::expose_object(), and name.

{
  if (name.empty()) return;
  expose_object(vm, table_idx, dynamic_cast<scripting::ScriptedObject *>(this), name, false);
}

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

Implements ScriptInterface.

Definition at line 66 of file scripted_object.cpp.

References name, and scripting::unexpose_object().

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

void ScriptedObject::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 165 of file scripted_object.cpp.

References Physic::get_movement(), MovingObject::movement, new_vel, new_vel_set, physic, physic_enabled, Physic::set_velocity(), Vector::x, and Vector::y.

{
  if(!physic_enabled)
    return;

  if(new_vel_set) {
    physic.set_velocity(new_vel.x, new_vel.y);
    new_vel_set = false;
  }
  movement = physic.get_movement(elapsed_time);
}

void ScriptedObject::draw

(

DrawingContext &

context

)

[virtual]

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

Reimplemented from MovingSprite.

Definition at line 178 of file scripted_object.cpp.

References MovingObject::get_pos(), MovingSprite::layer, MovingSprite::sprite, and visible.

{
  if(!visible)
    return;

  sprite->draw(context, get_pos(), layer);
}

void ScriptedObject::collision_solid

(

const CollisionHit &

hit

)

[virtual]

this function is called when the object collided with something solid

Reimplemented from MovingObject.

Definition at line 187 of file scripted_object.cpp.

References CollisionHit::bottom, Physic::get_velocity_y(), CollisionHit::left, physic, physic_enabled, CollisionHit::right, Physic::set_velocity_x(), Physic::set_velocity_y(), and CollisionHit::top.

{
  if(!physic_enabled)
    return;

  if(hit.bottom) {
    if(physic.get_velocity_y() > 0)
      physic.set_velocity_y(0);
  } else if(hit.top) {
    physic.set_velocity_y(.1f);
  }

  if(hit.left || hit.right) {
    physic.set_velocity_x(0);
  }
}

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

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

Implements MovingObject.

Definition at line 205 of file scripted_object.cpp.

References FORCE_MOVE.

{
  return FORCE_MOVE;
}

void ScriptedObject::set_action

(

const std::string &

animation

)

[virtual]

Implements scripting::ScriptedObject.

Definition at line 147 of file scripted_object.cpp.

References MovingSprite::sprite.

{
  sprite->set_action(animation);
}

std::string ScriptedObject::get_action

(

)

[virtual]

Implements scripting::ScriptedObject.

Definition at line 153 of file scripted_object.cpp.

References MovingSprite::sprite.

{
  return sprite->get_action();
}

void ScriptedObject::move	(	float	x,
		float	y
	)			[virtual]

Implements scripting::ScriptedObject.

Definition at line 73 of file scripted_object.cpp.

References MovingObject::bbox, and Rectf::move().

{
  bbox.move(Vector(x, y));
}

void ScriptedObject::set_pos	(	float	x,
		float	y
	)			[virtual]

Implements scripting::ScriptedObject.

Definition at line 79 of file scripted_object.cpp.

References MovingObject::bbox, physic, Physic::reset(), and Rectf::set_pos().

{
  printf("SetPos: %f %f\n", x, y);
  bbox.set_pos(Vector(x, y));
  physic.reset();
}

float ScriptedObject::get_pos_x

(

)

[virtual]

Implements scripting::ScriptedObject.

Definition at line 87 of file scripted_object.cpp.

References MovingObject::get_pos(), and Vector::x.

{
  return get_pos().x;
}

float ScriptedObject::get_pos_y

(

)

[virtual]

Implements scripting::ScriptedObject.

Definition at line 93 of file scripted_object.cpp.

References MovingObject::get_pos(), and Vector::y.

{
  return get_pos().y;
}

void ScriptedObject::set_velocity	(	float	x,
		float	y
	)			[virtual]

Implements scripting::ScriptedObject.

Definition at line 99 of file scripted_object.cpp.

References new_vel, and new_vel_set.

{
  new_vel = Vector(x, y);
  new_vel_set = true;
}

float ScriptedObject::get_velocity_x

(

)

[virtual]

Implements scripting::ScriptedObject.

Definition at line 106 of file scripted_object.cpp.

References Physic::get_velocity_x(), and physic.

{
  return physic.get_velocity_x();
}

float ScriptedObject::get_velocity_y

(

)

[virtual]

Implements scripting::ScriptedObject.

Definition at line 112 of file scripted_object.cpp.

References Physic::get_velocity_y(), and physic.

{
  return physic.get_velocity_y();
}

void ScriptedObject::set_visible

(

bool

visible

)

[virtual]

Implements scripting::ScriptedObject.

Definition at line 118 of file scripted_object.cpp.

{
  this->visible = visible;
}

bool ScriptedObject::is_visible

(

)

[virtual]

Implements scripting::ScriptedObject.

Definition at line 124 of file scripted_object.cpp.

References visible.

{
  return visible;
}

void ScriptedObject::set_solid

(

bool

solid

)

[virtual]

Implements scripting::ScriptedObject.

Definition at line 130 of file scripted_object.cpp.

References COLGROUP_DISABLED, COLGROUP_MOVING_STATIC, and MovingObject::set_group().

{
  this->solid = solid;
  if( solid ){
    set_group( COLGROUP_MOVING_STATIC );
  } else {
    set_group( COLGROUP_DISABLED );
  }
}

bool ScriptedObject::is_solid

(

)

[virtual]

Implements scripting::ScriptedObject.

Definition at line 141 of file scripted_object.cpp.

References solid.

{
  return solid;
}

std::string ScriptedObject::get_name

(

)

[virtual]

Implements scripting::ScriptedObject.

Definition at line 159 of file scripted_object.cpp.

References name.

{
  return name;
}

---

Member Data Documentation

Physic ScriptedObject::physic [private]

Definition at line 61 of file scripted_object.hpp.

Referenced by collision_solid(), get_velocity_x(), get_velocity_y(), set_pos(), and update().

std::string ScriptedObject::name [private]

a name for the gameobject, this is mostly a hint for scripts and for debugging, don't rely on names being set or being unique

Reimplemented from GameObject.

Definition at line 62 of file scripted_object.hpp.

Referenced by expose(), get_name(), ScriptedObject(), and unexpose().

bool ScriptedObject::solid [private]

Definition at line 63 of file scripted_object.hpp.

Referenced by is_solid(), and ScriptedObject().

bool ScriptedObject::physic_enabled [private]

Definition at line 64 of file scripted_object.hpp.

Referenced by collision_solid(), ScriptedObject(), and update().

bool ScriptedObject::visible [private]

Definition at line 65 of file scripted_object.hpp.

Referenced by draw(), is_visible(), and ScriptedObject().

bool ScriptedObject::new_vel_set [private]

Definition at line 66 of file scripted_object.hpp.

Referenced by set_velocity(), and update().

Vector ScriptedObject::new_vel [private]

Definition at line 67 of file scripted_object.hpp.

Referenced by set_velocity(), and update().

---

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

• src/object/scripted_object.hpp
• src/object/scripted_object.cpp

---