Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface I3Interface

All Superinterfaces:

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

All Known Implementing Classes:

IMudClient

public interface I3Interface
extends CMLibrary

Interface library between the mud and the InterMud 3 and Intermud 2 networks. This includes basic I3 and IMC2 functions and management.

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getI3MudList(boolean coffeemudOnly)	Returns the simple mud name list of all active I3 muds.
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.
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.
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
void	registerIMC2(java.lang.Object O)	Registers the given driver server as the active imc2 server for the entire mud.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

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

i3who

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

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

Parameters:

mob - the player requesting info

mudName - the mud info is requested about

i3tell

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.

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

i3channel

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

Sends an I3 channel message

Parameters:

mob - the player sending the message

channelName - the channel to send the message on

message - the message to send

i3locate

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

Parameters:

mob - the player requesting info

mobName - the char info is requested about

i3finger

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. That info is shown to the given player

Parameters:

mob - the player who did it

mobName - the char to request info about

mudName - the mud that the char is at

i3pingRouter

void i3pingRouter(MOB mob)

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.

Parameters:

mob - the player who did it

giveI3MudList

void giveI3MudList(MOB mob)

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

Parameters:

mob - the player to show the list to

getI3MudList

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

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

Parameters:

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

Returns:

the list of mud names

giveIMC2MudList

void giveIMC2MudList(MOB mob)

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

Parameters:

mob - the player to show the list to

registerIMC2

void registerIMC2(java.lang.Object O)

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

Parameters:

O - the IMC2Driver server

isI3channel

boolean isI3channel(java.lang.String channelName)

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

Parameters:

channelName - the channel name to check

Returns:

true if its real, false otherwise

isIMC2channel

boolean isIMC2channel(java.lang.String channelName)

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

Parameters:

channelName - the channel name to check

Returns:

true if its real, false otherwise

i3online

boolean i3online()

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

Returns:

whether i3 is online

imc2online

boolean imc2online()

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

Returns:

whether imc2 is online

i3chanwho

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.

Parameters:

mob - the player who is curious

channel - the channel in question

mudName - the mud to query

giveI3ChannelsList

void giveI3ChannelsList(MOB mob)

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

Parameters:

mob - the player who wants info

giveIMC2ChannelsList

void giveIMC2ChannelsList(MOB mob)

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

Parameters:

mob - the player who wants info

i3channelListen

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

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

Parameters:

mob - the player doing the subscribeing

channel - the possible channel name to subscribe

i3channelSilence

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

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

Parameters:

mob - the player doing the un-subscribeing

channel - the possible channel name to un-subscribe

i3channelAdd

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

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

Parameters:

mob - the player doing the registering

channel - the possible channel name to register

i3channelRemove

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

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

Parameters:

mob - the player doing the de-registering

channel - the possible channel name to de-register

i3mudInfo

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.

Parameters:

mob - the player who wants the info

parms - the possible mud name to get info on

imc2mudInfo

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.

Parameters:

mob - the player who wants the info

parms - the possible mud name to get info on