xoreos  0.0.5
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
Engines::NWN2::Situated Class Referenceabstract

#include <situated.h>

Inheritance diagram for Engines::NWN2::Situated:
Inheritance graph
[legend]
Collaboration diagram for Engines::NWN2::Situated:
Collaboration graph
[legend]

Public Member Functions

 ~Situated ()
 
void loadModel ()
 Load the situated object's model. More...
 
void unloadModel ()
 Unload the situated object's model. More...
 
void show ()
 Show the situated object's model. More...
 
void hide ()
 Hide the situated object's model. More...
 
virtual bool isOpen () const =0
 Is the situated object open? More...
 
bool isLocked () const
 Is the situated object locked? More...
 
virtual void setLocked (bool locked)
 Lock/Unlock the situated object. More...
 
ObjectgetLastOpenedBy () const
 Return the object that last opened this situated object. More...
 
ObjectgetLastClosedBy () const
 Return the object that last closed this situated object. More...
 
ObjectgetLastUsedBy () const
 Return the object that last used this situated object. More...
 
void setPosition (float x, float y, float z)
 Set the situated object's position. More...
 
void setOrientation (float x, float y, float z, float angle)
 Set the situated object's orientation. More...
 
- Public Member Functions inherited from Engines::NWN2::Object
 Object (ObjectType type=kObjectTypeInvalid)
 
virtual ~Object ()
 
ObjectType getType () const
 Return the exact type of the object. More...
 
const std::list< uint32 > & getIDs () const
 Return the object's model IDs. More...
 
const Common::UStringgetName () const
 Return the object's name. More...
 
const Common::UStringgetDescription () const
 Return the object's description. More...
 
const Common::UStringgetConversation () const
 Return the object's default conversation (DLG). More...
 
const Aurora::SSFFilegetSSF ()
 Return the object's sound set. More...
 
bool isStatic () const
 Is the object static (not manipulable at all)? More...
 
bool isUsable () const
 Can the object be used by the PC? More...
 
bool isClickable () const
 Can the player click the object? More...
 
AreagetArea () const
 Return the area this object is currently in. More...
 
void setArea (Area *)
 Set the area this object is currently in. More...
 
virtual void getPosition (float &x, float &y, float &z) const
 Return the object's position within its area. More...
 
virtual void getOrientation (float &x, float &y, float &z, float &angle) const
 Return the object's orientation. More...
 
Location getLocation () const
 Create a Location out of the object's area, position and orientation. More...
 
virtual void enter ()
 The cursor entered the object. More...
 
virtual void leave ()
 The cursor left the object. More...
 
virtual void highlight (bool enabled)
 (Un)Highlight the object. More...
 
virtual bool click (Object *triggerer=0)
 The object was clicked. More...
 
void speakString (const Common::UString &string, uint32 volume)
 Speak the specified string. More...
 
void speakOneLiner (Common::UString conv, Object *tokenTarget=0)
 Speak an one-liner from the specified conversation file. More...
 
void stopSound ()
 Stop the current object sound. More...
 
void playSound (const Common::UString &sound, bool pitchVariance=false)
 Play an object sound. More...
 
- Public Member Functions inherited from Aurora::NWScript::Object
 Object ()
 
uint32 getID () const
 
const Common::UStringgetTag () const
 
- Public Member Functions inherited from Aurora::NWScript::VariableContainer
 VariableContainer ()
 
virtual ~VariableContainer ()
 
bool hasVariable (const Common::UString &var) const
 
VariablegetVariable (const Common::UString &var, Type type=kTypeVoid)
 
const VariablegetVariable (const Common::UString &var) const
 
void setVariable (const Common::UString &var, const Variable &value)
 
void removeVariable (const Common::UString &var)
 
void clearVariables ()
 
- Public Member Functions inherited from Engines::NWN2::ScriptContainer
 ScriptContainer ()
 
 ~ScriptContainer ()
 
const Common::UStringgetScript (Script script) const
 
bool hasScript (Script script) const
 
bool runScript (Script script, const Aurora::NWScript::ObjectReference owner=Aurora::NWScript::ObjectReference(), const Aurora::NWScript::ObjectReference triggerer=Aurora::NWScript::ObjectReference())
 

Protected Member Functions

 Situated (ObjectType type)
 
