CEL

Public API Reference

iMessageTriggerFactory Struct Reference

This interface is implemented by the trigger that fires when a message is sent. More...

#include <tools/triggers.h>

Inheritance diagram for iMessageTriggerFactory:

List of all members.

Public Member Functions

virtual void SetEntityParameter (const char *entity)=0
 Set the name of the entity from which we want to listen to messages.
virtual void SetMaskParameter (const char *mask)=0
 Set the name of the message mask that we want to receive messages for.

Detailed Description

This interface is implemented by the trigger that fires when a message is sent.

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.message'.

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

Definition at line 325 of file triggers.h.


Member Function Documentation

virtual void iMessageTriggerFactory::SetEntityParameter ( const char *  entity  )  [pure virtual]

Set the name of the entity from which we want to listen to messages.

Parameters:
entity is the name of the entity or a parameter (starts with '$').
virtual void iMessageTriggerFactory::SetMaskParameter ( const char *  mask  )  [pure virtual]

Set the name of the message mask that we want to receive messages for.

Parameters:
mask is the message mask 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