Planeshift
psQuestPrereqOpQuestAssigned Class Reference

Quest assigned prerequisite operator. More...

#include <psquestprereqops.h>

Public Member Functions

virtual bool Check (psCharacter *character)
 Check if the given quest is assigned. More...
 
virtual csPtr< psQuestPrereqOpCopy ()
 Copy the prerequisite operator. More...
 
virtual psQuestGetQuest ()
 retrieve the quest. More...
 
virtual csString GetQuestName ()
 retrieve the quest name. More...
 
virtual csString GetScriptOp ()
 Convert the prerequisite operator to a xml string. More...
 
 psQuestPrereqOpQuestAssigned (psQuest *quest)
 name of the quest (for weakref if invalid) More...
 
virtual ~psQuestPrereqOpQuestAssigned ()
 
- Public Member Functions inherited from psQuestPrereqOp
virtual csString GetScript ()
 Convert the prerequisite script to a xml string. More...
 
virtual ~psQuestPrereqOp ()
 Destructor for the prerequisite operator. More...
 

Protected Attributes

csWeakRef< psQuestquest
 The quest that need to be assigned. More...
 
csString questName
 

Detailed Description

Quest assigned prerequisite operator.

The given quest have to be assigned for this prerequisite to be true.

Definition at line 442 of file psquestprereqops.h.

Constructor & Destructor Documentation

psQuestPrereqOpQuestAssigned::psQuestPrereqOpQuestAssigned ( psQuest quest)
inline

name of the quest (for weakref if invalid)

Construct a quest assigned operator

Parameters
questThe quest that need to be assigned.

Definition at line 457 of file psquestprereqops.h.

virtual psQuestPrereqOpQuestAssigned::~psQuestPrereqOpQuestAssigned ( )
inlinevirtual

Definition at line 461 of file psquestprereqops.h.

Member Function Documentation

virtual bool psQuestPrereqOpQuestAssigned::Check ( psCharacter character)
virtual

Check if the given quest is assigned.

prerequisite = Is the quest assigned.

Parameters
characterThe character that are checking for a prerequisite
Returns
True if the character have assigned the given quest.

Implements psQuestPrereqOp.

virtual csPtr<psQuestPrereqOp> psQuestPrereqOpQuestAssigned::Copy ( )
virtual

Copy the prerequisite operator.

Override this function to return a copy of the prerequisite operator.

Returns
Copy of the prerequisite operator.

Implements psQuestPrereqOp.

virtual psQuest* psQuestPrereqOpQuestAssigned::GetQuest ( )
virtual

retrieve the quest.

check the weak pointer reference, and if it's invalid try to retrieve the quest again.

virtual csString psQuestPrereqOpQuestAssigned::GetQuestName ( )
virtual

retrieve the quest name.

check weak pointer reference and try to optain a new ref, if it's invalid. Otherwise name is used

virtual csString psQuestPrereqOpQuestAssigned::GetScriptOp ( )
virtual

Convert the prerequisite operator to a xml string.

Convert the operator into the xml string: <assigned quest="quest name"/>

Returns
XML string for the prerequisite operator.

Implements psQuestPrereqOp.

Member Data Documentation

csWeakRef<psQuest> psQuestPrereqOpQuestAssigned::quest
protected

The quest that need to be assigned.

Definition at line 448 of file psquestprereqops.h.

csString psQuestPrereqOpQuestAssigned::questName
protected

Definition at line 449 of file psquestprereqops.h.


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