void load (const Aurora::GFF3Struct &instance, const Aurora::GFF3Struct *blueprint=0)
 Load the situated object from an instance and its blueprint. More...
 
virtual void loadObject (const Aurora::GFF3Struct &gff)=0
 Load object-specific properties. More...
 
virtual void loadAppearance ()=0
 Load appearance-specific properties. More...
 
- Protected Member Functions inherited from Engines::NWN2::Object
void loadSSF ()
 Load the object's sound set. More...
 
void readVarTable (const Aurora::GFF3List &varTable)
 Read the object's variable table. More...
 
void readVarTable (const Aurora::GFF3Struct &gff)
 
- Protected Member Functions inherited from Engines::NWN2::ScriptContainer
void clearScripts ()
 
void readScripts (const Aurora::GFF3Struct &gff)
 
void readScripts (const ScriptContainer &container)
 

Protected Attributes

Common::UString _modelName
 The model's resource name. More...
 
uint32 _appearanceID
 The index within the situated appearance 2DA. More...
 
uint32 _soundAppType
 The index within the situated sounds 2DA. More...
 
bool _locked
 Is the situated object locked? More...
 
Common::UString _soundOpened
 The sound the object makes when opened. More...
 
Common::UString _soundClosed
 The sound the object makes when closed. More...
 
Common::UString _soundDestroyed
 The sound the object makes when destroyed. More...
 
Common::UString _soundUsed
 The sound the object makes when used. More...
 
Common::UString _soundLocked
 The sound the object makes when locked. More...
 
float _tint [3][4]
 
Object_lastOpenedBy
 The object that last opened this situated object. More...
 
Object_lastClosedBy
 The object that last closed this situated object. More...
 
Object_lastUsedBy
 The object that last used this situated object. More...
 
Common::ScopedPtr< Graphics::Aurora::Model_model
 The situated object's model. More...
 
- Protected Attributes inherited from Engines::NWN2::Object
ObjectType _type
 The object's type. More...
 
Common::UString _name
 The object's display name. More...
 
Common::UString _description
 The object's description. More...
 
Common::UString _conversation
 The object's default conversation. More...
 
uint32 _soundSet
 The object's sound set, as an index into soundset.2da. More...
 
Common::ScopedPtr< Aurora::SSFFile_ssf
 The object's sound set. More...
 
bool _static
 Is the object static? More...
 
bool _usable
 Is the object usable? More...
 
std::list< uint32_ids
 The object's model IDs. More...
 
Area_area
 The area the object is currently in. More...
 
float _position [3]
 The object's position. More...
 
float _orientation [4]
 The object's orientation. More...
 
Sound::ChannelHandle _sound
 The currently playing object sound. More...
 
- Protected Attributes inherited from Aurora::NWScript::Object
uint32 _id
 
Common::UString _tag
 

Private Member Functions

void loadProperties (const Aurora::GFF3Struct &gff)
 
void loadSounds ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Engines::NWN2::ScriptContainer
static bool runScript (const Common::UString &script, const Aurora::NWScript::ObjectReference owner=Aurora::NWScript::ObjectReference(), const Aurora::NWScript::ObjectReference triggerer=Aurora::NWScript::ObjectReference())
 
static bool runScript (const Common::UString &script, const Aurora::NWScript::ScriptState &state, const Aurora::NWScript::ObjectReference owner=Aurora::NWScript::ObjectReference(), const Aurora::NWScript::ObjectReference triggerer=Aurora::NWScript::ObjectReference())
 

Detailed Description

Definition at line 40 of file situated.h.

Constructor & Destructor Documentation

◆ ~Situated()

Engines::NWN2::Situated::~Situated ( )

Definition at line 56 of file situated.cpp.

◆ Situated()

Engines::NWN2::Situated::Situated ( ObjectType  type)
protected

Definition at line 47 of file situated.cpp.

References _tint.

Member Function Documentation

◆ getLastClosedBy()

Object * Engines::NWN2::Situated::getLastClosedBy ( ) const

Return the object that last closed this situated object.

Definition at line 139 of file situated.cpp.

References _lastClosedBy.

Referenced by Engines::NWN2::Functions::getLastClosedBy().

Here is the caller graph for this function:

◆ getLastOpenedBy()

Object * Engines::NWN2::Situated::getLastOpenedBy ( ) const

Return the object that last opened this situated object.

Definition at line 135 of file situated.cpp.

References _lastOpenedBy.

Referenced by Engines::NWN2::Functions::getLastOpenedBy().

Here is the caller graph for this function:

◆ getLastUsedBy()

Object * Engines::NWN2::Situated::getLastUsedBy ( ) const

Return the object that last used this situated object.

Definition at line 143 of file situated.cpp.

References _lastUsedBy.

Referenced by Engines::NWN2::Functions::getLastUsedBy().

Here is the caller graph for this function:

◆ hide()

void Engines::NWN2::Situated::hide ( )
virtual

Hide the situated object's model.

Reimplemented from Engines::NWN2::Object.

Definition at line 106 of file situated.cpp.

References _model.

Referenced by Engines::NWN2::Placeable::hide(), Engines::NWN2::Door::hide(), and unloadModel().

Here is the caller graph for this function:

◆ isLocked()

bool Engines::NWN2::Situated::isLocked ( ) const

◆ isOpen()

virtual bool Engines::NWN2::Situated::isOpen ( ) const
pure virtual

Is the situated object open?

Implemented in Engines::NWN2::Door, and Engines::NWN2::Placeable.

Referenced by Engines::NWN2::Functions::getIsOpen().

Here is the caller graph for this function:

◆ load()

void Engines::NWN2::Situated::load ( const Aurora::GFF3Struct instance,
const Aurora::GFF3Struct blueprint = 0 
)
protected

Load the situated object from an instance and its blueprint.

Definition at line 147 of file situated.cpp.

References _appearanceID, Aurora::GFF3Struct::getDouble(), Aurora::GFF3Struct::getStruct(), Aurora::GFF3Struct::hasField(), Aurora::kFieldIDInvalid, loadAppearance(), loadObject(), loadProperties(), loadSounds(), Common::rad2deg(), setOrientation(), and setPosition().

Referenced by Engines::NWN2::Placeable::load(), and Engines::NWN2::Door::load().

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

◆ loadAppearance()

virtual void Engines::NWN2::Situated::loadAppearance ( )
protectedpure virtual

Load appearance-specific properties.

Implemented in Engines::NWN2::Placeable, and Engines::NWN2::Door.

Referenced by load().

Here is the caller graph for this function:

◆ loadModel()

void Engines::NWN2::Situated::loadModel ( )
virtual

◆ loadObject()

virtual void Engines::NWN2::Situated::loadObject ( const Aurora::GFF3Struct gff)
protectedpure virtual

Load object-specific properties.

Implemented in Engines::NWN2::Placeable, and Engines::NWN2::Door.

Referenced by load().

Here is the caller graph for this function:

◆ loadProperties()

void Engines::NWN2::Situated::loadProperties ( const Aurora::GFF3Struct gff)
private

◆ loadSounds()

void Engines::NWN2::Situated::loadSounds ( )
private

Definition at line 241 of file situated.cpp.

References _soundAppType, _soundClosed, _soundDestroyed, _soundLocked, _soundOpened, _soundUsed, Aurora::TwoDAFile::getRow(), Aurora::TwoDARow::getString(), Aurora::kFieldIDInvalid, and TwoDAReg.

Referenced by load().

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

◆ setLocked()

void Engines::NWN2::Situated::setLocked ( bool  locked)
virtual

Lock/Unlock the situated object.

Reimplemented in Engines::NWN2::Door.

Definition at line 131 of file situated.cpp.

References _locked.

Referenced by Engines::NWN2::Door::setLocked(), and Engines::NWN2::Functions::setLocked().

Here is the caller graph for this function:

◆ setOrientation()

void Engines::NWN2::Situated::setOrientation ( float  x,
float  y,
float  z,
float  angle 
)
virtual

Set the situated object's orientation.

Reimplemented from Engines::NWN2::Object.

Definition at line 119 of file situated.cpp.

References _model, Engines::NWN2::Object::getOrientation(), and Engines::NWN2::Object::setOrientation().

Referenced by load(), and loadModel().

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

◆ setPosition()

void Engines::NWN2::Situated::setPosition ( float  x,
float  y,
float  z 
)
virtual

Set the situated object's position.

Reimplemented from Engines::NWN2::Object.

Definition at line 111 of file situated.cpp.

