Module Expr Str ImportFrom alias ImportFrom alias Assign NameStore TupleLoad Str Str ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call AttributeLoad Call NameLoad NameLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Pass decorator_list FunctionDef arguments args NameParam defaults body Expr Str Pass decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore ListLoad If BoolOpAnd NameLoad CompareGt Call NameLoad NameLoad Num CompareEq SubscriptLoad NameLoad Index Num Str body Assign NameStore Call AttributeLoad SubscriptLoad NameLoad Slice Num attr NameLoad Num If CompareGt Call NameLoad NameLoad Num body Assign TupleStore NameStore NameStore NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str orelse Assign NameStore Str Assign NameStore Call AttributeLoad SubscriptLoad NameLoad Index Num attr Str Assign NameStore ListComp Call AttributeLoad NameLoad attr comprehension NameStore Call AttributeLoad NameLoad attr Assign TupleStore NameStore NameStore TupleLoad NameLoad NameLoad Assign TupleStore NameStore NameStore TupleLoad ListComp Call AttributeLoad NameLoad attr comprehension NameStore Call AttributeLoad NameLoad attr Str ListLoad If BoolOpAnd NameLoad CompareIn Str NameLoad body Assign TupleStore NameStore NameStore ListComp Call AttributeLoad NameLoad attr comprehension NameStore Call AttributeLoad NameLoad attr Str Num Assign NameStore ListComp Call AttributeLoad NameLoad attr comprehension NameStore Call AttributeLoad NameLoad attr Str Assign NameStore ListComp Call AttributeLoad NameLoad attr comprehension NameStore Call AttributeLoad NameLoad attr Str Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore BinOpMult Str Num AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMult Str Num AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore Call AttributeLoad NameLoad attr BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpAdd Str BinOpMult Str Num AugAssignAdd NameStore Str AugAssignAdd NameStore BinOpMult Str Num AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMod Str AttributeLoad NameLoad attr AugAssignAdd NameStore BinOpMult Str Num Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam defaults body Expr Str Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr If Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr Str body Assign AttributeStore NameLoad attr AttributeLoad NameLoad attr Assign AttributeStore NameLoad attr AttributeLoad AttributeLoad NameLoad attr attr orelse If Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr Str body Assign AttributeStore NameLoad attr Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr orelse Assign AttributeStore NameLoad attr NameLoad decorator_list decorator_list
N/A N/A 
The command template for the default MUX-style command set. There
is also an Player/OOC version that makes sure caller is a Player object.
 evennia.utils utils evennia.commands.command Command N/A __all__ N/A MuxCommand MuxPlayerCommand MuxCommand N/A Command N/A N/A 
    This sets up the basis for a MUX command. The idea
    is that most other Mux-related commands should just
    inherit from this and don't have to implement much
    parsing of their own unless they do something particularly
    advanced.

    Note that the class's __doc__ string (this text) is
    used by Evennia to create the automatic help entry for
    the command, so make sure to document consistently here.
     has_perm N/A N/A self srcobj N/A N/A N/A 
        This is called by the cmdhandler to determine
        if srcobj is allowed to execute this command.
        We just show it here for completeness - we
        are satisfied using the default check in Command.
         N/A N/A N/A N/A super MuxCommand self has_perm srcobj N/A at_pre_cmd N/A N/A self N/A N/A N/A 
        This hook is called before self.parse() on all commands
         N/A N/A at_post_cmd N/A N/A self N/A N/A N/A 
        This hook is called after the command has finished executing
        (after self.func()).
         N/A N/A parse N/A N/A self N/A N/A N/A 
        This method is called by the cmdhandler once the command name
        has been identified. It creates a new set of member variables
        that can be later accessed from self.func() (see below)

        The following variables are available for our use when entering this
        method (from the command definition, and assigned on the fly by the
        cmdhandler):
           self.key - the name of this command ('look')
           self.aliases - the aliases of this cmd ('l')
           self.permissions - permission string for this command
           self.help_category - overall category of command

           self.caller - the object calling this command
           self.cmdstring - the actual command name used to call this
                            (this allows you to know which alias was used,
                             for example)
           self.args - the raw input; everything following self.cmdstring.
           self.cmdset - the cmdset from which this command was picked. Not
                         often used (useful for commands like 'help' or to
                         list all available commands etc)
           self.obj - the object on which this command was defined. It is often
                         the same as self.caller.

        A MUX command has the following possible syntax:

          name[ with several words][/switch[/switch..]] arg1[,arg2,...] [[=|,] arg[,..]]

        The 'name[ with several words]' part is already dealt with by the
        cmdhandler at this point, and stored in self.cmdname (we don't use
        it here). The rest of the command is stored in self.args, which can
        start with the switch indicator /.

        This parser breaks self.args into its constituents and stores them in the
        following variables:
          self.switches = [list of /switches (without the /)]
          self.raw = This is the raw argument input, including switches
          self.args = This is re-defined to be everything *except* the switches
          self.lhs = Everything to the left of = (lhs:'left-hand side'). If
                     no = is found, this is identical to self.args.
          self.rhs: Everything to the right of = (rhs:'right-hand side').
                    If no '=' is found, this is None.
          self.lhslist - [self.lhs split into a list by comma]
          self.rhslist - [list of self.rhs split into a list by comma]
          self.arglist = [list of space-separated args (stripped, including '=' if it exists)]

          All args and list members are stripped of excess whitespace around the
          strings, but case is preserved.
         N/A raw N/A self args N/A args N/A N/A raw strip N/A switches N/A N/A N/A args N/A N/A len args 1 N/A N/A args N/A 0 / N/A N/A switches N/A N/A N/A args N/A 1 split None 1 N/A N/A N/A len switches 1 N/A N/A N/A switches args switches N/A switches N/A N/A switches split / N/A N/A args N/A switches N/A N/A N/A switches N/A 0 split / N/A arglist N/A N/A N/A arg strip N/A arg N/A N/A args split N/A N/A lhs rhs N/A args None N/A N/A lhslist rhslist N/A N/A N/A N/A arg strip N/A arg N/A N/A args split , N/A N/A N/A args N/A = args N/A N/A N/A lhs rhs N/A N/A N/A arg strip N/A arg N/A N/A args split = 1 N/A lhslist N/A N/A N/A arg strip N/A arg N/A N/A lhs split , N/A rhslist N/A N/A N/A arg strip N/A arg N/A N/A rhs split , N/A N/A self raw raw N/A N/A self switches switches N/A N/A self args N/A N/A args strip N/A N/A self arglist arglist N/A N/A self lhs lhs N/A N/A self lhslist lhslist N/A N/A self rhs rhs N/A N/A self rhslist rhslist N/A func N/A N/A self N/A N/A N/A 
        This is the hook function that actually does all the work. It is called
         by the cmdhandler right after self.parser() finishes, and so has access
         to all the variables defined therein.
         N/A string N/A - 50 N/A string N/A 
{w%s{n - Command variables from evennia:
 N/A self key N/A string N/A - 50 N/A string N/A 
name of cmd (self.key): {w%s{n
 N/A self key N/A string N/A cmd aliases (self.aliases): {w%s{n
 N/A self aliases N/A string N/A cmd locks (self.locks): {w%s{n
 N/A self locks N/A string N/A help category (self.help_category): {w%s{n
 N/A self help_category N/A string N/A object calling (self.caller): {w%s{n
 N/A self caller N/A string N/A object storing cmdset (self.obj): {w%s{n
 N/A self obj N/A string N/A command string given (self.cmdstring): {w%s{n
 N/A self cmdstring N/A string N/A N/A utils fill N/A current cmdset (self.cmdset): {w%s{n
 N/A self cmdset N/A string N/A N/A - 50 N/A string 
Variables from MuxCommand baseclass
 N/A string N/A - 50 N/A string N/A 
raw argument (self.raw): {w%s{n 
 N/A self raw N/A string N/A cmd args (self.args): {w%s{n
 N/A self args N/A string N/A cmd switches (self.switches): {w%s{n
 N/A self switches N/A string N/A space-separated arg list (self.arglist): {w%s{n
 N/A self arglist N/A string N/A lhs, left-hand side of '=' (self.lhs): {w%s{n
 N/A self lhs N/A string N/A lhs, comma separated (self.lhslist): {w%s{n
 N/A self lhslist N/A string N/A rhs, right-hand side of '=' (self.rhs): {w%s{n
 N/A self rhs N/A string N/A rhs, comma separated (self.rhslist): {w%s{n
 N/A self rhslist N/A string N/A - 50 N/A N/A N/A N/A self caller msg string N/A N/A MuxPlayerCommand N/A MuxCommand N/A N/A 
    This is an on-Player version of the MuxCommand. Since these commands sit
    on Players rather than on Characters/Objects, we need to check
    this in the parser.

    Player commands are available also when puppeting a Character, it's
    just that they are applied with a lower priority and are always
    available, also when disconnected from a character (i.e. "ooc").

    This class makes sure that caller is always a Player object, while
    creating a new property "character" that is set only if a
    character is actually attached to this Player and Session.
     parse N/A N/A self N/A N/A N/A 
        We run the parent parser as usual, then fix the result
         N/A N/A N/A N/A super MuxPlayerCommand self parse N/A N/A N/A utils inherits_from N/A self caller evennia.objects.objects.DefaultObject N/A N/A N/A self character N/A self caller N/A N/A self caller N/A N/A self caller player N/A N/A N/A N/A utils inherits_from N/A self caller evennia.players.players.DefaultPlayer N/A N/A N/A self character N/A N/A N/A self caller get_puppet N/A self session N/A N/A N/A self character None N/A N/A