xoreos  0.0.5
Public Member Functions | Static Public Member Functions | Private Types | Private Attributes | List of all members
Engines::NWN::ObjectContainer Class Reference

#include <objectcontainer.h>

Inheritance diagram for Engines::NWN::ObjectContainer:
Inheritance graph
[legend]
Collaboration diagram for Engines::NWN::ObjectContainer:
Collaboration graph
[legend]

Public Member Functions

 ObjectContainer ()
 
 ~ObjectContainer ()
 
void clearObjects ()
 
void addObject (NWN::Object &object)
 Add an object to this container. More...
 
void removeObject (NWN::Object &object)
 Remove an object from this container. More...
 
::Aurora::NWScript::Object * getFirstObjectByType (ObjectType type) const
 Return the first object of this type. More...
 
::Aurora::NWScript::ObjectSearch * findObjectsByType (ObjectType type) const
 Return a search context to iterate over all objects of this type. More...
 
- Public Member Functions inherited from Aurora::NWScript::ObjectContainer
 ObjectContainer ()
 
 ~ObjectContainer ()
 
void clearObjects ()
 
void addObject (Object &object)
 Add an object to this container. More...
 
void removeObject (Object &object)
 Remove an object from this container. More...
 
Object * getObjectByID (uint32 id) const
 Find a specific object by ID. More...
 
Object * getFirstObject () const
 Return the first object. More...
 
Object * getFirstObjectByTag (const Common::UString &tag) const
 Return the first object with this tag. More...
 
ObjectSearch * findObjects () const
 Return a search context to iterate over all objects. More...
 
ObjectSearch * findObjectsByTag (const Common::UString &tag) const
 Return a search context to iterate over all objects with this tag. More...
 

Static Public Member Functions

static NWN::Object * toObject (::Aurora::NWScript::Object *object)
 
static Module * toModule (Aurora::NWScript::Object *object)
 
static Area * toArea (Aurora::NWScript::Object *object)
 
static Waypoint * toWaypoint (Aurora::NWScript::Object *object)
 
static Situated * toSituated (Aurora::NWScript::Object *object)
 
static Placeable * toPlaceable (Aurora::NWScript::Object *object)
 
static Door * toDoor (Aurora::NWScript::Object *object)
 
static Creature * toCreature (Aurora::NWScript::Object *object)
 
static Creature * toPC (Aurora::NWScript::Object *object)
 
static Location * toLocation (Aurora::NWScript::EngineType *engineType)
 

Private Types

typedef std::list< NWN::Object * > ObjectList
 
typedef std::map< ObjectType, ObjectList > ObjectMap
 

Private Attributes

ObjectMap _objects
 

Additional Inherited Members

- Protected Member Functions inherited from Aurora::NWScript::ObjectContainer
void lock ()
 
void unlock ()
 

Detailed Description

Definition at line 64 of file objectcontainer.h.

Member Typedef Documentation

◆ ObjectList

typedef std::list<NWN::Object *> Engines::NWN::ObjectContainer::ObjectList
private

Definition at line 96 of file objectcontainer.h.

◆ ObjectMap

typedef std::map<ObjectType, ObjectList> Engines::NWN::ObjectContainer::ObjectMap
private

Definition at line 97 of file objectcontainer.h.

Constructor & Destructor Documentation

◆ ObjectContainer()

Engines::NWN::ObjectContainer::ObjectContainer ( )

Definition at line 69 of file objectcontainer.cpp.

◆ ~ObjectContainer()

Engines::NWN::ObjectContainer::~ObjectContainer ( )

Definition at line 72 of file objectcontainer.cpp.

Member Function Documentation

◆ addObject()

void Engines::NWN::ObjectContainer::addObject ( NWN::Object &  object)

Add an object to this container.

Definition at line 85 of file objectcontainer.cpp.

References _objects, Aurora::NWScript::ObjectContainer::addObject(), Aurora::NWScript::ObjectContainer::lock(), and Aurora::NWScript::ObjectContainer::unlock().

Referenced by Engines::NWN::Area::Area(), Engines::NWN::Area::loadObject(), and Engines::NWN::Module::usePC().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ clearObjects()

