Package com.planet_ink.coffee_mud.core.interfaces

Interface TickClient

All Superinterfaces:

java.lang.Comparable<TickClient>

All Known Implementing Classes:

StdTickClient

public interface TickClient
extends java.lang.Comparable<TickClient>

Encapsulates, manages, and collects statistics about a single ticking object in the game. These clients are grouped together in TickableGroup objects, which are in turn called by the ServiceEngine to get thread time.

Method Summary

Modifier and Type	Method	Description
Tickable	getClientObject()	Returns the ticking object that this client encapsulates
int	getCurrentTickDown()	Returns the number of ticks remaining before the internal object is allowed to get thread time.
long	getLastStartTime()	Returns the time, in ms, that this object last ticked.
long	getLastStopTime()	Returns the time, in ms, that this object last stopped ticking.
long	getMilliTotal()	Returns the number of ms that this object has ticked in total
java.lang.String	getName()	Returns the name of this ticking client as a displayable String, usually just a translation of the Tickable.name()
java.lang.String	getStatus()	Returns the status of this ticking client as a displayable String, usually just a translation of the Tickable.getTickStatus()
int	getTickID()	Returns the TICKID_ constant assigned to this object
long	getTickTotal()	Returns the number of times that this object has ticked in total
long	getTimeMSToNextTick()	Gets the number of total milliseconds before another tick will occur., or -1.
int	getTotalTickDown()	Returns the number of ticks total before the internal object is allowed to get thread time.
boolean	isAwake()	Returns true if this is currently getting thread time
boolean	isSuspended()	Returns true if this object is currently suspended
void	setCurrentTickDownPending()	Sets the number of ticks remaining before the internal object is allowed to get thread time to 1.
void	setStatus(java.lang.String status)	Sets the status of this ticking client as a displayable String
void	setSuspended(boolean trueFalse)	Sets whether this object is suspended from getting thread time
boolean	tickTicker(boolean forceTickDown)	Potentially allows the internal object to be ticked.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getClientObject

Tickable getClientObject()

Returns the ticking object that this client encapsulates

Returns:

the ticking object that this client encapsulates

See Also:

Tickable

getTickID

int getTickID()

Returns the TICKID_ constant assigned to this object

Returns:

the TICKID_ constant assigned to this object

See Also:

Tickable.TICKID_AREA

getStatus

java.lang.String getStatus()

Returns the status of this ticking client as a displayable String, usually just a translation of the Tickable.getTickStatus()

Returns:

the TICKID_ constant assigned to this object

See Also:

Tickable.getTickStatus()

getName

java.lang.String getName()

Returns the name of this ticking client as a displayable String, usually just a translation of the Tickable.name()

Returns:

the TICKID_ constant assigned to this object

setStatus

void setStatus(java.lang.String status)

Sets the status of this ticking client as a displayable String

Parameters:

status - the new status to set this client to

See Also:

getStatus()

tickTicker

boolean tickTicker(boolean forceTickDown)

Potentially allows the internal object to be ticked. This will cause the current tick down, which starts at totaltickdown to be decremented by one. When it reaches 0, the internal object will be "ticked".

Parameters:

forceTickDown - true to override the currentTickDown

Returns:

true if the object is done ticking forever, false to keep going

See Also:

Tickable.tick(Tickable, int)

getLastStartTime

long getLastStartTime()

Returns the time, in ms, that this object last ticked.

Returns:

the time, in ms, that this object last ticked.

getLastStopTime

long getLastStopTime()

Returns the time, in ms, that this object last stopped ticking.

Returns:

the time, in ms, that this object last stopped ticking

getMilliTotal

long getMilliTotal()

Returns the number of ms that this object has ticked in total

Returns:

the number of ms that this object has ticked in total

getTickTotal

long getTickTotal()

Returns the number of times that this object has ticked in total

Returns:

the number of times that this object has ticked in total

isAwake

boolean isAwake()

Returns true if this is currently getting thread time

Returns:

true if this is currently getting thread time

isSuspended

boolean isSuspended()

Returns true if this object is currently suspended

Returns:

true if this object is currently suspended

setSuspended

void setSuspended(boolean trueFalse)

Sets whether this object is suspended from getting thread time

Parameters:

trueFalse - true to suspend it, false to unsuspend it

getTotalTickDown

int getTotalTickDown()

Returns the number of ticks total before the internal object is allowed to get thread time.

Returns:

the number of ticks total

getCurrentTickDown

int getCurrentTickDown()

Returns the number of ticks remaining before the internal object is allowed to get thread time.

Returns:

the number of ticks remaining

setCurrentTickDownPending

void setCurrentTickDownPending()

Sets the number of ticks remaining before the internal object is allowed to get thread time to 1.

getTimeMSToNextTick

long getTimeMSToNextTick()

Gets the number of total milliseconds before another tick will occur., or -1.

Returns:

the number of ms to go