org.cjncreations.csi
Class CSIEventProcessor

java.lang.Object
  extended by org.dimx.CustEventProcessor
      extended by org.cjncreations.csi.CSIEventProcessor
All Implemented Interfaces:
IEventProcessor
Direct Known Subclasses:
DefaultCSIEventProcessor, PlayerEventProcessor, StartCellEventProcessor

public class CSIEventProcessor
extends CustEventProcessor


Field Summary
static java.lang.String PROP_ASKED
          "minionasked" boolean true if the player has asked something specific of someone.
static java.lang.String PROP_CARDKIT
          "cardkit" boolean true if the player has put the card in the kit at least once.
static java.lang.String PROP_CLEARCHAT
          "clearchat" boolean true if player has seen clear chat X instructions.
static java.lang.String PROP_CONGRATS
          "congrats"
static java.lang.String PROP_GOODED
          "gooded" boolean true if the player has been given a specific praise.
static java.lang.String PROP_HEARD
          "minionheard" boolean true if the player has forced a required hear event.
static java.lang.String PROP_HELPLOOK
          "helplook" boolean true if player has seen /help look instructions.
static java.lang.String PROP_HELPPROMPT
          "helpprompt" boolean true if player has seen /help instruction.
static java.lang.String PROP_ITEMPROMPT
          "itemprompt" boolean true if player has been prompted to look at an item.
static java.lang.String PROP_KEY
          "minionkey" boolean true if the player has returned the key to its owner.
static java.lang.String PROP_KEYUSED
          "keyused" boolean true if the player has used a specific key at least once.
static java.lang.String PROP_LOOKED
          "minionlooked" boolean true if the player has looked at the required item.
static java.lang.String PROP_PLAYERKIT
          "playerkit" boolean true if the player has seen the kit at least once.
static java.lang.String PROP_PRAISED
          "praised" boolean true if player has been praised during this tick event.
static java.lang.String PROP_REMINDER
          "reminder" int count of items prompting reminders.
static java.lang.String PROP_ROOMCOUNT
          "roomcount" int count of "tick" events since /help look issued.
static java.lang.String PROP_ROOMLOOKED
          "roomlooked" boolean true if player has "look"ed at the room.
static java.lang.String PROP_ROOMPROMPT
          "roomprompt" boolean true if player has been prompted to look at the room.
static java.lang.String PROP_ROOMSEARCHED
          "roomsearched" boolean true if player has searched the room after an event.
static java.lang.String PROP_SAYPROMPT
          "sayprompt" boolean true if player has been prompted to say hi to someone.
static java.lang.String PROP_TICK
          "tick" int count of onLiving events--usually between related actions or no action.
static java.lang.String PROP_TOLD
          "miniontold" boolean true if the player has been told something.
 
Fields inherited from class org.dimx.CustEventProcessor
_world
 
Constructor Summary
CSIEventProcessor()
           
 
Method Summary
protected  Item createSimpleContainer(AdvObject ownerObj, java.lang.String name, java.lang.String description, java.lang.String attrlist, java.lang.String icon, int capacity)
          Creates a new simple Container with default volume of 1.
protected  Item createSimpleItem(AdvObject ownerObj, java.lang.String name, java.lang.String description, java.lang.String attrlist, java.lang.String icon)
          Creates a new simple Item with default capicity and volume both set to 1.
protected  java.lang.String csimsg(java.lang.String key)
          return the game message assigned to the message key.
protected  void displayItems(AdvObject container)
          Display the non-hidden contents of a room or container to the current agent.
 Token execute(java.lang.String eventId, DimxObject owner, AdvObject agent, DictSorted actualpar, Token defaultResult, boolean mustExist)
          Not normally overridden in subclasses.
 Token fireEvent_t(java.lang.String eventId, DimxObject owner, java.lang.String agent, java.lang.String target, DictSorted params, Token defaultResult, boolean mustExist)
          Not normally overridden in subclasses.
 boolean fireEvent(java.lang.String eventId, DimxObject owner, java.lang.String agent, java.lang.String target, DictSorted input, boolean defaultResult, boolean mustExist)
          Not normally overridden in subclasses.
protected static AdvObject[] getCharactersIn(DimxObject container)
           
protected static AdvObject[] getItemsIn(DimxObject container)
           
protected static AdvObject[] getItemsOfType(DimxObject container, java.lang.String type)
          calls getItemOfType with incSubTypes=false
protected static AdvObject[] getItemsOfType(DimxObject container, java.lang.String type, boolean incSubTypes)
           
protected static AdvObject getNamedCharacterIn(java.lang.String charname, DimxObject container)
           