void Engines::NWN::ObjectContainer::clearObjects ( )

Definition at line 75 of file objectcontainer.cpp.

References _objects, Aurora::NWScript::ObjectContainer::clearObjects(), Aurora::NWScript::ObjectContainer::lock(), and Aurora::NWScript::ObjectContainer::unlock().

Here is the call graph for this function:

◆ findObjectsByType()

Aurora::NWScript::ObjectSearch * Engines::NWN::ObjectContainer::findObjectsByType ( ObjectType  type) const

Return a search context to iterate over all objects of this type.

Definition at line 115 of file objectcontainer.cpp.

References _objects.

◆ getFirstObjectByType()

Aurora::NWScript::Object * Engines::NWN::ObjectContainer::getFirstObjectByType ( ObjectType  type) const

Return the first object of this type.

Definition at line 105 of file objectcontainer.cpp.

References _objects, and Aurora::NWScript::SearchRange< T >::get().

Here is the call graph for this function:

◆ removeObject()

void Engines::NWN::ObjectContainer::removeObject ( NWN::Object &  object)

Remove an object from this container.

Definition at line 95 of file objectcontainer.cpp.

References _objects, Aurora::NWScript::ObjectContainer::lock(), Aurora::NWScript::ObjectContainer::removeObject(), and Aurora::NWScript::ObjectContainer::unlock().

Referenced by Engines::NWN::Area::clear(), Engines::NWN::Module::unloadPC(), and Engines::NWN::Area::~Area().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ toArea()

Area * Engines::NWN::ObjectContainer::toArea ( Aurora::NWScript::Object *  object)
static

Definition at line 133 of file objectcontainer.cpp.

Referenced by Engines::NWN::Functions::location(), Engines::NWN::Functions::musicBackgroundChangeDay(), Engines::NWN::Functions::musicBackgroundChangeNight(), Engines::NWN::Functions::musicBackgroundGetDayTrack(), Engines::NWN::Functions::musicBackgroundGetNightTrack(), Engines::NWN::Functions::musicBackgroundPlay(), and Engines::NWN::Functions::musicBackgroundStop().

Here is the caller graph for this function:

◆ toCreature()

Creature * Engines::NWN::ObjectContainer::toCreature ( Aurora::NWScript::Object *  object)
static

Definition at line 153 of file objectcontainer.cpp.

Referenced by Engines::NWN::Functions::addHenchman(), Engines::NWN::Functions::getAbilityScore(), Engines::NWN::Functions::getAlignmentGoodEvil(), Engines::NWN::Functions::getAlignmentLawChaos(), Engines::NWN::Functions::getAssociate(), Engines::NWN::Functions::getClassByPosition(), Engines::NWN::Functions::getCommandable(), Engines::NWN::Functions::getGender(), Engines::NWN::Functions::getGoodEvilValue(), Engines::NWN::Functions::getHasFeat(), Engines::NWN::Functions::getHenchman(), Engines::NWN::Functions::getHitDice(), Engines::NWN::Functions::getIsDead(), Engines::NWN::Functions::getIsDM(), Engines::NWN::Functions::getLawChaosValue(), Engines::NWN::Functions::getLevelByClass(), Engines::NWN::Functions::getLevelByPosition(), Engines::NWN::Functions::getMaster(), Engines::NWN::Functions::getNearestCreature(), Engines::NWN::Functions::getRacialType(), Engines::NWN::Functions::getSkillRank(), Engines::NWN::Functions::getXP(), Engines::NWN::Functions::removeHenchman(), and Engines::NWN::Functions::setCommandable().

Here is the caller graph for this function:

◆ toDoor()

Door * Engines::NWN::ObjectContainer::toDoor ( Aurora::NWScript::Object *  object)
static

Definition at line 149 of file objectcontainer.cpp.

Referenced by Engines::NWN::Functions::actionCloseDoor(), and Engines::NWN::Functions::actionOpenDoor().

Here is the caller graph for this function:

◆ toLocation()

Location * Engines::NWN::ObjectContainer::toLocation ( Aurora::NWScript::EngineType *  engineType)
static

