xoreos  0.0.5
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Engines::DragonAge::Waypoint Class Reference

#include <waypoint.h>

Inheritance diagram for Engines::DragonAge::Waypoint:
Inheritance graph
[legend]
Collaboration diagram for Engines::DragonAge::Waypoint:
Collaboration graph
[legend]

Public Member Functions

 Waypoint (const Aurora::GFF3Struct &waypoint)
 Load from a waypoint instance. More...
 
 ~Waypoint ()
 
int32 getGroup () const
 Return the ID of the group this waypoint belongs to. More...
 
bool hasMapNote () const
 Does this waypoint have a map note? More...
 
bool enabledMapNote () const
 Is the map note enabled? More...
 
void enableMapNote (bool enabled)
 Enable/Disable the waypoint's map note. More...
 
const Aurora::LocStringgetMapNote () const
 Return the waypoint's map note text. More...
 
const Common::UStringgetIcon () const
 Return the icon representing the waypoint on the map. More...
 
- Public Member Functions inherited from Engines::DragonAge::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...
 
const std::list< uint32 > & getIDs () const
 Return the object's model IDs. More...
 
const Common::UStringgetResRef () const
 Return the object's resource reference. More...
 
const Aurora::LocStringgetName () const
 Return the object's name. More...
 
const Aurora::LocStringgetDescription () const
 Return the object's description. More...
 
const Common::UStringgetConversation () const
 Return the object's default conversation (DLG). More...
 
const Common::UStringgetNonLocalizedName () const
 Return the object's non-localized name. More...
 
void setNonLocalizedName (const Common::UString &name)
 Set the object's non-localized name. 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 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...
 
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...
 
- 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::DragonAge::ScriptContainer
 ScriptContainer ()
 
 ~ScriptContainer ()
 
const Common::UStringgetScript () const
 
bool hasScript () const
 
void enableEvent (EventType event, bool enabled)
 Enable/Disable the handling of a specific event. More...
 
void enableEvents (bool enabled)
 Enable/Disable the handling of all events. More...
 
bool runScript (EventType event, const Aurora::NWScript::ObjectReference owner=Aurora::NWScript::ObjectReference(), const Aurora::NWScript::ObjectReference triggerer=Aurora::NWScript::ObjectReference())
 
bool runScript (Event &event)
 

Private Member Functions

void load (const Aurora::GFF3Struct &waypoint)
 

Private Attributes

int32 _group
 The ID of the group this waypoint belongs to. More...
 
bool _hasMapNote
 Does this waypoint have a map note? More...
 
bool _enabledMapNote
 Is this waypoint's map note enabled? More...
 
Aurora::LocString _mapNote
 The waypoint's map note text. More...
 
uint32 _type
 Index into the Waypoints MGDA. More...
 
Common::UString _icon
 The icon to show in the mini map for this waypoint. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Engines::DragonAge::ScriptContainer
static bool runScript (const Common::UString &script, EventType event, const Aurora::NWScript::ObjectReference owner=Aurora::NWScript::ObjectReference(), const Aurora::NWScript::ObjectReference triggerer=Aurora::NWScript::ObjectReference())
 
static bool runScript (const Common::UString &script, EventType event, const Aurora::NWScript::ScriptState &state, const Aurora::NWScript::ObjectReference owner=Aurora::NWScript::ObjectReference(), const Aurora::NWScript::ObjectReference triggerer=Aurora::NWScript::ObjectReference())
 
static bool runScript (const Common::UString &script, Event &event)
 
static bool runScript (const Common::UString &script, Event &event, const Aurora::NWScript::ScriptState &state)
 
- Protected Member Functions inherited from Engines::DragonAge::Object
void syncPosition ()
 
void syncOrientation ()
 
void readVarTable (const Aurora::GFF3List &varTable)
 
void readVarTable (const Aurora::GFF3Struct &gff)
 
void readVarTable (const Aurora::GFF4List &varTable)
 
void readVarTable (const Aurora::GFF4Struct &gff)
 
