Main Page Namespace List Class Hierarchy Compound List File List Compound Members File Members Related Pages

GameObject Class Reference

#include <object.h>

Inheritance diagram for GameObject:


Public Methods
	GameObject (ObjectManager &, string name="")
	Constructor.
	~GameObject ()
	Destructor.
virtual Rect	draw (Graphics &GD)
	draws onto a given Graphics Device
virtual Rect	draw (Surface *s)
	Draws onto a given Surface.
virtual void	animate ()
	Calls the animate sprite function.
virtual void	think ()
	Overload this function to give your object a way to do things.
virtual int	SetPosition (double x, double y)
	Sets the position of the sprite in Subworld-Space.
virtual int	Recenter ()
	Recenter the object based on the subworld.
Sprite *	getSprite () const
	Returns a pointer to the sprite object.
string	getName () const
	Returns a string that defines the name of this object.
void	SetDead (bool b)
	If this field is true, the object manager will remove this object from its list.
bool	IsDead () const
	Returns the status of dead.
Rect	GetBoundingRect ()
	Get the bounding rectangle of the object.
bool	IsCollidable ()
	Returns the status of collision.
void	SetCollidable (bool b)
	Sets the collision status of this object.
bool	IsDamagable () const
	Returns the damagable status of this object.
void	SetDamagable (bool b)
	Sets the damagable status of this object.
int	GetXint () const
	Returns the X position rounded to an integer.
int	GetYint () const
	Returns the Y position rounded to an integer.
double	GetX () const
	Returns the actual X position as a double.
double	GetY () const
	Returns the actual Y position as a double.
int	GetLayer () const
	Returns the layer of the object.
void	SetLayer (int l)
	Sets the layer of the object.
void	Damage (double howmuch=1)
	Damages the object.
void	SetDamage (double howhigh=1)
	Sets how much damage an object can take.
Protected Attributes
Sprite *	sprite
	Access this only when necessary.
double	Xpos
	X/Y positions for object.
double	Ypos
	X/Y positions for object.
int	Xposi
	X/Y positions as rounded integers.
int	Yposi
	X/Y positions as rounded integers.
ObjectManager &	OM
	Reference to the ObjMgr.
Private Attributes
string	name
bool	dead
bool	collide
bool	damagable
int	layer
double	damage

Constructor & Destructor Documentation

GameObject::GameObject ( ObjectManager & ,

string name = ""

)

Constructor.
Constructor takes a reference to the ObjectManager and a name for this object.
Parameters:

name the name of the object

See also:
~GameObject()

Definition at line 5 of file object.cpp.
References collide, damagable, dead, layer, name, sprite, Xpos, and Ypos.

GameObject::~GameObject ( )

Destructor.
The destructor of GameObject
See also:
GameObject()

Definition at line 16 of file object.cpp.
References sprite.

Member Function Documentation

virtual void GameObject::animate ( ) [inline, virtual]

Calls the animate sprite function.
Calls the animation function of a sprite if the object has a sprite.
See also:
think(), draw(Graphics &GD)

Definition at line 56 of file object.h.

void GameObject::Damage ( double howmuch = 1 )

Damages the object.
Damages the object with a default power of 1

If damage goes to 0, SetDead(true) is called.

Parameters:

howmuch the strength of the damage taken

See also:
SetDamage(double howhigh)

Definition at line 98 of file object.cpp.
References damage, IsDamagable(), and SetDead().
Referenced by ExplodeObject::think().

virtual Rect GameObject::draw ( Surface * s ) [inline, virtual]

Draws onto a given Surface.
Draws the sprite of the current object if it has one.
Parameters:

s A surface to draw to

See also:
draw(Graphics &GD)

Returns:
A rectangle describing the area drawn to or R(-9999,-9999,0,0) if not drawn.

Definition at line 49 of file object.h.

virtual Rect GameObject::draw ( Graphics & GD ) [inline, virtual]

draws onto a given Graphics Device
Draws the sprite of the current object if it has one.
Parameters:

GD the graphics device to draw to

See also:
draw(Surface *s)

Returns:
A rectangle describing the area drawn to or R(-9999,-9999,0,0) if not drawn.

Definition at line 40 of file object.h.

Rect GameObject::GetBoundingRect ( )

Get the bounding rectangle of the object.
If the object has a sprite, this returns bounding box that describes the current frame of the sprite. Otherwise, returns Rect(0,0,0,0). NOTE: the rect that is returned is in SubWorld space.
Returns:
a rectangle describing the shape of the bounding box.

