#include <waypoint.h>
Inheritance diagram for Engines::Jade::Waypoint:
Collaboration diagram for Engines::Jade::Waypoint:
Public Member Functions | |
| Waypoint (const Aurora::GFF3Struct &waypoint) | |
| Load from a waypoint instance. More... | |
| ~Waypoint () | |
| bool | hasMapNote () const |
| Does this waypoint have a map note? More... | |
| Common::UString | getMapNote () const |
| Return the waypoint's map note text. More... | |
| void | enableMapNote (bool enabled) |
| Enable/Disable the waypoint's map note. More... | |
| void | enableMapNoteDisplay (bool enabled) |
| Enable/Disable the display of the waypoint's map note. More... | |
 Public Member Functions inherited from Engines::Jade::Object | |
| Object (ObjectType type=kObjectTypeInvalid) | |
| virtual | ~Object () |
| ObjectType | getType () const |
| Return the exact type of the object. More... | |
| virtual void | loadModel () |
| Load the object's model(s). More... | |
| virtual void | unloadModel () |
| Unload the object's model(s). More... | |
| virtual void | show () |
| Show the object's model(s). More... | |
| virtual void | hide () |
| Hide the object's model(s). 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 & | getConversation () const |
| Return the object's default conversation (DLG). More... | |
| Aurora::NWScript::Object * | getPCSpeaker () const |
| Return the PC currently speaking with this object. More... | |
| void | setPCSpeaker (Aurora::NWScript::Object *pc) |
| Set the PC currently speaking with this object. 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 | isActive () const |
| Is the object currently active/available/visible? More... | |
| bool | isNoCollide () const |
| Is collision checking disabled? More... | |
| void | setNoCollide (bool noCollide) |
| Enable or disable collision checking. More... | |
| bool | isClickable () const |
| Can the player click the object? More... | |
| Area * | getArea () 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... | |
| virtual void | setPosition (float x, float y, float z) |
| Set the object's position within its area. More... | |
| virtual void | setOrientation (float x, float y, float z, float angle) |
| Set 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... | |
| Object * | getLastTriggerer () const |
| Return the object that last triggered this object. More... | |
| void | speakString (int32 resref) |
| Speak the specified string. More... | |
| virtual void | playAnimation (const Common::UString &animation="", bool restart=true, int32 loopCount=0) |
| Play an object animation. More... | |
| virtual void | playAnimation (Animation animation) |
| Play a default object animation. More... | |
| 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::Jade::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 Member Functions | |
| void | load (const Aurora::GFF3Struct &waypoint) |
| Load from a waypoint instance. More... | |
Private Attributes | |
| bool | _hasMapNote |
| Does this waypoint have a map note? More... | |
| bool | _displayMapNote |
| Does this waypoint show the map note? More... | |
| int | _mapNoteType |
| Type of map note. More... | |
| Common::UString | _mapNote |
| The waypoint's map note text. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Engines::Jade::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::Jade::Object | |
| void | loadPositional (const Aurora::GFF3Struct &gff) |
| Load the object's positional gff struct which contains the position and orientation. More... | |
| Protected Member Functions inherited from Engines::Jade::ScriptContainer | |
| void | clearScripts () |
| void | readScripts (const Aurora::GFF3Struct &gff) |
| void | readScripts (const ScriptContainer &container) |
| Protected Attributes inherited from Engines::Jade::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... | |
| bool | _static |
| Is the object static? More... | |
| bool | _usable |
| Is the object usable? More... | |
| bool | _active |
| Is the object currently active/available/visible? More... | |
| bool | _noCollide |
| Is collision checking for the object disabled? More... | |
| std::list< uint32 > | _ids |
| The object's model IDs. More... | |
| Aurora::NWScript::Object * | _pcSpeaker |
| The current PC speaking with the object. More... | |
| Area * | _area |
| The area the object is currently in. More... | |
| Object * | _lastTriggerer |
| The object that last used this object. More... | |
| float | _position [3] |
| The object's position. More... | |
| float | _orientation [4] |
| The object's orientation. More... | |
| Protected Attributes inherited from Aurora::NWScript::Object | |
| uint32 | _id |
| Common::UString | _tag |
Detailed Description
Definition at line 40 of file waypoint.h.
Constructor & Destructor Documentation
◆ Waypoint()
| Engines::Jade::Waypoint::Waypoint | ( | const Aurora::GFF3Struct & | waypoint | ) |
Load from a waypoint instance.
Definition at line 39 of file waypoint.cpp.
References load().
Here is the call graph for this function:
◆ ~Waypoint()
| Engines::Jade::Waypoint::~Waypoint | ( | ) |
Definition at line 45 of file waypoint.cpp.
References Engines::Jade::Object::hide().
Here is the call graph for this function:
Member Function Documentation
◆ enableMapNote()
| void Engines::Jade::Waypoint::enableMapNote | ( | bool | enabled | ) |
Enable/Disable the waypoint's map note.
Definition at line 74 of file waypoint.cpp.
References _hasMapNote.
◆ enableMapNoteDisplay()
| void Engines::Jade::Waypoint::enableMapNoteDisplay | ( | bool | enabled | ) |
Enable/Disable the display of the waypoint's map note.
Definition at line 78 of file waypoint.cpp.
References _displayMapNote.
◆ getMapNote()
| Common::UString Engines::Jade::Waypoint::getMapNote | ( | ) | const |
Return the waypoint's map note text.
Definition at line 70 of file waypoint.cpp.
References _mapNote.
◆ hasMapNote()
| bool Engines::Jade::Waypoint::hasMapNote | ( | ) | const |
Does this waypoint have a map note?
Definition at line 66 of file waypoint.cpp.
References _displayMapNote, and _hasMapNote.
◆ load()
|
private |
Load from a waypoint instance.
Definition at line 49 of file waypoint.cpp.
References _displayMapNote, _hasMapNote, _mapNote, _mapNoteType, Aurora::NWScript::Object::_tag, Aurora::GFF3Struct::getBool(), Aurora::GFF3Struct::getSint(), Aurora::GFF3Struct::getString(), Aurora::GFF3Struct::hasField(), and Engines::Jade::Object::loadPositional().
Referenced by Waypoint().
Here is the call graph for this function:
Here is the caller graph for this function:
Member Data Documentation
◆ _displayMapNote
|
private |
Does this waypoint show the map note?
Definition at line 61 of file waypoint.h.
Referenced by enableMapNoteDisplay(), hasMapNote(), and load().
◆ _hasMapNote
|
private |
Does this waypoint have a map note?
Definition at line 60 of file waypoint.h.
Referenced by enableMapNote(), hasMapNote(), and load().
◆ _mapNote
|
private |
The waypoint's map note text.
Definition at line 63 of file waypoint.h.
Referenced by getMapNote(), and load().
◆ _mapNoteType
|
private |
The documentation for this class was generated from the following files:
- src/engines/jade/waypoint.h
- src/engines/jade/waypoint.cpp
