Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

se_core::SpawnComponent Class Reference

#include <SpawnComponent.hpp>

Inheritance diagram for se_core::SpawnComponent:

se_core::Component List of all members.

Public Types

typedef ComponentPtr< SpawnComponent,
sct_SPAWN > 		Ptr

Public Member Functions

 SpawnComponent (Composite *owner, PosComponent *pos)
 SpawnComponent (Composite *owner, const ComponentFactory *factory)
virtual ~SpawnComponent ()
void cleanup ()
 Called by Composite.
Composite * spawner () const
 Returns pointer to the spawner of a thing, or null for no spawner.
Composite * spawn (const char *name, int spawnPointId, long deniedTsMask=0)
void incSpawnCount ()
void decSpawnCount ()
int spawnCount () const
void setSpawnPoints (int count, const ViewPoint *const *spawnPoints)
 Set the list of spawn points associated with this PosNode.
const ViewPoint * spawnPoint (short id) const
 Get the reference to a spawn point.
bool hasSpawnPoint (short id) const
int spawnPointCount () const
void setSpawner (Composite *spawner)
void resetSpawner ()
virtual void setDead ()
 Called by Composite.
virtual const char * name () const
 By default returns name of composite, which returns name of composite factory.
Composite * owner ()
const Composite * owner () const
 Component type.
Component * component (int type)
const Component * component (int type) const
int type () const
const ComponentFactory * factory ()
bool isActive ()
bool isDead () const

Static Public Member Functions

SpawnComponent * get (Composite &composite)
const SpawnComponent * get (const Composite &composite)
SpawnComponent * get (Component &component)
const SpawnComponent * get (const Component &component)

Protected Member Functions

virtual void setActive (bool state)
 Called by Composite.
virtual void parentChanged (Composite *newParent, Composite *oldParent)
 Called by Composite.
virtual void zoneChanged (int type, Composite *newArea, Composite *oldArea)
 Called by Composite.
virtual void init ()
 Called by Composite.

Protected Attributes

PosComponent * pos_
Composite::RefPtr spawner_
 The actor who spawned this thing.
int spawnCount_
int spawnPointCount_
 The number of spawn points.
const ViewPoint *const * spawnPoints_
 List of spawn points associated with this SpawnComponent.
int type_
 The type of Component.
Composite * owner_
const ComponentFactory * factory_

Friends

class Composite

Member Typedef Documentation

typedef ComponentPtr<SpawnComponent, sct_SPAWN> se_core::SpawnComponent::Ptr
 

Definition at line 35 of file SpawnComponent.hpp.

Constructor & Destructor Documentation

se_core::SpawnComponent::SpawnComponent (  Composite *  owner,
PosComponent *  pos
) 
 

Definition at line 33 of file SpawnComponent.cpp.

References se_core::sct_SPAWN.

se_core::SpawnComponent::SpawnComponent (  Composite *  owner,
const ComponentFactory *  factory
) 
 

Definition at line 38 of file SpawnComponent.cpp.

References Assert, se_core::sct_POS, and se_core::sct_SCRIPT.

se_core::SpawnComponent::~SpawnComponent (   )  [virtual]
 

Definition at line 47 of file SpawnComponent.cpp.

References se_core::IoSchema::cleanup().

Member Function Documentation

void se_core::SpawnComponent::cleanup (   )  [virtual]
 

Called by Composite.

Reimplemented from se_core::Component.

Definition at line 53 of file SpawnComponent.cpp.

const Component* se_core::Component::component (  int  type  )  const [inline, inherited]
 

Definition at line 71 of file Component.hpp.

References se_core::Component::component().

Component* se_core::Component::component (  int  type  )  [inline, inherited]
 

Definition at line 67 of file Component.hpp.

References se_core::Composite::component().

Referenced by se_core::Component::component(), se_core::Component::ComponentPtr< T, type >::ComponentPtr(), se_ogre::O3dThingComponent::get(), se_ogre::O3dNodeComponent::get(), and se_ogre::O3dAreaComponent::get().

void se_core::SpawnComponent::decSpawnCount (   )  [inline]
 

Definition at line 74 of file SpawnComponent.hpp.

const ComponentFactory* se_core::Component::factory (   )  [inline, inherited]
 

Definition at line 81 of file Component.hpp.

Referenced by se_core::Composite::releaseComponents().

const SpawnComponent* se_core::SpawnComponent::get (  const Component &  component  )  [inline, static]
 

Definition at line 56 of file SpawnComponent.hpp.

References se_core::Composite::component(), and se_core::Component::owner().

SpawnComponent* se_core::SpawnComponent::get (  Component &  component  )  [inline, static]
 

Definition at line 51 of file SpawnComponent.hpp.

References se_core::Composite::component(), and se_core::Component::owner().

const SpawnComponent* se_core::SpawnComponent::get (  const Composite &  composite  )  [inline, static]
 

Definition at line 46 of file SpawnComponent.hpp.

References se_core::Composite::component().

SpawnComponent* se_core::SpawnComponent::get (  Composite &  composite  )  [inline, static]
 

Definition at line 41 of file SpawnComponent.hpp.

References se_core::Composite::component().

bool se_core::SpawnComponent::hasSpawnPoint (  short  id  )  const
 

Definition at line 100 of file SpawnComponent.cpp.

Referenced by se_basic::SimpleAreaThingEncoder::encode().

void se_core::SpawnComponent::incSpawnCount (   )  [inline]
 

Definition at line 73 of file SpawnComponent.hpp.

void se_core::Component::init (   )  [protected, virtual, inherited]
 

Called by Composite.

Reimplemented in se_core::RootComponent, se_core::SignalAreaComponent, se_ogre::O3dAreaComponent, and se_ogre::O3dThingComponent.

Definition at line 42 of file Component.cpp.

Referenced by se_core::Composite::init().

bool se_core::Component::isActive (   )  [inherited]
 

Definition at line 26 of file Component.cpp.

bool se_core::Component::isDead (   )  const [inherited]
 

Definition at line 31 of file Component.cpp.

Referenced by se_core::Actor::affect().

const char * se_core::Component::name (   )  const [virtual, inherited]
 

By default returns name of composite, which returns name of composite factory.

Reimplemented in se_core::CutsceneAreaComponent, se_core::CutsceneComponent, se_core::CutsceneManager, se_core::CollisionAreaComponent, se_core::SignalAreaComponent, se_core::SignalComponent, se_core::SpawnAreaComponent, se_core::SpawnManager, se_core::ZoneAreaComponent, se_core::ZoneComponent, se_core::ZoneManager, se_basic::NavMeshAreaComponent, se_basic::NavMeshComponent, and se_basic::NavMeshManager.

Definition at line 21 of file Component.cpp.

Referenced by se_core::Area::addNeighbour(), se_core::DefaultTC::collide(), se_core::CoDefault::collide(), se_basic::Say::perform(), and se_ogre::SpeechBubble::speechEvent().

const Composite* se_core::Component::owner (   )  const [inline, inherited]
 

Component type.

Definition at line 62 of file Component.hpp.

Composite* se_core::Component::owner (   )  [inline, inherited]
 

Definition at line 54 of file Component.hpp.

Referenced by se_core::CollisionAreaComponent::_testCollisionCandidates(), se_core::CollisionAreaComponent::_testCollisionCandidates2(), se_core::HealthListeners::add(), se_core::ZoneAreaComponent::addNeighbour(), se_basic::PhTrackingCamera::affect(), se_core::HealthListeners::castHealthChangedEvent(), se_core::Component::ComponentPtr< T, type >::ComponentPtr(), se_ogre::ThingMOManager::create(), se_basic::SimpleAreaThingEncoder::encode(), get(), se_core::SignalComponent::get(), se_core::SignalAreaComponent::get(), se_core::ScriptComponent::get(), se_core::PosComponent::get(), se_core::PhysicsComponent::get(), se_core::StatComponent::get(), se_ogre::O3dThingComponent::get(), se_ogre::O3dNodeComponent::get(), se_ogre::O3dAreaComponent::get(), se_core::Pos::hasArea(), se_core::CollisionGrid::insert(), se_core::CollisionComponent::isCollideable(), se_core::ZoneComponent::name(), se_core::Component::ComponentPtr< T, type >::operator=(), se_core::DefaultTC::pop(), se_core::CoDefault::pop(), se_core::DefaultTC::popAndDie(), se_core::CoDefault::popAndDie(), se_core::CollisionAreaComponent::removeCollideable(), se_core::AreaManager::resetThings(), se_core::Actor::scheduleForDestruction(), se_core::AreaManager::setActive(), se_core::AreaManager::setInactive(), and se_ogre::O3dManager::updateStats().

virtual void se_core::Component::parentChanged (  Composite *  newParent,
Composite *  oldParent
)  [inline, protected, virtual, inherited]
 

Called by Composite.

Reimplemented in se_core::AreaChildComponent, and se_core::NodeComponent.

Definition at line 101 of file Component.hpp.

Referenced by se_core::Composite::resetParent(), and se_core::Composite::setParent().

void se_core::SpawnComponent::resetSpawner (   ) 
 

Definition at line 133 of file SpawnComponent.cpp.

virtual void se_core::Component::setActive (  bool  state  )  [inline, protected, virtual, inherited]
 

Called by Composite.

