Package com.planet_ink.coffee_mud.core.intermud

Class IMudClient

java.lang.Object

com.planet_ink.coffee_mud.core.intermud.IMudClient

All Implemented Interfaces:

CMObject, CMLibrary, I3Interface, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class IMudClient
extends java.lang.Object
implements I3Interface

Field Summary

Fields

Modifier and Type	Field	Description
IMC2Driver	imc2

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

idConverter

Constructor Summary

Constructors

Constructor	Description
IMudClient()

Method Summary

Modifier and Type	Method	Description
boolean	activate()	Activates the library.
int	compareTo(CMObject o)
CMObject	copyOf()	Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
void	destroymob(MOB mob)
java.util.List<java.lang.String>	getI3MudList(boolean coffeemudOnly)	Returns the simple mud name list of all active I3 muds.
java.lang.String	getMudInfo(I3Mud mudToShow)
TickClient	getServiceClient()	If this library has a service thread, this method returns the TickClient object associated with that service.
protected java.util.List<I3Mud>	getSortedI3Muds()
void	giveI3ChannelsList(MOB mob)	Show the list of available I3 channels to the given player.
void	giveI3MudList(MOB mob)	Shows the list of active I3 muds to the given mobs.
void	giveIMC2ChannelsList(MOB mob)	Show the list of available IMC2 channels to the given player.
void	giveIMC2MudList(MOB mob)	Shows the list of active IMC2 muds to the given mobs.
void	i3channel(MOB mob, java.lang.String channelName, java.lang.String message)	Sends an I3 channel message
void	i3channelAdd(MOB mob, java.lang.String channel)	An administrative command to register a particular channel on the I3 network.
void	i3channelListen(MOB mob, java.lang.String channel)	An administrative command to subscribe to a particular channel on the I3 network.
void	i3channelRemove(MOB mob, java.lang.String channel)	An administrative command to de-register a particular channel on the I3 network.
void	i3channelSilence(MOB mob, java.lang.String channel)	An administrative command to un-subscribe a particular channel on the I3 network.
void	i3chanwho(MOB mob, java.lang.String channel, java.lang.String mudName)	Queries another mud on the I3 network for a list of which players on that mud are listening on a particular channel.
void	i3finger(MOB mob, java.lang.String mobName, java.lang.String mudName)	Sends a finger packet to the target mud requesting info about the given user on that i3 mud.
void	i3locate(MOB mob, java.lang.String mobName)	Sends a locate packet to the i3 router requesting which mud a character with the given name exists on, and also returning this fact and the char status to the given player
void	i3mudInfo(MOB mob, java.lang.String parms)	Send a request for information about a mud on the I3 network on behalf of the given player.
boolean	i3online()	Returns whether the mud is presently connected to the I3 server.
void	i3pingRouter(MOB mob)	Sends a ping packet to the i3 router, which is only partially supported.
void	i3tell(MOB mob, java.lang.String tellName, java.lang.String mudName, java.lang.String message)	Sends a tell private message from the given player to a character on an I3 mud.
void	i3who(MOB mob, java.lang.String mudName)	Requests a list of characters online on the given i3 mud.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
void	imc2mudInfo(MOB mob, java.lang.String parms)	Send a request for information about a mud on the IMC2 network on behalf of the given player.
boolean	imc2online()	Returns whether the mud is presently connected to the IMC2 server.
void	initializeClass()	Called ONCE after all objects are loaded, but before the map is read in during initialization.
boolean	isI3channel(java.lang.String channelName)	Returns whether the given string represents a real mud-mapped im3 channel name
boolean	isIMC2channel(java.lang.String channelName)	Returns whether the given string represents a real mud-mapped imc2 channel name
java.lang.String	L(java.lang.String str, java.lang.String... xs)	Localize an internal string -- shortcut.
java.util.List<I3Mud>	mudFinder(java.lang.String parms)
java.lang.String	name()	The displayable name of this object.
CMObject	newInstance()	Returns a new instance of this class.
void	propertiesLoaded()	This method is called whenever system properties are altered by the user.
void	registerIMC2(java.lang.Object O)	Registers the given driver server as the active imc2 server for the entire mud.
boolean	shutdown()	Shuts down the library.
java.lang.String	socialFixOut(java.lang.String str)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

imc2

public IMC2Driver imc2

Constructor Detail

IMudClient

public IMudClient()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Returns:

the name of this class

name

public java.lang.String name()

Description copied from interface: CMObject

The displayable name of this object. May be modified by phyStats() object. Is derived from the Name().

Specified by:

name in interface CMObject

Returns:

the modified final name of this object on the map.

See Also:

Environmental.Name()

newInstance

public CMObject newInstance()

Description copied from interface: CMObject

Returns a new instance of this class.

Specified by:

newInstance in interface CMObject

