Planeshift
Public Member Functions | List of all members
psQuestPrereqOp Class Referenceabstract
Bulkobjects

Pure virtual base quest prerequisite operator class. More...

#include <psquestprereqops.h>

Public Member Functions

virtual bool Check (psCharacter *character)=0
 Check for valid prerequisite. More...
 
virtual csPtr< psQuestPrereqOp > Copy ()=0
 Copy the prerequisite operator. More...
 
virtual csString GetScript ()
 Convert the prerequisite script to a xml string. More...
 
virtual csString GetScriptOp ()=0
 Convert the prerequisite operator to a xml string. More...
 
virtual ~psQuestPrereqOp ()
 Destructor for the prerequisite operator. More...
 

Detailed Description

Pure virtual base quest prerequisite operator class.

This base class define the needed functions for every prerequisite operator.

Definition at line 58 of file psquestprereqops.h.

Constructor & Destructor Documentation

virtual psQuestPrereqOp::~psQuestPrereqOp ( )
inlinevirtual

Destructor for the prerequisite operator.

Definition at line 65 of file psquestprereqops.h.

Member Function Documentation

virtual bool psQuestPrereqOp::Check ( psCharacter *  character)
pure virtual

Check for valid prerequisite.

Override this function to generate a test for any prerequisite.

Parameters
characterThe character that are checking for a trigger
Returns
True if the prerequisite is true and the trigger holding the prerequisite should be available.

Implemented in psPrereqOpStance, psPrereqOpAttackType, psQuestPrereqOpSkill, psQuestPrereqOpXor, psQuestPrereqOpVariable, psQuestPrereqOpTimeOfDay, psQuestPrereqOpTimeOnline, psQuestPrereqOpAdvisorPoints, psQuestPrereqOpMarriage, psQuestPrereqOpGuild, psQuestPrereqOpKnownSpell, psQuestPrereqOpGender, psQuestPrereqOpRace, psQuestPrereqOpTrait, psQuestPrereqOpActiveMagic, psQuestPrereqOpItem, psQuestPrereqOpFaction, psQuestPrereqOpQuestCompletedCategory, psQuestPrereqOpQuestAssigned, psQuestPrereqOpQuestCompleted, psQuestPrereqOpNot, psQuestPrereqOpRequire, psQuestPrereqOpOr, and psQuestPrereqOpAnd.

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

Copy the prerequisite operator.

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

Returns
Copy of the prerequisite operator.

Implemented in psPrereqOpStance, psPrereqOpAttackType, psQuestPrereqOpSkill, psQuestPrereqOpXor, psQuestPrereqOpVariable, psQuestPrereqOpTimeOfDay, psQuestPrereqOpTimeOnline, psQuestPrereqOpAdvisorPoints, psQuestPrereqOpMarriage, psQuestPrereqOpGuild, psQuestPrereqOpKnownSpell, psQuestPrereqOpGender, psQuestPrereqOpRace, psQuestPrereqOpTrait, psQuestPrereqOpActiveMagic, psQuestPrereqOpItem, psQuestPrereqOpFaction, psQuestPrereqOpQuestCompletedCategory, psQuestPrereqOpQuestAssigned, psQuestPrereqOpQuestCompleted, psQuestPrereqOpNot, psQuestPrereqOpRequire, psQuestPrereqOpOr, and psQuestPrereqOpAnd.

virtual csString psQuestPrereqOp::GetScript ( )
virtual

Convert the prerequisite script to a xml string.

Wrapps the operator in <pre>...</pre> tags.

Returns
XML string for the prerequisite script.
virtual csString psQuestPrereqOp::GetScriptOp ( )
pure virtual

Convert the prerequisite operator to a xml string.

Override this function to return the prerequisite xml tag for your new operator.

Returns
XML string for the prerequisite operator.

Implemented in psPrereqOpStance, psPrereqOpAttackType, psQuestPrereqOpSkill, psQuestPrereqOpXor, psQuestPrereqOpVariable, psQuestPrereqOpTimeOfDay, psQuestPrereqOpTimeOnline, psQuestPrereqOpAdvisorPoints, psQuestPrereqOpMarriage, psQuestPrereqOpGuild, psQuestPrereqOpKnownSpell, psQuestPrereqOpGender, psQuestPrereqOpRace, psQuestPrereqOpTrait, psQuestPrereqOpActiveMagic, psQuestPrereqOpItem, psQuestPrereqOpFaction, psQuestPrereqOpQuestCompletedCategory, psQuestPrereqOpQuestAssigned, psQuestPrereqOpQuestCompleted, psQuestPrereqOpNot, psQuestPrereqOpRequire, psQuestPrereqOpOr, and psQuestPrereqOpAnd.

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