- Protected Member Functions inherited from Engines::DragonAge::ScriptContainer
void clearScript ()
 
void readScript (const Aurora::GFF3Struct &gff)
 
void readScript (const Aurora::GFF4Struct &gff)
 
- Protected Attributes inherited from Engines::DragonAge::Object
ObjectType _type
 The object's type. More...
 
Common::UString _resRef
 The object's resource reference. More...
 
Aurora::LocString _name
 The object's display name. More...
 
Aurora::LocString _description
 The object's description. More...
 
Common::UString _nonLocalizedName
 The object's non-localized name. More...
 
Common::UString _conversation
 The object's default conversation. More...
 
Common::UString _soundSet
 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...
 
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 37 of file waypoint.h.

Constructor & Destructor Documentation

◆ Waypoint()

Engines::DragonAge::Waypoint::Waypoint ( const Aurora::GFF3Struct waypoint)

Load from a waypoint instance.

Definition at line 38 of file waypoint.cpp.

References load().

Here is the call graph for this function:

◆ ~Waypoint()

Engines::DragonAge::Waypoint::~Waypoint ( )

Definition at line 42 of file waypoint.cpp.

Member Function Documentation

◆ enabledMapNote()

bool Engines::DragonAge::Waypoint::enabledMapNote ( ) const

Is the map note enabled?

Definition at line 53 of file waypoint.cpp.

References _enabledMapNote.

◆ enableMapNote()

void Engines::DragonAge::Waypoint::enableMapNote ( bool  enabled)

Enable/Disable the waypoint's map note.

Definition at line 57 of file waypoint.cpp.

References _enabledMapNote.

◆ getGroup()

int32 Engines::DragonAge::Waypoint::getGroup ( ) const

Return the ID of the group this waypoint belongs to.

Definition at line 45 of file waypoint.cpp.

References _group.

◆ getIcon()

const Common::UString & Engines::DragonAge::Waypoint::getIcon ( ) const

Return the icon representing the waypoint on the map.

Definition at line 65 of file waypoint.cpp.

References _icon.

◆ getMapNote()

const Aurora::LocString & Engines::DragonAge::Waypoint::getMapNote ( ) const

Return the waypoint's map note text.

Definition at line 61 of file waypoint.cpp.

References _mapNote.

◆ hasMapNote()

bool Engines::DragonAge::Waypoint::hasMapNote ( ) const

Does this waypoint have a map note?

Definition at line 49 of file waypoint.cpp.

References _hasMapNote.

◆ load()

void Engines::DragonAge::Waypoint::load ( const Aurora::GFF3Struct waypoint)
private

Member Data Documentation

◆ _enabledMapNote

bool Engines::DragonAge::Waypoint::_enabledMapNote
private

Is this waypoint's map note enabled?

Definition at line 68 of file waypoint.h.

Referenced by enabledMapNote(), enableMapNote(), and load().

◆ _group

int32 Engines::DragonAge::Waypoint::_group
private

The ID of the group this waypoint belongs to.

Definition at line 65 of file waypoint.h.

Referenced by getGroup(), and load().

◆ _hasMapNote

bool Engines::DragonAge::Waypoint::_hasMapNote
private

Does this waypoint have a map note?

Definition at line 67 of file waypoint.h.

Referenced by hasMapNote(), and load().

◆ _icon

Common::UString Engines::DragonAge::Waypoint::_icon
private

The icon to show in the mini map for this waypoint.

Definition at line 77 of file waypoint.h.

Referenced by getIcon(), and load().

◆ _mapNote

Aurora::LocString Engines::DragonAge::Waypoint::_mapNote
private

The waypoint's map note text.

Definition at line 71 of file waypoint.h.

Referenced by getMapNote(), and load().

◆ _type

uint32 Engines::DragonAge::Waypoint::_type
private

Index into the Waypoints MGDA.

The type of the map note.

Definition at line 74 of file waypoint.h.

Referenced by load().


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