#include <sound.h>
Inheritance diagram for Engines::KotOR::SoundObject:
Collaboration diagram for Engines::KotOR::SoundObject:
Public Member Functions | |
| SoundObject (const Aurora::GFF3Struct &sound) | |
| void | setPosition (float x, float y, float z) |
| Set the object's position within its area. More... | |
| void | play () |
| void | stop () |
 Public Member Functions inherited from Engines::KotOR::Object | |
| Object (ObjectType type=kObjectTypeInvalid) | |
| virtual | ~Object () |
| ObjectType | getType () const |
| Return the exact type of the object. More... | |
| virtual void | show () |
| Show the object's model(s). More... | |
| virtual void | hide () |
| Hide the object's model(s). More... | |
| virtual void | hideSoft () |
| Hide the object's model(s) if applicable. More... | |
| virtual bool | isVisible () const |
| Is the object's model(s) visible? More... | |
| const std::list< uint32 > & | getIDs () const |
| Return the object's model IDs. More... | |
| const Common::UString & | getName () const |
| Return the object's name. More... | |
| const Common::UString & | getDescription () const |
| Return the object's description. More... | |
| const Common::UString & | getPortrait () const |
| Return the object's portrait. More... | |
| void | setMaxHitPoints (int maxHP) |
| Set the maximum hit points for the objects. More... | |
| int | getMaxHitPoints () |
| Get the maximum hit points for the objects. More... | |
| void | setCurrentHitPoints (int hitpoints) |
| Set the current hitpoints. More... | |
| int | getCurrentHitPoints () |
| Return the objects current hitpoints. More... | |
| void | setMinOneHitPoints (bool enabled) |
| Set if the object has a minimum of one hp. More... | |
| bool | getMinOneHitPoints () const |
| Get if the object has a minimum of one hp. 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... | |
| 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... | |
| virtual void | setOrientation (float x, float y, float z, float angle) |
| Set the object's orientation. More... | |
| void | makeLookAt (float x, float y) |
| void | makeLookAt (Object *target) |
| Room * | getRoom () |
| Get a room the object is in. More... | |
| void | setRoom (Room *room) |
| Set a room the object is in. 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 | stopSound () |
| Stop the current object sound. More... | |
| void | playSound (const Common::UString &sound, bool pitchVariance=false) |
| Play an object sound. More... | |
| virtual void | playAnimation (const Common::UString &anim, bool restart=true, float length=0.0f, float speed=1.0f) |
| Public Member Functions inherited from Aurora::NWScript::Object | |
| Object () | |
| uint32 | getID () const |
| const Common::UString & | getTag () const |
| Public Member Functions inherited from Aurora::NWScript::VariableContainer | |
| VariableContainer () | |
| virtual | ~VariableContainer () |
| bool | hasVariable (const Common::UString &var) const |
| Variable & | getVariable (const Common::UString &var, Type type=kTypeVoid) |
| const Variable & | getVariable (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::KotOR::ScriptContainer | |
| ScriptContainer () | |
| ~ScriptContainer () | |
| const Common::UString & | getScript (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()) |
Private Attributes | |
| bool | _positional |
| bool | _looping |
| bool | _random |
| unsigned int | _interval |
| std::vector< Common::UString > | _soundFiles |
| Sound::ChannelHandle | _sound |
Additional Inherited Members | |
| Static Public Member Functions inherited from Engines::KotOR::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()) |
| Protected Member Functions inherited from Engines::KotOR::ScriptContainer | |
| void | clearScripts () |
| void | readScripts (const Aurora::GFF3Struct &gff, bool clear=true) |
| void | readScripts (const ScriptContainer &container) |
| Protected Attributes inherited from Engines::KotOR::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 | _portrait |
| The object's portrait. More... | |
| bool | _static |
| Is the object static? More... | |
| bool | _usable |
| Is the object usable? More... | |
| int | _currentHitPoints |
| The current hitpoints of the object. More... | |
| int | _maxHitPoints |
| The maximum hitpoints of the object. More... | |
| bool | _minOneHitPoint |
| If the object should have at least one hitpoint. More... | |
| std::list< uint32 > | _ids |
| The object's model IDs. 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... | |
| Room * | _room |
| Room the object is in. More... | |
| Protected Attributes inherited from Aurora::NWScript::Object | |
| uint32 | _id |
| Common::UString | _tag |
Detailed Description
Constructor & Destructor Documentation
◆ SoundObject()
| Engines::KotOR::SoundObject::SoundObject | ( | const Aurora::GFF3Struct & | sound | ) |
Definition at line 38 of file sound.cpp.
References _interval, _looping, Engines::KotOR::Object::_name, _positional, _random, _sound, _soundFiles, Aurora::NWScript::Object::_tag, Common::UString::c_str(), Common::UString::empty(), Aurora::GFF3Struct::getDouble(), Aurora::GFF3Struct::getString(), Aurora::kFileTypeUTS, Aurora::kResourceSound, Sound::kSoundTypeSFX, Engines::loadOptionalGFF3(), MKTAG, play(), Common::ScopedPtrBase< T, Deallocator >::reset(), ResMan, setPosition(), and SoundMan.
Here is the call graph for this function:
Member Function Documentation
◆ play()
| void Engines::KotOR::SoundObject::play | ( | ) |
Definition at line 99 of file sound.cpp.
References _sound, and SoundMan.
Referenced by SoundObject(), and Engines::KotOR::Functions::soundObjectPlay().
Here is the caller graph for this function:
◆ setPosition()
|
virtual |
Set the object's position within its area.
Reimplemented from Engines::KotOR::Object.
Definition at line 92 of file sound.cpp.
References _positional, _sound, Engines::KotOR::Object::setPosition(), and SoundMan.
Referenced by SoundObject().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ stop()
| void Engines::KotOR::SoundObject::stop | ( | ) |
Definition at line 103 of file sound.cpp.
References _sound, and SoundMan.
Referenced by Engines::KotOR::Functions::soundObjectStop().
Here is the caller graph for this function:
Member Data Documentation
◆ _interval
|
private |
Definition at line 50 of file sound.h.
Referenced by SoundObject().
◆ _looping
|
private |
Definition at line 47 of file sound.h.
Referenced by SoundObject().
◆ _positional
|
private |
Definition at line 46 of file sound.h.
Referenced by setPosition(), and SoundObject().
◆ _random
|
private |
Definition at line 48 of file sound.h.
Referenced by SoundObject().
◆ _sound
|
private |
Definition at line 54 of file sound.h.
Referenced by play(), setPosition(), SoundObject(), and stop().
◆ _soundFiles
|
private |
Definition at line 52 of file sound.h.
Referenced by SoundObject().
The documentation for this class was generated from the following files:
