com.planet_ink.coffee_mud.Common.interfaces
Interface Tattoo

All Superinterfaces:

java.lang.Cloneable, CMCommon, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

DefaultTattoo

public interface Tattoo
extends java.lang.Cloneable, CMObject, CMCommon

Tattoos are arbitrary markers or flags. They server no other purpose other than to be checked by other things for their existence. They can automatically expire by setting a tick down, or a number of ticks to live.

Method Summary

java.lang.String	getTattooName() Returns the tattoo Name
int	getTickDown() Returns the current tick-down
Tattoo	parse(java.lang.String tattooCode) Parse a new tattoo object from the coded data, of the form: TATOONAME or NUMBER TATTOONAME
Tattoo	set(java.lang.String name) Set the tattoo name
Tattoo	set(java.lang.String name, int down) Set the tatoo name and tick-down
int	tickDown() Reduces the tick down by one and returns the new value

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

set

Tattoo set(java.lang.String name)

Set the tattoo name

Parameters:

name - the tattoo name

Returns:

this

set

Tattoo set(java.lang.String name,
           int down)

Set the tatoo name and tick-down

Parameters:

name - the tatoo name

down - the tick down life span

Returns:

this

getTickDown

int getTickDown()

Returns the current tick-down

Returns:

the tickDown

tickDown

int tickDown()

Reduces the tick down by one and returns the new value

Returns:

the new tick down

getTattooName

java.lang.String getTattooName()

Returns the tattoo Name

Returns:

the tattooName

parse

Tattoo parse(java.lang.String tattooCode)

Parse a new tattoo object from the coded data, of the form: TATOONAME or NUMBER TATTOONAME

Parameters:

tattooCode - coded data

Returns:

this tattoo