protected static AdvObject[] getPlayersIn(DimxObject container)
           
protected  java.lang.String hilite(java.lang.String msgkey)
          Extract and optionally hilite the message defined by msgkey.
protected static int incrementProperty(DimxObject ownerObj, java.lang.String varId)
          increments and returns the new value of the incremented varId counter.
protected  void kill(DimxObject o)
           
protected  boolean onClose(boolean defaultResult, boolean mustExist)
           
protected  boolean onConsoleCommand(boolean defaultResult, boolean mustExist)
           
protected  boolean onDie(boolean defaultResult, boolean mustExist)
           
protected  boolean onDropped(boolean defaultResult, boolean mustExist)
           
protected  boolean onEnter(boolean defaultResult, boolean mustExist)
           
protected  boolean onExit(boolean defaultResult, boolean mustExist)
           
protected  boolean onGive(boolean defaultResult, boolean mustExist)
           
protected  boolean onHear(boolean defaultResult, boolean mustExist)
           
protected  boolean onHide(boolean defaultResult, boolean mustExist)
           
protected  boolean onLiving(boolean defaultResult, boolean mustExist)
           
protected  boolean onLock(boolean defaultResult, boolean mustExist)
           
protected  boolean onLook(boolean defaultResult, boolean mustExist)
          Triggered when an object is looked at Applies to: ITEM, CHARACTER, ROOM OWNER: Object being looked at AGENT: Character looking TARGET: unused Return value: True by default.
protected  boolean onLoose(boolean defaultResult, boolean mustExist)
           
protected  boolean onLooseItem(boolean defaultResult, boolean mustExist)
           
protected  boolean onNew(boolean defaultResult, boolean mustExist)
           
protected  boolean onOpen(boolean defaultResult, boolean mustExist)
           
protected  boolean onPicked(boolean defaultResult, boolean mustExist)
           
protected  boolean onReceive(boolean defaultResult, boolean mustExist)
           
protected  boolean onReceiveItem(boolean defaultResult, boolean mustExist)
           
protected  boolean onRestore(boolean defaultResult, boolean mustExist)
           
protected  boolean onSave(boolean defaultResult, boolean mustExist)
           
protected  boolean onSaveInfo(boolean defaultResult, boolean mustExist)
           
protected  boolean onSearch(boolean defaultResult, boolean mustExist)
           
protected  boolean onSpeechFinish(boolean defaultResult, boolean mustExist)
           
protected  boolean onStart(boolean defaultResult, boolean mustExist)
           
protected  boolean onTick(boolean defaultResult, boolean mustExist)
           
protected  boolean onUnlock(boolean defaultResult, boolean mustExist)
           
protected  boolean onUse(boolean defaultResult, boolean mustExist)
           
protected  boolean onUseWith(boolean defaultResult, boolean mustExist)
           
protected  boolean processEvent(java.lang.String eventId, boolean defaultResult, boolean mustExist)
          May be overridden by subclasses.
protected  java.lang.String randMsg(java.lang.String tkey)
          randomly return one of N messages with the same root key.
protected static void resetTick(DimxObject ownerObj)
          Reset the tick count of the object to 0.
protected  void setEventAssets(DimxObject owner, java.lang.String agent, java.lang.String target, DictSorted input)
          Not normally overridden by subclasses.
protected static void setEventHandler(DimxObject ownerObj, java.lang.String classname)
           
 void setWorld(World world)
          Called immediately following instantiation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROP_TICK

public static final java.lang.String PROP_TICK
"tick" int count of onLiving events--usually between related actions or no action.

See Also:
Constant Field Values

PROP_CLEARCHAT

public static final java.lang.String PROP_CLEARCHAT
"clearchat" boolean true if player has seen clear chat X instructions.

See Also:
Constant Field Values

PROP_HELPPROMPT

public static final java.lang.String PROP_HELPPROMPT
"helpprompt" boolean true if player has seen /help instruction.

See Also:
Constant Field Values

PROP_HELPLOOK

public static final java.lang.String PROP_HELPLOOK
"helplook" boolean true if player has seen /help look instructions.

See Also:
Constant Field Values

PROP_ROOMLOOKED

public static final java.lang.String PROP_ROOMLOOKED
"roomlooked" boolean true if player has "look"ed at the room.

See Also:
Constant Field Values

PROP_ROOMCOUNT

public static final java.lang.String PROP_ROOMCOUNT
"roomcount" int count of "tick" events since /help look issued. count continues to increment until player actually looks at the room.

See Also:
Constant Field Values