Definition at line 51 of file object.cpp.
References Sprite::GetHeight(), ObjectManager::GetSubWorld(), Sprite::GetWidth(), Sprite::GetX(), Sprite::GetY(), OM, Rect, SubWorld::ScreenToSubWorld(), sprite, and Util_BuildRect().

int GameObject::GetLayer ( ) const

Returns the layer of the object.

Returns:
the value of the layer the object is in

See also:
ObjectManager, SetLayer(int)

Definition at line 88 of file object.cpp.
References layer.
Referenced by ObjectManager::AddToAnyObjectList(), and ObjectManager::think().

string GameObject::getName ( ) const [inline]

Returns a string that defines the name of this object.

this name might be different from the sprite->name
Returns:
a string containing the name of the Object.

Definition at line 104 of file object.h.

Sprite* GameObject::getSprite ( ) const [inline]

Returns a pointer to the sprite object.

dangerous is the object doesn't have a sprite
See also:
getName()

Returns:
a pointer to the object's sprite private member.

Definition at line 96 of file object.h.
Referenced by MainChar::FireWeapon().

double GameObject::GetX ( ) const

Returns the actual X position as a double.

Returns:
the actual floating point X value

Definition at line 68 of file object.cpp.
References Xpos.
Referenced by MainChar::FireWeapon(), Game::GameLoop(), Crosshair::Recenter(), MainChar::think(), Crosshair::think(), and Bear::think().

int GameObject::GetXint ( ) const

Returns the X position rounded to an integer.

Returns:
the X value as a rounded integer

Definition at line 78 of file object.cpp.
References Xposi.
Referenced by Game::GameLoop(), MainChar::think(), and ExplodeObject::think().

double GameObject::GetY ( ) const

Returns the actual Y position as a double.

Returns:
the actual floating point Y value

Definition at line 73 of file object.cpp.
References Ypos.
Referenced by ObjectManager::AddToAnyObjectList(), MainChar::FireWeapon(), Game::GameLoop(), Crosshair::Recenter(), Bear::setWalk(), ObjectManager::think(), MainChar::think(), Crosshair::think(), and Bear::think().

int GameObject::GetYint ( ) const

Returns the Y position rounded to an integer.

Returns:
the Y value as a rounded integer

Definition at line 83 of file object.cpp.
References Yposi.
Referenced by Game::GameLoop(), MainChar::think(), and ExplodeObject::think().

bool GameObject::IsCollidable ( ) [inline]

Returns the status of collision.

