org.cjncreations.csi
Class DefaultCSIEventProcessor

java.lang.Object
  org.dimx.CustEventProcessor
      org.cjncreations.csi.CSIEventProcessor
          org.cjncreations.csi.DefaultCSIEventProcessor

All Implemented Interfaces:

IEventProcessor

Direct Known Subclasses:

MinionEventProcessor

public class DefaultCSIEventProcessor
extends CSIEventProcessor

This class implements default event processing. It is invoked from the fireEvent methods of its superclass.

Field Summary

static java.lang.String

ADVOBJECT_DESCRIPTION description

Fields inherited from class org.cjncreations.csi.CSIEventProcessor

PROP_ASKED, PROP_CARDKIT, PROP_CLEARCHAT, PROP_CONGRATS, PROP_GOODED, PROP_HEARD, PROP_HELPLOOK, PROP_HELPPROMPT, PROP_ITEMPROMPT, PROP_KEY, PROP_KEYUSED, PROP_LOOKED, PROP_PLAYERKIT, PROP_PRAISED, PROP_REMINDER, PROP_ROOMCOUNT, PROP_ROOMLOOKED, PROP_ROOMPROMPT, PROP_ROOMSEARCHED, PROP_SAYPROMPT, PROP_TICK, PROP_TOLD

Fields inherited from class org.dimx.CustEventProcessor

_world

Constructor Summary

DefaultCSIEventProcessor()

Method Summary

protected boolean	onLock(boolean defaultResult, boolean mustExist) Will negatively respond if target is already locked.
protected boolean	onNew(boolean defaultResult, boolean mustExist)
protected boolean	onReceive(boolean defaultResult, boolean mustExist)
protected boolean	onUnlock(boolean defaultResult, boolean mustExist) Will negatively respond if target is already unlocked.

Methods inherited from class org.cjncreations.csi.CSIEventProcessor

createSimpleContainer, createSimpleItem, csimsg, displayItems, execute, fireEvent_t, fireEvent, getCharactersIn, getItemsIn, getItemsOfType, getItemsOfType, getNamedCharacterIn, getPlayersIn, hilite, incrementProperty, kill, onClose, onConsoleCommand, onDie, onDropped, onEnter, onExit, onGive, onHear, onHide, onLiving, onLook, onLoose, onLooseItem, onOpen, onPicked, onReceiveItem, onRestore, onSave, onSaveInfo, onSearch, onSpeechFinish, onStart, onTick, onUse, onUseWith, processEvent, randMsg, resetTick, setEventAssets, setEventHandler, setWorld

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADVOBJECT_DESCRIPTION

public static final java.lang.String ADVOBJECT_DESCRIPTION

description

See Also:

Constant Field Values

Constructor Detail

DefaultCSIEventProcessor

public DefaultCSIEventProcessor()

Method Detail

onNew

protected boolean onNew(boolean defaultResult,
                        boolean mustExist)
                 throws DimxException

Overrides:

onNew in class CSIEventProcessor

Parameters:

defaultResult -

mustExist -

Returns:

defaultResult or throws DimxException if mustExist is true.

Throws:

DimxException

onLock

protected boolean onLock(boolean defaultResult,
                         boolean mustExist)
                  throws DimxException

Will negatively respond if target is already locked. Otherwise, reports the owner and the target are not the proper match. You must override to actually implement a working onLock operation.

Overrides:

onLock in class CSIEventProcessor

Parameters:

defaultResult -

mustExist -

Returns:

defaultResult or throws DimxException if mustExist is true.

Throws:

DimxException

onUnlock

protected boolean onUnlock(boolean defaultResult,
                           boolean mustExist)
                    throws DimxException

Will negatively respond if target is already unlocked. Otherwise, reports the owner and the target are not the proper match. You must override to actually implement a working onUnlock operation.

Overrides:

onUnlock in class CSIEventProcessor

Parameters:

defaultResult -

mustExist -

Returns:

defaultResult or throws DimxException if mustExist is true.

Throws:

DimxException

onReceive

protected boolean onReceive(boolean defaultResult,
                            boolean mustExist)
                     throws DimxException

Overrides:

onReceive in class CSIEventProcessor

Parameters:

defaultResult -

mustExist -

Returns:

defaultResult or throws DimxException if mustExist is true.

Throws:

DimxException