PROP_ROOMPROMPT

public static final java.lang.String PROP_ROOMPROMPT
"roomprompt" boolean true if player has been prompted to look at the room.

See Also:
Constant Field Values

PROP_ROOMSEARCHED

public static final java.lang.String PROP_ROOMSEARCHED
"roomsearched" boolean true if player has searched the room after an event.

See Also:
Constant Field Values

PROP_PRAISED

public static final java.lang.String PROP_PRAISED
"praised" boolean true if player has been praised during this tick event. this is usually reset at the beginning of each tick event.

See Also:
Constant Field Values

PROP_ITEMPROMPT

public static final java.lang.String PROP_ITEMPROMPT
"itemprompt" boolean true if player has been prompted to look at an item.

See Also:
Constant Field Values

PROP_REMINDER

public static final java.lang.String PROP_REMINDER
"reminder" int count of items prompting reminders. typically, we just care that his count is > 0 to present reminders. this is typically reset at the beginning of each tick event.

See Also:
Constant Field Values

PROP_SAYPROMPT

public static final java.lang.String PROP_SAYPROMPT
"sayprompt" boolean true if player has been prompted to say hi to someone.

See Also:
Constant Field Values

PROP_PLAYERKIT

public static final java.lang.String PROP_PLAYERKIT
"playerkit" boolean true if the player has seen the kit at least once.

See Also:
Constant Field Values

PROP_CARDKIT

public static final java.lang.String PROP_CARDKIT
"cardkit" boolean true if the player has put the card in the kit at least once.

See Also:
Constant Field Values

PROP_CONGRATS

public static final java.lang.String PROP_CONGRATS
"congrats"

See Also:
Constant Field Values

PROP_LOOKED

public static final java.lang.String PROP_LOOKED
"minionlooked" boolean true if the player has looked at the required item.

See Also:
Constant Field Values

PROP_KEY

public static final java.lang.String PROP_KEY
"minionkey" boolean true if the player has returned the key to its owner.

See Also:
Constant Field Values

PROP_TOLD

public static final java.lang.String PROP_TOLD
"miniontold" boolean true if the player has been told something.

See Also:
Constant Field Values

PROP_ASKED

public static final java.lang.String PROP_ASKED
"minionasked" boolean true if the player has asked something specific of someone.

See Also:
Constant Field Values

PROP_HEARD

public static final java.lang.String PROP_HEARD
"minionheard" boolean true if the player has forced a required hear event.

See Also:
Constant Field Values

PROP_GOODED

public static final java.lang.String PROP_GOODED
"gooded" boolean true if the player has been given a specific praise.

See Also:
Constant Field Values

PROP_KEYUSED

public static final java.lang.String PROP_KEYUSED
"keyused" boolean true if the player has used a specific key at least once.

See Also:
Constant Field Values
Constructor Detail

CSIEventProcessor

public CSIEventProcessor()
Method Detail

setWorld

public void setWorld(World world)
              throws DimxException
Called immediately following instantiation.

Specified by:
setWorld in interface IEventProcessor
Overrides:
setWorld in class CustEventProcessor
Parameters:
world -
Throws:
DimxException

csimsg

protected java.lang.String csimsg(java.lang.String key)
return the game message assigned to the message key. if the game Dictionary is null or the message is not present then we return an empty string.

Parameters:
key -
Returns:
message in Dict if present. Empty string, otherwise.

hilite

protected java.lang.String hilite(java.lang.String msgkey)
Extract and optionally hilite the message defined by msgkey. Also replaces the _agent.name if present.

Parameters:
msgkey -
Returns:
text of message hilited as appropriate

randMsg

protected java.lang.String randMsg(java.lang.String tkey)
randomly return one of N messages with the same root key. Ex: root, root1, root2, root3, etc... The message will have already been hilited

Parameters:
tkey -
Returns:
the hilited string or an empty string if no messages found.
See Also:
hilite(String)

setEventHandler

protected static void setEventHandler(DimxObject ownerObj,
                                      java.lang.String classname)
                               throws DimxException
Parameters:
ownerObj -
classname -
Throws:
DimxException

resetTick

protected static void resetTick(DimxObject ownerObj)
                         throws DimxException
Reset the tick count of the object to 0.

Parameters:
ownerObj -
Throws:
DimxException

incrementProperty

protected static int incrementProperty(DimxObject ownerObj,
                                       java.lang.String varId)
                                throws DimxException
increments and returns the new value of the incremented varId counter.

Parameters:
ownerObj -
Returns:
new value of incremented varId counter. 1 if no counter was previously set on the object.
Throws:
DimxException