Returns:

a new instance of this class

initializeClass

public void initializeClass()

Description copied from interface: CMObject

Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:

initializeClass in interface CMObject

copyOf

public CMObject copyOf()

Description copied from interface: CMObject

Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:

copyOf in interface CMObject

Returns:

a clone of this object

L

public java.lang.String L(java.lang.String str,
                          java.lang.String... xs)

Description copied from interface: CMLibrary

Localize an internal string -- shortcut. Same as calling:

Specified by:

L in interface CMLibrary

Parameters:

str - the string to translate

xs - the array of variables to replace

Returns:

the translated string, with all variables in place

See Also:

Call with the string to translate, which may contain variables of the form @x1, @x2, etc. The array in xs is then used to replace the variables AFTER the string is translated.

compareTo

public int compareTo(CMObject o)

Specified by:

compareTo in interface java.lang.Comparable<CMObject>

activate

public boolean activate()

Description copied from interface: CMLibrary

Activates the library. This is called after the mud is booted, but before connections are accepted.

Specified by:

activate in interface CMLibrary

Returns:

true if activation was successful, false if you're screwed

See Also:

CMLibrary.shutdown()

shutdown

public boolean shutdown()

Description copied from interface: CMLibrary

Shuts down the library. Called at system shutdown time obviously, but is sometimes called just to reset the library.

Specified by:

shutdown in interface CMLibrary

Returns:

true if shutdown was successful, false if there's nothing you can do about it

See Also:

CMLibrary.activate()

propertiesLoaded

public void propertiesLoaded()

Description copied from interface: CMLibrary

This method is called whenever system properties are altered by the user. This allows the library to react to any important properties they monitor.

Specified by:

propertiesLoaded in interface CMLibrary

getServiceClient

public TickClient getServiceClient()

Description copied from interface: CMLibrary

If this library has a service thread, this method returns the TickClient object associated with that service. Normally returns null, since most libraries don't set themselves up to receive thread time.

Specified by:

getServiceClient in interface CMLibrary

Returns:

null, or the TickClient for the service

See Also:

TickClient

registerIMC2

public void registerIMC2(java.lang.Object O)

Description copied from interface: I3Interface

Registers the given driver server as the active imc2 server for the entire mud.

Specified by:

registerIMC2 in interface I3Interface

Parameters:

O - the IMC2Driver server

i3who

public void i3who(MOB mob,
                  java.lang.String mudName)

Description copied from interface: I3Interface

Requests a list of characters online on the given i3 mud.

Specified by:

i3who in interface I3Interface

Parameters:

mob - the player requesting info

mudName - the mud info is requested about

i3online

public boolean i3online()

Description copied from interface: I3Interface

Returns whether the mud is presently connected to the I3 server.

Specified by:

i3online in interface I3Interface

Returns:

whether i3 is online

imc2online

public boolean imc2online()

Description copied from interface: I3Interface

Returns whether the mud is presently connected to the IMC2 server.

Specified by:

imc2online in interface I3Interface

Returns:

whether imc2 is online

imc2mudInfo

public void imc2mudInfo(MOB mob,
                        java.lang.String parms)

Description copied from interface: I3Interface

Send a request for information about a mud on the IMC2 network on behalf of the given player.

Specified by:

imc2mudInfo in interface I3Interface

Parameters:

mob - the player who wants the info

parms - the possible mud name to get info on

i3chanwho

public void i3chanwho(MOB mob,
                      java.lang.String channel,
                      java.lang.String mudName)

Description copied from interface: I3Interface

Queries another mud on the I3 network for a list of which players on that mud are listening on a particular channel.

Specified by:

i3chanwho in interface I3Interface

Parameters:

mob - the player who is curious

channel - the channel in question

mudName - the mud to query

i3channelAdd

public void i3channelAdd(MOB mob,
                         java.lang.String channel)

Description copied from interface: I3Interface

An administrative command to register a particular channel on the I3 network.

Specified by:

i3channelAdd in interface I3Interface

Parameters:

mob - the player doing the registering

channel - the possible channel name to register

i3channelListen

public void i3channelListen(MOB mob,
                            java.lang.String channel)

Description copied from interface: I3Interface

An administrative command to subscribe to a particular channel on the I3 network.

Specified by:

i3channelListen in interface I3Interface

Parameters:

mob - the player doing the subscribeing

channel - the possible channel name to subscribe

i3channelSilence

public void i3channelSilence(MOB mob,
                             java.lang.String channel)

Description copied from interface: I3Interface

An administrative command to un-subscribe a particular channel on the I3 network.

Specified by:

i3channelSilence in interface I3Interface

Parameters:

mob - the player doing the un-subscribeing

channel - the possible channel name to un-subscribe

i3channelRemove