Reimplemented in se_core::RootChildComponent, se_core::ActionComponent, se_core::CutsceneAreaComponent, se_core::PhysicsAreaComponent, se_core::CollisionAreaComponent, se_core::ScriptComponent, se_core::SignalAreaComponent, se_core::SpawnAreaComponent, se_core::ZoneAreaComponent, se_client::CameraComponent, se_client::PlayerComponent, se_ogre::O3dAreaComponent, se_ogre::O3dThingComponent, and se_basic::NavMeshAreaComponent.

Definition at line 93 of file Component.hpp.

Referenced by se_core::Composite::setActive().

void se_core::SpawnComponent::setDead (   )  [virtual]
 

Called by Composite.

Reimplemented from se_core::Component.

Definition at line 143 of file SpawnComponent.cpp.

void se_core::SpawnComponent::setSpawner (  Composite *  spawner  ) 
 

Definition at line 124 of file SpawnComponent.cpp.

References Assert, and se_core::Composite::ref().

void se_core::SpawnComponent::setSpawnPoints (  int  count,
const ViewPoint *const *  spawnPoints
) 
 

Set the list of spawn points associated with this PosNode.

Parameters:
count the number of spawn points
spawnPoints the list of spawn points

Definition at line 91 of file SpawnComponent.cpp.

References AssertFatal.

Composite * se_core::SpawnComponent::spawn (  const char *  name,
int  spawnPointId,
long  deniedTsMask = 0
) 
 

Definition at line 59 of file SpawnComponent.cpp.

References se_core::ViewPoint::add(), se_core::Pos::area(), Assert, AssertFatal, se_core::ViewPoint::coor_, LogWarning, se_core::ViewPoint::sub(), and se_core::Pos::world_.

int se_core::SpawnComponent::spawnCount (   )  const [inline]
 

Definition at line 75 of file SpawnComponent.hpp.

Composite * se_core::SpawnComponent::spawner (   )  const
 

Returns pointer to the spawner of a thing, or null for no spawner.

A Thing cannot (by definition) collide with an Actor that spawned it. (TODO: Can a Thing be spawned? Will not all spawned things have the ability to perform Action?)

Definition at line 115 of file SpawnComponent.cpp.

const ViewPoint * se_core::SpawnComponent::spawnPoint (  short  id  )  const
 

Get the reference to a spawn point.

Parameters:
id the id of the sapwn points

Definition at line 107 of file SpawnComponent.cpp.

References AssertFatal.

Referenced by se_basic::SimpleAreaThingEncoder::encode().

int se_core::SpawnComponent::spawnPointCount (   )  const [inline]
 

Definition at line 90 of file SpawnComponent.hpp.

Referenced by se_basic::SimpleAreaThingEncoder::encode().

int se_core::Component::type (   )  const [inline, inherited]
 

Definition at line 76 of file Component.hpp.

Referenced by se_core::Composite::component().

void se_core::Component::zoneChanged (  int  type,
Composite *  newArea,
Composite *  oldArea
)  [protected, virtual, inherited]
 

Called by Composite.

Reimplemented in se_core::AreaChildComponent, se_core::CollisionComponent, and se_core::SignalComponent.

Definition at line 37 of file Component.cpp.

Referenced by se_core::Composite::zoneChanged().

Friends And Related Function Documentation

friend class Composite [friend, inherited]
 

Definition at line 89 of file Component.hpp.

Member Data Documentation

const ComponentFactory* se_core::Component::factory_ [protected, inherited]
 

Definition at line 120 of file Component.hpp.

Composite* se_core::Component::owner_ [protected, inherited]
 

Definition at line 118 of file Component.hpp.

PosComponent* se_core::SpawnComponent::pos_ [protected]
 

Definition at line 100 of file SpawnComponent.hpp.

int se_core::SpawnComponent::spawnCount_ [protected]
 

Definition at line 115 of file SpawnComponent.hpp.

Composite::RefPtr se_core::SpawnComponent::spawner_ [protected]
 

The actor who spawned this thing.

A bow shooter will for example spawn arrows when shooting. This variable is useful for making the shooter immune to shoots from his own arrows.

This variable also makes it possible to maintain a spawn counter which indicates how many *living* children an actor has spawned. This enables monster spawner's to create new children whenever they fall below a certain count.

Definition at line 113 of file SpawnComponent.hpp.

int se_core::SpawnComponent::spawnPointCount_ [protected]
 

The number of spawn points.

Definition at line 119 of file SpawnComponent.hpp.

const ViewPoint* const* se_core::SpawnComponent::spawnPoints_ [protected]
 

List of spawn points associated with this SpawnComponent.

Definition at line 122 of file SpawnComponent.hpp.

int se_core::Component::type_ [protected, inherited]
 

The type of Component.

Definition at line 117 of file Component.hpp.

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

Home Page | SagaEngine trunk (updated nightly) reference generated Sun Dec 2 20:06:28 2007 by Doxygen version 1.3.9.1.

SourceForge.net Logo