getItemsIn

protected static AdvObject[] getItemsIn(DimxObject container)
Parameters:
container -
Returns:

getItemsOfType

protected static AdvObject[] getItemsOfType(DimxObject container,
                                            java.lang.String type)
calls getItemOfType with incSubTypes=false

Parameters:
container -
type -
Returns:

getItemsOfType

protected static AdvObject[] getItemsOfType(DimxObject container,
                                            java.lang.String type,
                                            boolean incSubTypes)
Parameters:
container -
type -
incSubTypes -
Returns:

getCharactersIn

protected static AdvObject[] getCharactersIn(DimxObject container)
Parameters:
container -
Returns:

getPlayersIn

protected static AdvObject[] getPlayersIn(DimxObject container)
Parameters:
container -
Returns:

getNamedCharacterIn

protected static AdvObject getNamedCharacterIn(java.lang.String charname,
                                               DimxObject container)
Parameters:
container -
Returns:
Named character or null.

displayItems

protected void displayItems(AdvObject container)
                     throws DimxException
Display the non-hidden contents of a room or container to the current agent.

Parameters:
owner -
Throws:
DimxException

createSimpleItem

protected Item createSimpleItem(AdvObject ownerObj,
                                java.lang.String name,
                                java.lang.String description,
                                java.lang.String attrlist,
                                java.lang.String icon)
                         throws DimxException
Creates a new simple Item with default capicity and volume both set to 1. This routine properly assigns the item to the World of the ownerObj and properly assigns the Item to the ownerObj as its container.

Parameters:
ownerObj -
name -
desciption - - will be sent throught the hilite() routine.
attrlist -
icon -
Returns:
new Item assigned to ownerObj container in the ownerObj's world.
Throws:
DimxException

createSimpleContainer

protected Item createSimpleContainer(AdvObject ownerObj,
                                     java.lang.String name,
                                     java.lang.String description,
                                     java.lang.String attrlist,
                                     java.lang.String icon,
                                     int capacity)
                              throws DimxException
Creates a new simple Container with default volume of 1. This routine properly assigns the item to the World of the ownerObj and properly assigns the Item to the ownerObj as its container.

Parameters:
ownerObj -
name -
desciption - - will be sent throught the hilite() routine.
attrlist -
icon -
capacity -
Returns:
new Item assigned to ownerObj container in the ownerObj's world.
Throws:
DimxException

kill

protected void kill(DimxObject o)
             throws DimxException
Throws:
DimxException

onStart

protected boolean onStart(boolean defaultResult,
                          boolean mustExist)
                   throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onClose

protected boolean onClose(boolean defaultResult,
                          boolean mustExist)
                   throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onDie

protected boolean onDie(boolean defaultResult,
                        boolean mustExist)
                 throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onEnter

protected boolean onEnter(boolean defaultResult,
                          boolean mustExist)
                   throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onExit

protected boolean onExit(boolean defaultResult,
                         boolean mustExist)
                  throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onGive

protected boolean onGive(boolean defaultResult,
                         boolean mustExist)
                  throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onHear

protected boolean onHear(boolean defaultResult,
                         boolean mustExist)
                  throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onHide

protected boolean onHide(boolean defaultResult,
                         boolean mustExist)
                  throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onLock

protected boolean onLock(boolean defaultResult,
                         boolean mustExist)
                  throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onUnlock

protected boolean onUnlock(boolean defaultResult,
                           boolean mustExist)
                    throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onLook

protected boolean onLook(boolean defaultResult,
                         boolean mustExist)
                  throws DimxException
Triggered when an object is looked at Applies to: ITEM, CHARACTER, ROOM OWNER: Object being looked at AGENT: Character looking TARGET: unused Return value: True by default. If the result is set to False, then the action is cancelled. Note 1: If you just wish to skip the focusing effect, just set the player’s .__clearfocus property to True. Note 2: The individual OBJECT.onLook event triggers first than the generic onLook EVENT. If the individual OBJECT.onLook exists and if its return value is not explicitelty zero, then the event is considered as handled and the generic onLook event is not triggered. Note 3: With difference regards all other system events, this event receives user input in the input( ) set. Ideas for use: Characters speaking or talking to players when they look at them, giving hints on the game.

Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onLoose

protected boolean onLoose(boolean defaultResult,
                          boolean mustExist)
                   throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onLooseItem

protected boolean onLooseItem(boolean defaultResult,
                              boolean mustExist)
                       throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onNew

protected boolean onNew(boolean defaultResult,
                        boolean mustExist)
                 throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onOpen