public void i3channelRemove(MOB mob,
                            java.lang.String channel)

Description copied from interface: I3Interface

An administrative command to de-register a particular channel on the I3 network.

Specified by:

i3channelRemove in interface I3Interface

Parameters:

mob - the player doing the de-registering

channel - the possible channel name to de-register

i3tell

public void i3tell(MOB mob,
                   java.lang.String tellName,
                   java.lang.String mudName,
                   java.lang.String message)

Description copied from interface: I3Interface

Sends a tell private message from the given player to a character on an I3 mud.

Specified by:

i3tell in interface I3Interface

Parameters:

mob - the player sending the message

tellName - the char to send the message to

mudName - the mud the char is on

message - the message being sent to the char

destroymob

public void destroymob(MOB mob)

i3channel

public void i3channel(MOB mob,
                      java.lang.String channelName,
                      java.lang.String message)

Description copied from interface: I3Interface

Sends an I3 channel message

Specified by:

i3channel in interface I3Interface

Parameters:

mob - the player sending the message

channelName - the channel to send the message on

message - the message to send

i3locate

public void i3locate(MOB mob,
                     java.lang.String mobName)

Description copied from interface: I3Interface

Sends a locate packet to the i3 router requesting which mud a character with the given name exists on, and also returning this fact and the char status to the given player

Specified by:

i3locate in interface I3Interface

Parameters:

mob - the player requesting info

mobName - the char info is requested about

i3pingRouter

public void i3pingRouter(MOB mob)

Description copied from interface: I3Interface

Sends a ping packet to the i3 router, which is only partially supported. Effectively the router just sends your packet right back, because the target mud is THIS one.

Specified by:

i3pingRouter in interface I3Interface

Parameters:

mob - the player who did it

i3finger

public void i3finger(MOB mob,
                     java.lang.String mobName,
                     java.lang.String mudName)

Description copied from interface: I3Interface

Sends a finger packet to the target mud requesting info about the given user on that i3 mud. That info is shown to the given player

Specified by:

i3finger in interface I3Interface

Parameters:

mob - the player who did it

mobName - the char to request info about

mudName - the mud that the char is at

getMudInfo

public java.lang.String getMudInfo(I3Mud mudToShow)

mudFinder

public java.util.List<I3Mud> mudFinder(java.lang.String parms)

i3mudInfo

public void i3mudInfo(MOB mob,
                      java.lang.String parms)

Description copied from interface: I3Interface

Send a request for information about a mud on the I3 network on behalf of the given player.

Specified by:

i3mudInfo in interface I3Interface

Parameters:

mob - the player who wants the info

parms - the possible mud name to get info on

giveIMC2MudList

public void giveIMC2MudList(MOB mob)

Description copied from interface: I3Interface

Shows the list of active IMC2 muds to the given mobs.

Specified by:

giveIMC2MudList in interface I3Interface

Parameters:

mob - the player to show the list to

getSortedI3Muds

protected java.util.List<I3Mud> getSortedI3Muds()

getI3MudList

public java.util.List<java.lang.String> getI3MudList(boolean coffeemudOnly)

Description copied from interface: I3Interface

Returns the simple mud name list of all active I3 muds.

Specified by:

getI3MudList in interface I3Interface

Parameters:

coffeemudOnly - true to only send back coffeemuds, false for all

Returns:

the list of mud names

giveI3MudList

public void giveI3MudList(MOB mob)

Description copied from interface: I3Interface

Shows the list of active I3 muds to the given mobs.

Specified by:

giveI3MudList in interface I3Interface

Parameters:

mob - the player to show the list to

giveI3ChannelsList

public void giveI3ChannelsList(MOB mob)

Description copied from interface: I3Interface

Show the list of available I3 channels to the given player.

Specified by:

giveI3ChannelsList in interface I3Interface

Parameters:

mob - the player who wants info

giveIMC2ChannelsList

public void giveIMC2ChannelsList(MOB mob)

Description copied from interface: I3Interface

Show the list of available IMC2 channels to the given player.

Specified by:

giveIMC2ChannelsList in interface I3Interface

Parameters:

mob - the player who wants info

isIMC2channel

public boolean isIMC2channel(java.lang.String channelName)

Description copied from interface: I3Interface

Returns whether the given string represents a real mud-mapped imc2 channel name

Specified by:

isIMC2channel in interface I3Interface

Parameters:

channelName - the channel name to check

Returns:

true if its real, false otherwise

isI3channel

public boolean isI3channel(java.lang.String channelName)

Description copied from interface: I3Interface

Returns whether the given string represents a real mud-mapped im3 channel name

Specified by:

isI3channel in interface I3Interface

Parameters:

channelName - the channel name to check

Returns:

true if its real, false otherwise

socialFixOut

public java.lang.String socialFixOut(java.lang.String str)