References _model, Engines::NWN2::Object::getPosition(), and Engines::NWN2::Object::setPosition().

Referenced by load(), and loadModel().

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

◆ show()

void Engines::NWN2::Situated::show ( )
virtual

Show the situated object's model.

Reimplemented from Engines::NWN2::Object.

Definition at line 101 of file situated.cpp.

References _model.

Referenced by Engines::NWN2::Placeable::show(), and Engines::NWN2::Door::show().

Here is the caller graph for this function:

◆ unloadModel()

void Engines::NWN2::Situated::unloadModel ( )
virtual

Unload the situated object's model.

Reimplemented from Engines::NWN2::Object.

Definition at line 95 of file situated.cpp.

References _model, hide(), and Common::ScopedPtrBase< T, Deallocator >::reset().

Here is the call graph for this function:

Member Data Documentation

◆ _appearanceID

uint32 Engines::NWN2::Situated::_appearanceID
protected

The index within the situated appearance 2DA.

Definition at line 77 of file situated.h.

Referenced by load(), Engines::NWN2::Door::loadAppearance(), Engines::NWN2::Placeable::loadAppearance(), and loadProperties().

◆ _lastClosedBy

Object* Engines::NWN2::Situated::_lastClosedBy
protected

The object that last closed this situated object.

Definition at line 91 of file situated.h.

Referenced by Engines::NWN2::Placeable::close(), Engines::NWN2::Door::close(), and getLastClosedBy().

◆ _lastOpenedBy

Object* Engines::NWN2::Situated::_lastOpenedBy
protected

The object that last opened this situated object.

Definition at line 90 of file situated.h.

Referenced by getLastOpenedBy(), Engines::NWN2::Placeable::open(), and Engines::NWN2::Door::open().

◆ _lastUsedBy

Object* Engines::NWN2::Situated::_lastUsedBy
protected

The object that last used this situated object.

Definition at line 92 of file situated.h.

Referenced by Engines::NWN2::Door::click(), Engines::NWN2::Placeable::click(), and getLastUsedBy().

◆ _locked

bool Engines::NWN2::Situated::_locked
protected

Is the situated object locked?

Definition at line 80 of file situated.h.

Referenced by isLocked(), loadProperties(), and setLocked().

◆ _model

Common::ScopedPtr<Graphics::Aurora::Model> Engines::NWN2::Situated::_model
protected

◆ _modelName

Common::UString Engines::NWN2::Situated::_modelName
protected

The model's resource name.

Definition at line 75 of file situated.h.

Referenced by Engines::NWN2::Door::loadAppearance(), Engines::NWN2::Placeable::loadAppearance(), and loadModel().

◆ _soundAppType

uint32 Engines::NWN2::Situated::_soundAppType
protected

The index within the situated sounds 2DA.

Definition at line 78 of file situated.h.

Referenced by Engines::NWN2::Placeable::loadAppearance(), Engines::NWN2::Door::loadAppearance(), and loadSounds().

◆ _soundClosed

Common::UString Engines::NWN2::Situated::_soundClosed
protected

The sound the object makes when closed.

Definition at line 83 of file situated.h.

Referenced by Engines::NWN2::Placeable::close(), Engines::NWN2::Door::close(), and loadSounds().

◆ _soundDestroyed

Common::UString Engines::NWN2::Situated::_soundDestroyed
protected

The sound the object makes when destroyed.

Definition at line 84 of file situated.h.

Referenced by loadSounds().

◆ _soundLocked

Common::UString Engines::NWN2::Situated::_soundLocked
protected

◆ _soundOpened

Common::UString Engines::NWN2::Situated::_soundOpened
protected

The sound the object makes when opened.

Definition at line 82 of file situated.h.

Referenced by loadSounds(), Engines::NWN2::Placeable::open(), and Engines::NWN2::Door::open().

◆ _soundUsed

Common::UString Engines::NWN2::Situated::_soundUsed
protected

The sound the object makes when used.

Definition at line 85 of file situated.h.

Referenced by Engines::NWN2::Placeable::activate(), Engines::NWN2::Placeable::deactivate(), and loadSounds().

◆ _tint

float Engines::NWN2::Situated::_tint[3][4]
protected

Definition at line 88 of file situated.h.

Referenced by loadModel(), loadProperties(), and Situated().


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