CEL

Public API Reference

iSequenceFinishTriggerFactory Struct Reference

This interface is implemented by the trigger that fires when a certain sequence finishes. More...

#include <tools/triggers.h>

Inheritance diagram for iSequenceFinishTriggerFactory:

List of all members.

Public Member Functions

virtual void SetEntityParameter (const char *entity, const char *tag=0)=0
 Set the name of the entity containing the pcquest property class on which this trigger will fire.
virtual void SetSequence (iCelSequence *sequence)=0
 Set the sequence to observe.
virtual void SetSequenceParameter (const char *sequence)=0
 Set the name of the sequence.

Detailed Description

This interface is implemented by the trigger that fires when a certain sequence finishes.

You can query this interface from the trigger factory if you want to manually control this factory as opposed to loading its definition from an XML document.

The predefined name of this trigger type is 'cel.triggers.sequencefinish'.

In XML, factories recognize the following attributes on the 'fireon' node:

Definition at line 496 of file triggers.h.


Member Function Documentation

virtual void iSequenceFinishTriggerFactory::SetEntityParameter ( const char *  entity,
const char *  tag = 0 
) [pure virtual]

Set the name of the entity containing the pcquest property class on which this trigger will fire.

Parameters:
entity is the name of the entity or a parameter (starts with '$').
tag is the optional tag of the entity or a parameter (starts with '$').
virtual void iSequenceFinishTriggerFactory::SetSequence ( iCelSequence sequence  )  [pure virtual]

Set the sequence to observe.

If this method is used, the trigger will observe the sequence given.

Parameters:
sequence is a pointer to the sequence.
virtual void iSequenceFinishTriggerFactory::SetSequenceParameter ( const char *  sequence  )  [pure virtual]

Set the name of the sequence.

If this method is used, with no call to the SetSequence method, the trigger will look for the sequence inside a quest inside the entity set.

Parameters:
sequence is the name of the sequence or a parameter (starts with '$').

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

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1