Returns:
true if this object can be collided into (i.e. can't walk through it)

Definition at line 135 of file object.h.

bool GameObject::IsDamagable ( ) const [inline]

Returns the damagable status of this object.

Returns:
true if this object can be damaged and/or killed

Definition at line 148 of file object.h.
Referenced by Damage(), and ExplodeObject::think().

bool GameObject::IsDead ( ) const [inline]

Returns the status of dead.

Returns:
true if object is dead; false otherwise.

Definition at line 119 of file object.h.
Referenced by ExplodeObject::think().

int GameObject::Recenter ( ) [virtual]

Recenter the object based on the subworld.
Will relocate the Sprite (if our object has one) to the correct location based on the SubWorld's background location.
Reimplemented in Crosshair, and MainChar.
Definition at line 36 of file object.cpp.
References SubWorld::GetBackground(), Sprite::GetHeight(), ObjectManager::GetSubWorld(), Background::GetY(), OM, Sprite::SetPosition(), sprite, and Ypos.
Referenced by Crosshair::Recenter(), and SetPosition().

void GameObject::SetCollidable ( bool b ) [inline]

Sets the collision status of this object.

Parameters:

b set to true if this object is impassible.

See also:
IsCollidable()

Definition at line 142 of file object.h.
Referenced by Bear::Bear(), and UFO::UFO().

void GameObject::SetDamagable ( bool b ) [inline]

Sets the damagable status of this object.

Parameters:

b set to true if this object can be damaged and/or killed

Definition at line 154 of file object.h.
Referenced by Bear::Bear(), MainChar::MainChar(), and UFO::UFO().

void GameObject::SetDamage ( double howhigh = 1 )

Sets how much damage an object can take.
Determines the amount of damage an object can take before SetDead(true) is called.
See also:
Damage(double howmuch)

Definition at line 110 of file object.cpp.
References damage.
Referenced by Bear::Bear(), MainChar::MainChar(), and UFO::UFO().

void GameObject::SetDead ( bool b ) [inline]

If this field is true, the object manager will remove this object from its list.
If the object is dead, the ObjectManager should remove this object from memory.
Parameters:

b sets the status of dead

See also:
IsDead()

Definition at line 113 of file object.h.
Referenced by Damage(), and ExplodeObject::think().

void GameObject::SetLayer ( int l )

Sets the layer of the object.

Parameters:

l the value of the layer

See also:
GetLayer(), ObjectManager

Definition at line 93 of file object.cpp.
References layer.
Referenced by Crosshair::Crosshair().

int GameObject::SetPosition ( double x,

double y

) [virtual]

Sets the position of the sprite in Subworld-Space.

positions are rounded to nearest integer

if x or y is "off screen" then the object is either clipped or not-visible (only when Object HasA sprite)
x,y are relations to the CENTER of the object.
x,y are also in subworld-coordinates
Parameters:

x the X parameter of the position in SubWorld space

y the Y parameter of the position in SubWorld space

See also:
Recenter()

Returns:
the value returned from Sprite::SetPosition() or 0.

Reimplemented in Crosshair.
Definition at line 24 of file object.cpp.
References Recenter(), Xpos, Xposi, Ypos, and Yposi.
Referenced by BearSpawnPoint::BearSpawnPoint(), ExplodeObject::ExplodeObject(), MainChar::FireWeapon(), Game::Game(), Crosshair::SetPosition(), UFO::SetupPosition(), UFO::think(), MainChar::think(), BearSpawnPoint::think(), and Bear::think().

virtual void GameObject::think ( ) [inline, virtual]

Overload this function to give your object a way to do things.
The "brain" of an object. This function is called repeatedly between frames and you should overload this to describe how your object reacts to events in the game.
See also:
animate()

Reimplemented in Bear, BearSpawnPoint, Crosshair, ExplodeObject, MainChar, and UFO.
Definition at line 65 of file object.h.
Referenced by ObjectManager::think().

Member Data Documentation

bool GameObject::collide [private]

Definition at line 229 of file object.h.
Referenced by GameObject().

bool GameObject::damagable [private]

Definition at line 229 of file object.h.
Referenced by GameObject().

double GameObject::damage [private]

Definition at line 231 of file object.h.
Referenced by Damage(), and SetDamage().

bool GameObject::dead [private]

Definition at line 229 of file object.h.
Referenced by GameObject().

int GameObject::layer [private]

Definition at line 230 of file object.h.
Referenced by GameObject(), GetLayer(), and SetLayer().

string GameObject::name [private]

Definition at line 228 of file object.h.
Referenced by GameObject().

ObjectManager& GameObject::OM [protected]

Reference to the ObjMgr.

Definition at line 223 of file object.h.
Referenced by MainChar::FireWeapon(), GetBoundingRect(), Recenter(), MainChar::Recenter(), MainChar::think(), ExplodeObject::think(), BearSpawnPoint::think(), and Bear::think().

Sprite* GameObject::sprite [protected]

Access this only when necessary.

Definition at line 214 of file object.h.
Referenced by Bear::Bear(), MainChar::ChangeDirection(), Crosshair::Crosshair(), ExplodeObject::ExplodeObject(), GameObject(), GetBoundingRect(), MainChar::MainChar(), Recenter(), MainChar::Recenter(), Crosshair::Recenter(), MainChar::setLook(), Crosshair::SetPosition(), UFO::SetupDirection(), Bear::setWalk(), MainChar::setWalking(), Crosshair::think(), UFO::UFO(), and ~GameObject().

double GameObject::Xpos [protected]

X/Y positions for object.

Definition at line 217 of file object.h.
Referenced by GameObject(), GetX(), SetPosition(), Crosshair::SetPosition(), BearSpawnPoint::think(), and Bear::think().

int GameObject::Xposi [protected]

X/Y positions as rounded integers.

Definition at line 220 of file object.h.
Referenced by GetXint(), and SetPosition().

double GameObject::Ypos [protected]

X/Y positions for object.

Definition at line 217 of file object.h.
Referenced by GameObject(), GetY(), Recenter(), SetPosition(), Crosshair::SetPosition(), BearSpawnPoint::think(), and Bear::think().

int GameObject::Yposi [protected]

X/Y positions as rounded integers.

Definition at line 220 of file object.h.
Referenced by GetYint(), and SetPosition().

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

Generated on Sun Dec 8 12:02:21 2002 for nnc by

1.3-rc1

GameObject Class Reference

Public Methods

Protected Attributes

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation