|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Tickable
This interface is implemented by any object which wishes to get periodic thread time from the threads engine. Almost all CoffeeMud objects implement this interface
| Field Summary | |
|---|---|
static long |
STATUS_AFFECT
a tick status MASK representing the tick access of an associated effect |
static long |
STATUS_ALIVE
a tick status representing ALIVE part of its tick access |
static long |
STATUS_BEHAVIOR
a tick status MASK representing the tick access of an associated behavior |
static long |
STATUS_CLASS
a tick status representing CLASS part of its tick access |
static long |
STATUS_DEAD
a tick status representing DEAD part of its tick access |
static long |
STATUS_END
a tick status representing the end of its tick access |
static long |
STATUS_FIGHT
a tick status representing COMBAT part of its tick access |
static long |
STATUS_MISC
a tick status MASK whose meaning is class dependent |
static long |
STATUS_MISC2
a tick status MASK whose meaning is class dependent |
static long |
STATUS_MISC3
a tick status MASK whose meaning is class dependent |
static long |
STATUS_MISC4
a tick status MASK whose meaning is class dependent |
static long |
STATUS_MISC5
a tick status MASK whose meaning is class dependent |
static long |
STATUS_MISC6
a tick status MASK whose meaning is class dependent |
static long |
STATUS_MISC7
a tick status MASK whose meaning is class dependent |
static long |
STATUS_NOT
a tick status constant representing the state of waiting for tick access |
static long |
STATUS_OTHER
a tick status representing ALIVE part of its tick access |
static long |
STATUS_RACE
a tick status representing RACE part of its tick access |
static long |
STATUS_REBIRTH
a tick status representing OTHER part of its tick access |
static long |
STATUS_SCRIPT
a tick status MASK representing the tick access of an associated script |
static long |
STATUS_START
a tick status constant representing the state of just starting its tick access |
static long |
STATUS_WEATHER
a tick status representing WEATHER part of its tick access |
static int |
TICKID_AREA
the tickid representing the standard tick of an area |
static int |
TICKID_CLAN
the tickid representing the ticking of a clan object |
static int |
TICKID_CLANITEM
the tickid representing the ticking of a clan item |
static int |
TICKID_DEADBODY_DECAY
the tickid representing the decay tick on a corpse |
static int |
TICKID_EMAIL
the tickid representing the ticking of the smtp server |
static int |
TICKID_EXIT_BEHAVIOR
the tickid representing the ticking of a behavior on an exit |
static int |
TICKID_EXIT_REOPEN
the tickid representing the tick that automatically closes open doors |
static int |
TICKID_ITEM_BEHAVIOR
the tickid representing the tick of a behavior on an item |
static int |
TICKID_ITEM_BOUNCEBACK
the tickid representing the returning of an innkey to the front desk |
static int |
TICKID_LIGHT_FLICKERS
the tickid representing the going out of a light |
static int |
TICKID_LIVEAUCTION
the tickid for a live auction tick |
static int |
TICKID_LONGERMASK
modifies a tickID to designate a longer wait before declaring dead. |
static int |
TICKID_MOB
the most common tickid, representing the tick of a mob |
static int |
TICKID_QUEST
the tickid representing the ticking of a quest script |
static int |
TICKID_READYTOSTOP
the tickid representing the impending stop of a service |
static int |
TICKID_ROOM_BEHAVIOR
the tickid representing the tick of a behavior on a room |
static int |
TICKID_ROOM_ITEM_REJUV
the tickid representing the resetting of an item that rejuvinates |
static int |
TICKID_SPELL_AFFECT
the tickid representing the ticking of a spell on a non-mob object |
static int |
TICKID_TIMEAUCTION
the tickid for a slow auction service tick |
static int |
TICKID_TRAP_DESTRUCTION
the tickid representing the destruction of a trap |
static int |
TICKID_TRAP_RESET
the tickid representing the resetting of a trap |
static int |
TICKMASK_SOLITARY
a mask for tickids |
| Method Summary | |
|---|---|
long |
getTickStatus()
A coded status for this object during the period where its tick method is being called. |
java.lang.String |
name()
The nice displayable name of this instance of this object |
boolean |
tick(Tickable ticking,
int tickID)
this is the method which is called periodically by the threading engine. |
| Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject |
|---|
copyOf, ID, initializeClass, newInstance |
| Methods inherited from interface java.lang.Comparable |
|---|
compareTo |
| Field Detail |
|---|
static final int TICKMASK_SOLITARY
static final int TICKID_MOB
static final int TICKID_ITEM_BEHAVIOR
static final int TICKID_EXIT_REOPEN
static final int TICKID_DEADBODY_DECAY
static final int TICKID_LIGHT_FLICKERS
static final int TICKID_TRAP_RESET
static final int TICKID_TRAP_DESTRUCTION
static final int TICKID_ITEM_BOUNCEBACK
static final int TICKID_ROOM_BEHAVIOR
static final int TICKID_AREA
static final int TICKID_ROOM_ITEM_REJUV
static final int TICKID_EXIT_BEHAVIOR
static final int TICKID_SPELL_AFFECT
static final int TICKID_QUEST
static final int TICKID_CLAN
static final int TICKID_CLANITEM
static final int TICKID_EMAIL
static final int TICKID_READYTOSTOP
static final int TICKID_LIVEAUCTION
static final int TICKID_TIMEAUCTION
static final int TICKID_LONGERMASK
static final long STATUS_NOT
static final long STATUS_START
static final long STATUS_CLASS
static final long STATUS_RACE
static final long STATUS_FIGHT
static final long STATUS_WEATHER
static final long STATUS_DEAD
static final long STATUS_ALIVE
static final long STATUS_REBIRTH
static final long STATUS_OTHER
static final long STATUS_END
static final long STATUS_BEHAVIOR
static final long STATUS_AFFECT
static final long STATUS_SCRIPT
static final long STATUS_MISC
static final long STATUS_MISC2
static final long STATUS_MISC3
static final long STATUS_MISC4
static final long STATUS_MISC5
static final long STATUS_MISC6
static final long STATUS_MISC7
| Method Detail |
|---|
java.lang.String name()
long getTickStatus()
tick(Tickable, int)
boolean tick(Tickable ticking,
int tickID)
ticking - a reference to this Tickable objecttickID - the TICKID_ constant describing this periodic call, as defined in Tickable
Tickable,
ServiceEngine,
TickableGroup
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||