Table of Contents

Class: CoderCommands mudlib/coder.py

This class encapsulates all the coder commands. Typically, these methods don't get called by the mudlib directly but rather at the behest of the coder through input events.

Base Classes   
core.Object
Methods   
catFile
changeDirectory
cloneObject
copyFile
createDirectory
destroyObject
displayAttachments
doExorcise
dumpAttributes
editFileWithCoolEditor
editFileWithLineEditor
execCommand
exorcise
getStatistics
getTime
headFile
invokeMethod
listDirectory
moreFile
popDirectory
possess
printCWD
printWorkingDirectory
pushDirectory
register
removeDirectory
removeFile
shutdown
tailFile
touchFile
transport
updateClass
zap
  catFile 
catFile (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the cat coder command.

Dumps the contents of a file to the coder's screen.

  changeDirectory 
changeDirectory (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the cd command.

Changes the working directory.

  cloneObject 
cloneObject (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the clone coder command.

Valid syntax: clone <python-path>. This method will cause a new instance of the class represented by the given python path to be instantiated properly via the driver. The object will then be moved to the coder, if possible, or the coder's environment. If both fail, then the object ends up in limbo.

  copyFile 
copyFile (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the cp command.

Valid syntax is cp &lt;source&gt; &lt;target&gt; where <source> and <target> are fully-qualified path names. It does not handle copying directories and a bunch of other stuff the unix cp does.

  createDirectory 
createDirectory (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the mkdir command.

Creates a new directory.

  destroyObject 
destroyObject (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the destroy coder command.

Valid syntax: destroy &lt;object&gt;. This method invokes the pseudo-destructor of the target object.

  displayAttachments 
displayAttachments (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the attachments coder command.

Displays all the attachments in the coder's current environment.

  doExorcise 
doExorcise ( self,  target )

Exorcises a player from the controlling coder.

  dumpAttributes 
dumpAttributes (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the dump coder command.

Valid syntax: dump &lt;object&gt;. This method dumps the attributes and methods associated with a MudObject as well as SocketProperties (in the case of a Player).

  editFileWithCoolEditor 
editFileWithCoolEditor (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the mpico and nomacs coder commands.

Instantiates a "cool" editor instance to edit the file specified in arguments.

  editFileWithLineEditor 
editFileWithLineEditor (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the edit coder command.

Instantiates a line editor to edit the file in question.

  execCommand 
execCommand (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the exec coder command.

Valid syntax "exec [code]". If a line of code is given after the command, then it will be executed. If no code is given, then the coder will be taken into an editor and the edited code will be executed.

  exorcise 
exorcise (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the exorcise command.

Exorcises a player from the controlling coder.

  getStatistics 
getStatistics (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the stats coder command.

Valid syntax: stats. This method dumps various MUD statistics to the coder.

  getTime 
getTime (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the time command.

Allows you to get the current datetime in the mud.

  headFile 
headFile (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the head command.

Dump the top part of a file to the coder's screen.

  invokeMethod 
invokeMethod (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the call coder command.

Valid syntax: 'call <object> <method> [arguments]'. This method invokes a given method in a given object, passing it the optional arguments. The arguments must be separated by %% and must appear just as they would if in python code (ie, strings must be surrounded by quotes, lists must be surrounded by brackets, and so on). Due to a parser bug, spaces must not appear anywhere in the arguments string. This will be fixed at some point in the future.

  listDirectory 
listDirectory (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the ls command.

Gets a directoy listing and pretty-prints it.

  moreFile 
moreFile (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the more command.

Dump the contents of a file to the coder's screen. similar to cat, except this will do it by the screen full.

  popDirectory 
popDirectory (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the popd command.

Pops a directory off of the stack. This (and pushd) allows coders to easily traverse the file system.

  possess 
possess (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the possess command.

Possesses a player (interactive) so that the coder can control the player.

  printCWD 
printCWD ( self )

Implements the pwd command.

Prints the current working directory to the player. The current working directory is an attribute on the player object. If it hasn't been set, then the home directory is the default.

returns:

(string) the current working directory based on the world data root

  printWorkingDirectory 
printWorkingDirectory (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the pwd command.

Prints the current working directory.

  pushDirectory 
pushDirectory (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the pushd command.

Pushes a directory onto the stack. This (and popd) allows coders to easily traverse the file system.

  register 
register ( self,  manager )

  removeDirectory 
removeDirectory (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the rmdir command.

Removes a directory from the file system. The directory must be empty.

  removeFile 
removeFile (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the rm command.

Removes a file from the file system.

  shutdown 
shutdown (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the shutdown coder command.

Valid syntax: shutdown. This method shuts down the MUD. There is no way to cancel a shutdown once begun.

FIXME - need security here--not everyone should be able to shutdown the mud.

  tailFile 
tailFile (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the tail command.

Dump the bottom part of a file to the coder's screen.

  touchFile 
touchFile (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the touch command.

Touches a file updating its timestamp.

  transport 
transport (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the goto coder command.

Valid syntaxes: goto &lt;room-path&gt; and goto &lt;player-name&gt;. This method will move the coder to the specified destination room or to the environment of the specified player.

  updateClass 
updateClass (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the update coder command.

Valid syntaxes: update &lt;object&gt; or update &lt;python-path&gt;. This method will cause the module in which the target object resides (or the module specified by the python path) to be reloaded.

  zap 
zap (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the zap coder command.

Valid syntax: zap &lt;interactive. This method causes the target interactive to die.


Table of Contents

This document was automatically generated on Thu Jan 24 08:57:43 2002 by HappyDoc version 2.0