|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.dimx.CustEventProcessor
org.cjncreations.csi.CSIEventProcessor
public class CSIEventProcessor
| 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 |
|---|
public static final java.lang.String PROP_TICK
public static final java.lang.String PROP_CLEARCHAT
public static final java.lang.String PROP_HELPPROMPT
public static final java.lang.String PROP_HELPLOOK
public static final java.lang.String PROP_ROOMLOOKED
public static final java.lang.String PROP_ROOMCOUNT
public static final java.lang.String PROP_ROOMPROMPT
public static final java.lang.String PROP_ROOMSEARCHED
public static final java.lang.String PROP_PRAISED
public static final java.lang.String PROP_ITEMPROMPT
public static final java.lang.String PROP_REMINDER
public static final java.lang.String PROP_SAYPROMPT
public static final java.lang.String PROP_PLAYERKIT
public static final java.lang.String PROP_CARDKIT
public static final java.lang.String PROP_CONGRATS
public static final java.lang.String PROP_LOOKED
public static final java.lang.String PROP_KEY
public static final java.lang.String PROP_TOLD
public static final java.lang.String PROP_ASKED
public static final java.lang.String PROP_HEARD
public static final java.lang.String PROP_GOODED
public static final java.lang.String PROP_KEYUSED
| Constructor Detail |
|---|
public CSIEventProcessor()
| Method Detail |
|---|
public void setWorld(World world)
throws DimxException
setWorld in interface IEventProcessorsetWorld in class CustEventProcessorworld -
DimxExceptionprotected java.lang.String csimsg(java.lang.String key)
key -
protected java.lang.String hilite(java.lang.String msgkey)
msgkey -
protected java.lang.String randMsg(java.lang.String tkey)
tkey -
hilite(String)
protected static void setEventHandler(DimxObject ownerObj,
java.lang.String classname)
throws DimxException
ownerObj - classname -
DimxException
protected static void resetTick(DimxObject ownerObj)
throws DimxException
ownerObj -
DimxException
protected static int incrementProperty(DimxObject ownerObj,
java.lang.String varId)
throws DimxException
ownerObj -
DimxExceptionprotected static AdvObject[] getItemsIn(DimxObject container)
container -
protected static AdvObject[] getItemsOfType(DimxObject container,
java.lang.String type)
container - type -
protected static AdvObject[] getItemsOfType(DimxObject container,
java.lang.String type,
boolean incSubTypes)
container - type - incSubTypes -
protected static AdvObject[] getCharactersIn(DimxObject container)
container -
protected static AdvObject[] getPlayersIn(DimxObject container)
container -
protected static AdvObject getNamedCharacterIn(java.lang.String charname,
DimxObject container)
container -
protected void displayItems(AdvObject container)
throws DimxException
owner -
DimxException
protected Item createSimpleItem(AdvObject ownerObj,
java.lang.String name,
java.lang.String description,
java.lang.String attrlist,
java.lang.String icon)
throws DimxException
ownerObj - name - desciption - - will be sent throught the hilite() routine.attrlist - icon -
DimxException
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
ownerObj - name - desciption - - will be sent throught the hilite() routine.attrlist - icon - capacity -
DimxException
protected void kill(DimxObject o)
throws DimxException
DimxException
protected boolean onStart(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onClose(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onDie(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onEnter(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onExit(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onGive(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onHear(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onHide(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onLock(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onUnlock(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onLook(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onLoose(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onLooseItem(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onNew(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onOpen(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onReceive(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onReceiveItem(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onSearch(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onTick(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onUse(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onUseWith(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onRestore(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onSave(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onSaveInfo(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onSpeechFinish(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onDropped(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onPicked(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onLiving(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
protected boolean onConsoleCommand(boolean defaultResult,
boolean mustExist)
throws DimxException
defaultResult - mustExist -
DimxException
public Token execute(java.lang.String eventId,
DimxObject owner,
AdvObject agent,
DictSorted actualpar,
Token defaultResult,
boolean mustExist)
throws DimxException
execute in interface IEventProcessorexecute in class CustEventProcessoreventId - owner - agent - actualpar - defaultResult - mustExist -
DimxExceptionWorld.execute(String,DimxObject,AdvObject,DictSorted,Token,boolean)
protected void setEventAssets(DimxObject owner,
java.lang.String agent,
java.lang.String target,
DictSorted input)
owner - agent - target - input -
protected boolean processEvent(java.lang.String eventId,
boolean defaultResult,
boolean mustExist)
throws DimxException
eventId - defaultResult - mustExist -
DimxException
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
fireEvent in interface IEventProcessorfireEvent in class CustEventProcessoreventId - owner - agent - target - input - defaultResult - mustExist -
DimxExceptionWorld.fireEvent(String,DimxObject,String,String,DictSorted,boolean,boolean)
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
fireEvent_t in interface IEventProcessorfireEvent_t in class CustEventProcessoreventId - owner - agent - target - params - defaultResult - mustExist -
DimxExceptionWorld.fireEvent_t(String,DimxObject,String,String,DictSorted,Token,boolean)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||