Definition at line 165 of file objectcontainer.cpp.

Referenced by Engines::NWN::Functions::actionMoveToLocation(), Engines::NWN::Functions::getPositionFromLocation(), and Engines::NWN::Functions::jumpToLocation().

Here is the caller graph for this function:

◆ toModule()

Module * Engines::NWN::ObjectContainer::toModule ( Aurora::NWScript::Object *  object)
static

Definition at line 129 of file objectcontainer.cpp.

◆ toObject()

NWN::Object * Engines::NWN::ObjectContainer::toObject ( ::Aurora::NWScript::Object *  object)
static

Definition at line 125 of file objectcontainer.cpp.

Referenced by Engines::NWN::Functions::actionCloseDoor(), Engines::NWN::Functions::actionMoveToLocation(), Engines::NWN::Functions::actionMoveToObject(), Engines::NWN::Functions::actionOpenDoor(), Engines::NWN::Functions::actionSpeakString(), Engines::NWN::Functions::actionStartConversation(), Engines::NWN::Functions::beginConversation(), Engines::NWN::Functions::getArea(), Engines::NWN::Functions::getDistanceToObject(), Engines::NWN::Functions::getLocation(), Engines::NWN::Functions::getName(), Engines::NWN::Functions::getNearestCreature(), Engines::NWN::Functions::getNearestObject(), Engines::NWN::Functions::getNearestObjectByTag(), Engines::NWN::Functions::getObjectType(), Engines::NWN::Functions::getParamObject(), Engines::NWN::Functions::getPCSpeaker(), Engines::NWN::Functions::getPosition(), Engines::NWN::Functions::isInConversation(), Engines::NWN::Functions::jumpTo(), Engines::NWN::Functions::jumpToLocation(), Engines::NWN::Functions::jumpToObject(), Engines::NWN::Functions::playAnimation(), Engines::NWN::Functions::playSound(), Engines::NWN::Functions::playSoundByStrRef(), Engines::NWN::Functions::playVoiceChat(), Engines::NWN::Functions::speakOneLinerConversation(), Engines::NWN::Functions::speakString(), and Engines::NWN::Functions::speakStringByStrRef().

Here is the caller graph for this function:

◆ toPC()

Creature * Engines::NWN::ObjectContainer::toPC ( Aurora::NWScript::Object *  object)
static

Definition at line 157 of file objectcontainer.cpp.

References Engines::NWN::Creature::isPC().

Referenced by Engines::NWN::Functions::actionStartConversation(), Engines::NWN::Functions::beginConversation(), Engines::NWN::Functions::getIsPC(), and Engines::NWN::Functions::sendMessageToPC().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ toPlaceable()

Placeable * Engines::NWN::ObjectContainer::toPlaceable ( Aurora::NWScript::Object *  object)
static

Definition at line 145 of file objectcontainer.cpp.

◆ toSituated()

Situated * Engines::NWN::ObjectContainer::toSituated ( Aurora::NWScript::Object *  object)
static

Definition at line 141 of file objectcontainer.cpp.

Referenced by Engines::NWN::Functions::getIsOpen(), Engines::NWN::Functions::getLastClosedBy(), Engines::NWN::Functions::getLastOpenedBy(), Engines::NWN::Functions::getLastUsedBy(), Engines::NWN::Functions::getLocked(), and Engines::NWN::Functions::setLocked().

Here is the caller graph for this function:

◆ toWaypoint()

Waypoint * Engines::NWN::ObjectContainer::toWaypoint ( Aurora::NWScript::Object *  object)
static

Definition at line 137 of file objectcontainer.cpp.

Referenced by Engines::NWN::Functions::getWaypointByTag().

Here is the caller graph for this function:

Member Data Documentation

◆ _objects

ObjectMap Engines::NWN::ObjectContainer::_objects
private

Definition at line 99 of file objectcontainer.h.

Referenced by addObject(), clearObjects(), findObjectsByType(), getFirstObjectByType(), and removeObject().

The documentation for this class was generated from the following files:
Generated on Sun Nov 18 2018 15:13:53 for xoreos by   doxygen 1.8.14