protected boolean onOpen(boolean defaultResult,
                         boolean mustExist)
                  throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onReceive

protected boolean onReceive(boolean defaultResult,
                            boolean mustExist)
                     throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onReceiveItem

protected boolean onReceiveItem(boolean defaultResult,
                                boolean mustExist)
                         throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onSearch

protected boolean onSearch(boolean defaultResult,
                           boolean mustExist)
                    throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onTick

protected boolean onTick(boolean defaultResult,
                         boolean mustExist)
                  throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onUse

protected boolean onUse(boolean defaultResult,
                        boolean mustExist)
                 throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onUseWith

protected boolean onUseWith(boolean defaultResult,
                            boolean mustExist)
                     throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onRestore

protected boolean onRestore(boolean defaultResult,
                            boolean mustExist)
                     throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onSave

protected boolean onSave(boolean defaultResult,
                         boolean mustExist)
                  throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onSaveInfo

protected boolean onSaveInfo(boolean defaultResult,
                             boolean mustExist)
                      throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onSpeechFinish

protected boolean onSpeechFinish(boolean defaultResult,
                                 boolean mustExist)
                          throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onDropped

protected boolean onDropped(boolean defaultResult,
                            boolean mustExist)
                     throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onPicked

protected boolean onPicked(boolean defaultResult,
                           boolean mustExist)
                    throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onLiving

protected boolean onLiving(boolean defaultResult,
                           boolean mustExist)
                    throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

onConsoleCommand

protected boolean onConsoleCommand(boolean defaultResult,
                                   boolean mustExist)
                            throws DimxException
Parameters:
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException

execute

public Token execute(java.lang.String eventId,
                     DimxObject owner,
                     AdvObject agent,
                     DictSorted actualpar,
                     Token defaultResult,
                     boolean mustExist)
              throws DimxException
Not normally overridden in subclasses. Call super.execute(...) when the eventId provided is not supported by the subclass.

Specified by:
execute in interface IEventProcessor
Overrides:
execute in class CustEventProcessor
Parameters:
eventId -
owner -
agent -
actualpar -
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException
See Also:
World.execute(String,DimxObject,AdvObject,DictSorted,Token,boolean)

setEventAssets

protected void setEventAssets(DimxObject owner,
                              java.lang.String agent,
                              java.lang.String target,
                              DictSorted input)
Not normally overridden by subclasses. Called after setWorld in local fireEvent methods.

Parameters:
owner -
agent -
target -
input -

processEvent

protected boolean processEvent(java.lang.String eventId,
                               boolean defaultResult,
                               boolean mustExist)
                        throws DimxException
May be overridden by subclasses. This implementation simply returns defaultResult or throws NoEventHandlerException if mustExist is true.

Parameters:
eventId -
defaultResult -
mustExist -
Returns:
defaultResult or NoEventHandlerException to indicate "not handled".
Throws:
DimxException

fireEvent

public boolean fireEvent(java.lang.String eventId,
                         DimxObject owner,
                         java.lang.String agent,
                         java.lang.String target,
                         DictSorted input,
                         boolean defaultResult,
                         boolean mustExist)
                  throws DimxException
Not normally overridden in subclasses. This implementation will call setWorld and then processEvent for any subclass found. Call super.fireEvent(...) when the eventId provided is not supported by the subclass.

Specified by:
fireEvent in interface IEventProcessor
Overrides:
fireEvent in class CustEventProcessor
Parameters:
eventId -
owner -
agent -
target -
input -
defaultResult -
mustExist -
Returns:
defaultResult or throws DimxException if mustExist is true.
Throws:
DimxException
See Also:
World.fireEvent(String,DimxObject,String,String,DictSorted,boolean,boolean)

fireEvent_t

public Token fireEvent_t(java.lang.String eventId,
                         DimxObject owner,
                         java.lang.String agent,
                         java.lang.String target,
                         DictSorted params,
                         Token defaultResult,
                         boolean mustExist)
                  throws DimxException
Not normally overridden in subclasses. Call super.fireEvent_t(...) when the eventId provided is not supported by the subclass.

Specified by:
fireEvent_t in interface IEventProcessor
Overrides:
fireEvent_t in class CustEventProcessor
Parameters:
eventId -
owner -
agent -
target -
params -
defaultResult -
mustExist -
Returns:
super.fireEvent_t when the eventId provided is not supported.
Throws:
DimxException
See Also:
World.fireEvent_t(String,DimxObject,String,String,DictSorted,Token,boolean)