Package com.planet_ink.coffee_mud.Items.interfaces

Interface Perfume

All Known Implementing Classes:

GenPerfume, StdPerfume

public interface Perfume

A perfume item is one that can be "worn", and when worn, causes smell-message emotes to issue forth for others in the same room.

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getSmellEmotes()	Retrieves a list of the possible smell emotes when worn.
java.lang.String	getSmellList()	Gets the list of possible smell emotes when worn as a semicolon delimited list of strings.
void	setSmellList(java.lang.String list)	Sets the list of possible smell emotes when worn as a semicolon delimited list of strings.
void	wearIfAble(MOB mob)	Causes this perfume to be "worn" on the given mob.

Method Detail

getSmellEmotes

java.util.List<java.lang.String> getSmellEmotes()

Retrieves a list of the possible smell emotes when worn.

Returns:

a list of the possible smell emotes when worn.

getSmellList

java.lang.String getSmellList()

Gets the list of possible smell emotes when worn as a semicolon delimited list of strings.

Returns:

the list of possible smell emotes

See Also:

setSmellList(String)

setSmellList

void setSmellList(java.lang.String list)

Sets the list of possible smell emotes when worn as a semicolon delimited list of strings.

Parameters:

list - the list of possible smell emotes

See Also:

getSmellList()

wearIfAble

void wearIfAble(MOB mob)

Causes this perfume to be "worn" on the given mob. They will, for a time, begin emotting the smells.

Parameters:

mob - the mob to wear the perfume.