com.planet_ink.coffee_mud.core.intermud
Class IMudClient

java.lang.Object
  extended by 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
 IMC2Driver imc2
           
 
Constructor Summary
IMudClient()
           
 
Method Summary
 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)
           
 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)
           
 void giveI3MudList(MOB mob)
           
 void giveIMC2ChannelsList(MOB mob)
           
 void giveIMC2MudList(MOB mob)
           
 void i3channel(MOB mob, java.lang.String channelName, java.lang.String message)
           
 void i3channelAdd(MOB mob, java.lang.String channel)
           
 void i3channelListen(MOB mob, java.lang.String channel)
           
 void i3channelRemove(MOB mob, java.lang.String channel)
           
 void i3channelSilence(MOB mob, java.lang.String channel)
           
 void i3chanwho(MOB mob, java.lang.String channel, java.lang.String mudName)
           
 void i3finger(MOB mob, java.lang.String mobName, java.lang.String mudName)
           
 void i3locate(MOB mob, java.lang.String mobName)
           
 void i3mudInfo(MOB mob, java.lang.String parms)
           
 boolean i3online()
           
 void i3pingRouter(MOB mob)
           
 void i3tell(MOB mob, java.lang.String tellName, java.lang.String mudName, java.lang.String message)
           
 void i3who(MOB mob, java.lang.String mudName)
           
 java.lang.String ID()
          The CoffeeMud Java Class ID shared by all instances of this object.
 void imc2mudInfo(MOB mob, java.lang.String parms)
           
 boolean imc2online()
           
 void initializeClass()
          Called ONCE after all objects are loaded, but before the map is read in during initialization.
 boolean isI3channel(java.lang.String channelName)
           
 boolean isIMC2channel(java.lang.String channelName)
           
 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)
           
 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)
Specified by:
registerIMC2 in interface I3Interface

i3who

public void i3who(MOB mob,
                  java.lang.String mudName)
Specified by:
i3who in interface I3Interface

i3online

public boolean i3online()
Specified by:
i3online in interface I3Interface

imc2online

public boolean imc2online()
Specified by:
imc2online in interface I3Interface

imc2mudInfo

public void imc2mudInfo(MOB mob,
                        java.lang.String parms)
Specified by:
imc2mudInfo in interface I3Interface

i3chanwho

public void i3chanwho(MOB mob,
                      java.lang.String channel,
                      java.lang.String mudName)
Specified by:
i3chanwho in interface I3Interface

i3channelAdd

public void i3channelAdd(MOB mob,
                         java.lang.String channel)
Specified by:
i3channelAdd in interface I3Interface

i3channelListen

public void i3channelListen(MOB mob,
                            java.lang.String channel)
Specified by:
i3channelListen in interface I3Interface

i3channelSilence

public void i3channelSilence(MOB mob,
                             java.lang.String channel)
Specified by:
i3channelSilence in interface I3Interface

i3channelRemove

public void i3channelRemove(MOB mob,
                            java.lang.String channel)
Specified by:
i3channelRemove in interface I3Interface

i3tell

public void i3tell(MOB mob,
                   java.lang.String tellName,
                   java.lang.String mudName,
                   java.lang.String message)
Specified by:
i3tell in interface I3Interface

destroymob

public void destroymob(MOB mob)

i3channel

public void i3channel(MOB mob,
                      java.lang.String channelName,
                      java.lang.String message)
Specified by:
i3channel in interface I3Interface

i3locate

public void i3locate(MOB mob,
                     java.lang.String mobName)
Specified by:
i3locate in interface I3Interface

i3pingRouter

public void i3pingRouter(MOB mob)
Specified by:
i3pingRouter in interface I3Interface

i3finger

public void i3finger(MOB mob,
                     java.lang.String mobName,
                     java.lang.String mudName)
Specified by:
i3finger in interface I3Interface

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)
Specified by:
i3mudInfo in interface I3Interface

giveIMC2MudList

public void giveIMC2MudList(MOB mob)
Specified by:
giveIMC2MudList in interface I3Interface

getSortedI3Muds

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

getI3MudList

public java.util.List<java.lang.String> getI3MudList(boolean coffeemudOnly)
Specified by:
getI3MudList in interface I3Interface

giveI3MudList

public void giveI3MudList(MOB mob)
Specified by:
giveI3MudList in interface I3Interface

giveI3ChannelsList

public void giveI3ChannelsList(MOB mob)
Specified by:
giveI3ChannelsList in interface I3Interface

giveIMC2ChannelsList

public void giveIMC2ChannelsList(MOB mob)
Specified by:
giveIMC2ChannelsList in interface I3Interface

isIMC2channel

public boolean isIMC2channel(java.lang.String channelName)
Specified by:
isIMC2channel in interface I3Interface

isI3channel

public boolean isI3channel(java.lang.String channelName)
Specified by:
isI3channel in interface I3Interface

socialFixOut

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