Planeshift
UnSetVariableResponseOp Class Reference

This script operation is used to unset character variables from npc dialogs. More...

#include <dictionary.h>

Public Member Functions

virtual csString GetResponseScript ()
 Gets the script representation of this object (after it has been loaded). More...
 
virtual bool Load (iDocumentNode *node)
 Loads the script for the operation. More...
 
virtual bool Run (gemNPC *who, gemActor *target, NpcResponse *owner, csTicks &timeDelay, int &voiceNumber)
 Actually runs the precompiled script. More...
 
 UnSetVariableResponseOp ()
 Constructor. Practically does nothing. More...
 
virtual ~UnSetVariableResponseOp ()
 Destructor. More...
 
- Public Member Functions inherited from ResponseOperation
const char * GetName ()
 only used for output in error messages while parsing the script in NpcResponse More...
 
virtual bool IsPublic ()
 
virtual ~ResponseOperation ()
 

Protected Attributes

csString variableName
 The name of the variable to be set. More...
 
- Protected Attributes inherited from ResponseOperation
csString name
 

Detailed Description

This script operation is used to unset character variables from npc dialogs.

It can unset a name a variable from its name. Note that each name must be unique for the current character or it will be overwritten.

Definition at line 649 of file dictionary.h.

Constructor & Destructor Documentation

UnSetVariableResponseOp::UnSetVariableResponseOp ( )
inline

Constructor. Practically does nothing.

Definition at line 657 of file dictionary.h.

virtual UnSetVariableResponseOp::~UnSetVariableResponseOp ( )
inlinevirtual

Destructor.

Definition at line 663 of file dictionary.h.

Member Function Documentation

virtual csString UnSetVariableResponseOp::GetResponseScript ( )
virtual

Gets the script representation of this object (after it has been loaded).

Returns
A string with the content of the currently loaded script.

Implements ResponseOperation.

virtual bool UnSetVariableResponseOp::Load ( iDocumentNode *  node)
virtual

Loads the script for the operation.

Parameters
nodeThe document node of this operator.

Implements ResponseOperation.

virtual bool UnSetVariableResponseOp::Run ( gemNPC who,
gemActor target,
NpcResponse owner,
csTicks &  timeDelay,
int voiceNumber 
)
virtual

Actually runs the precompiled script.

Parameters
whoThe npc action which is running the script (ignored).
targetThe npc actor which is being subject of the script.
ownerThe npc response containing this script operation (ignored).
timeDelayThe time to wait before applying this script operation (ignored).
voiceNumberThe voice to apply for this operation (ignored).
Returns
The function always returns true.

Implements ResponseOperation.

Member Data Documentation

csString UnSetVariableResponseOp::variableName
protected

The name of the variable to be set.

Definition at line 652 of file dictionary.h.


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