evennia.commands.default.general¶
General Character commands usually available to all characters
-
class
evennia.commands.default.general.
CmdHome
(**kwargs)[source]¶ Bases:
evennia.commands.default.muxcommand.MuxCommand
move to your character’s home location
- Usage:
home
Teleports you to your home location.
-
key
= 'home'¶
-
locks
= 'cmd:perm(home) or perm(Builder)'¶
-
arg_regex
= re.compile('$', re.IGNORECASE)¶
-
aliases
= []¶
-
help_category
= 'general'¶
-
lock_storage
= 'cmd:perm(home) or perm(Builder)'¶
-
search_index_entry
= {'aliases': '', 'category': 'general', 'key': 'home', 'no_prefix': ' ', 'tags': '', 'text': "\n move to your character's home location\n\n Usage:\n home\n\n Teleports you to your home location.\n "}¶
-
class
evennia.commands.default.general.
CmdLook
(**kwargs)[source]¶ Bases:
evennia.commands.default.muxcommand.MuxCommand
look at location or object
- Usage:
look look <obj> look *<account>
Observes your location or objects in your vicinity.
-
key
= 'look'¶
-
aliases
= ['ls', 'l']¶
-
locks
= 'cmd:all()'¶
-
arg_regex
= re.compile('\\s|$', re.IGNORECASE)¶
-
help_category
= 'general'¶
-
lock_storage
= 'cmd:all()'¶
-
search_index_entry
= {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}¶
-
class
evennia.commands.default.general.
CmdNick
(**kwargs)[source]¶ Bases:
evennia.commands.default.muxcommand.MuxCommand
define a personal alias/nick by defining a string to match and replace it with another on the fly
- Usage:
nick[/switches] <string> [= [replacement_string]] nick[/switches] <template> = <replacement_template> nick/delete <string> or number nicks
- Switches:
inputline - replace on the inputline (default) object - replace on object-lookup account - replace on account-lookup list - show all defined aliases (also “nicks” works) delete - remove nick by index in /list clearall - clear all nicks
Examples
nick hi = say Hello, I’m Sarah! nick/object tom = the tall man nick build $1 $2 = create/drop $1;$2 nick tell $1 $2=page $1=$2 nick tm?$1=page tallman=$1 nick tm=$1=page tallman=$1
A ‘nick’ is a personal string replacement. Use $1, $2, … to catch arguments. Put the last $-marker without an ending space to catch all remaining text. You can also use unix-glob matching for the left-hand side <string>:
matches everything
? - matches 0 or 1 single characters [abcd] - matches these chars in any order [!abcd] - matches everything not among these chars = - escape literal ‘=’ you want in your <string>
Note that no objects are actually renamed or changed by this command - your nicks are only available to you. If you want to permanently add keywords to an object for everyone to use, you need build privileges and the alias command.
-
key
= 'nick'¶
-
switch_options
= ('inputline', 'object', 'account', 'list', 'delete', 'clearall')¶
-
aliases
= ['nickname', 'nicks']¶
-
locks
= 'cmd:all()'¶
-
help_category
= 'general'¶
-
lock_storage
= 'cmd:all()'¶
-
search_index_entry
= {'aliases': 'nickname nicks', 'category': 'general', 'key': 'nick', 'no_prefix': ' nickname nicks', 'tags': '', 'text': '\n define a personal alias/nick by defining a string to\n match and replace it with another on the fly\n\n Usage:\n nick[/switches] <string> [= [replacement_string]]\n nick[/switches] <template> = <replacement_template>\n nick/delete <string> or number\n nicks\n\n Switches:\n inputline - replace on the inputline (default)\n object - replace on object-lookup\n account - replace on account-lookup\n list - show all defined aliases (also "nicks" works)\n delete - remove nick by index in /list\n clearall - clear all nicks\n\n Examples:\n nick hi = say Hello, I\'m Sarah!\n nick/object tom = the tall man\n nick build $1 $2 = create/drop $1;$2\n nick tell $1 $2=page $1=$2\n nick tm?$1=page tallman=$1\n nick tm\\=$1=page tallman=$1\n\n A \'nick\' is a personal string replacement. Use $1, $2, ... to catch arguments.\n Put the last $-marker without an ending space to catch all remaining text. You\n can also use unix-glob matching for the left-hand side <string>:\n\n * - matches everything\n ? - matches 0 or 1 single characters\n [abcd] - matches these chars in any order\n [!abcd] - matches everything not among these chars\n \\= - escape literal \'=\' you want in your <string>\n\n Note that no objects are actually renamed or changed by this command - your nicks\n are only available to you. If you want to permanently add keywords to an object\n for everyone to use, you need build privileges and the alias command.\n\n '}¶
-
class
evennia.commands.default.general.
CmdInventory
(**kwargs)[source]¶ Bases:
evennia.commands.default.muxcommand.MuxCommand
view inventory
- Usage:
inventory inv
Shows your inventory.
-
key
= 'inventory'¶
-
aliases
= ['i', 'inv']¶
-
locks
= 'cmd:all()'¶
-
arg_regex
= re.compile('$', re.IGNORECASE)¶
-
help_category
= 'general'¶
-
lock_storage
= 'cmd:all()'¶
-
search_index_entry
= {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'no_prefix': ' i inv', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}¶
-
class
evennia.commands.default.general.
CmdSetDesc
(**kwargs)[source]¶ Bases:
evennia.commands.default.muxcommand.MuxCommand
describe yourself
- Usage:
setdesc <description>
Add a description to yourself. This will be visible to people when they look at you.
-
key
= 'setdesc'¶
-
locks
= 'cmd:all()'¶
-
arg_regex
= re.compile('\\s|$', re.IGNORECASE)¶
-
aliases
= []¶
-
help_category
= 'general'¶
-
lock_storage
= 'cmd:all()'¶
-
search_index_entry
= {'aliases': '', 'category': 'general', 'key': 'setdesc', 'no_prefix': ' ', 'tags': '', 'text': '\n describe yourself\n\n Usage:\n setdesc <description>\n\n Add a description to yourself. This\n will be visible to people when they\n look at you.\n '}¶
-
class
evennia.commands.default.general.
CmdGet
(**kwargs)[source]¶ Bases:
evennia.commands.default.general.NumberedTargetCommand
pick up something
- Usage:
get <obj>
Picks up an object from your location and puts it in your inventory.
-
key
= 'get'¶
-
aliases
= ['grab']¶
-
locks
= 'cmd:all()'¶
-
arg_regex
= re.compile('\\s|$', re.IGNORECASE)¶
-
help_category
= 'general'¶
-
lock_storage
= 'cmd:all()'¶
-
search_index_entry
= {'aliases': 'grab', 'category': 'general', 'key': 'get', 'no_prefix': ' grab', 'tags': '', 'text': '\n pick up something\n\n Usage:\n get <obj>\n\n Picks up an object from your location and puts it in your inventory.\n '}¶
-
class
evennia.commands.default.general.
CmdDrop
(**kwargs)[source]¶ Bases:
evennia.commands.default.general.NumberedTargetCommand
drop something
- Usage:
drop <obj>
Lets you drop an object from your inventory into the location you are currently in.
-
key
= 'drop'¶
-
locks
= 'cmd:all()'¶
-
arg_regex
= re.compile('\\s|$', re.IGNORECASE)¶
-
aliases
= []¶
-
help_category
= 'general'¶
-
lock_storage
= 'cmd:all()'¶
-
search_index_entry
= {'aliases': '', 'category': 'general', 'key': 'drop', 'no_prefix': ' ', 'tags': '', 'text': '\n drop something\n\n Usage:\n drop <obj>\n\n Lets you drop an object from your inventory into the\n location you are currently in.\n '}¶
-
class
evennia.commands.default.general.
CmdGive
(**kwargs)[source]¶ Bases:
evennia.commands.default.general.NumberedTargetCommand
give away something to someone
- Usage:
give <inventory obj> <to||=> <target>
Gives an item from your inventory to another person, placing it in their inventory.
-
key
= 'give'¶
-
rhs_split
= ('=', ' to ')¶
-
locks
= 'cmd:all()'¶
-
arg_regex
= re.compile('\\s|$', re.IGNORECASE)¶
-
aliases
= []¶
-
help_category
= 'general'¶
-
lock_storage
= 'cmd:all()'¶
-
search_index_entry
= {'aliases': '', 'category': 'general', 'key': 'give', 'no_prefix': ' ', 'tags': '', 'text': '\n give away something to someone\n\n Usage:\n give <inventory obj> <to||=> <target>\n\n Gives an item from your inventory to another person,\n placing it in their inventory.\n '}¶
-
class
evennia.commands.default.general.
CmdSay
(**kwargs)[source]¶ Bases:
evennia.commands.default.muxcommand.MuxCommand
speak as your character
- Usage:
say <message>
Talk to those in your current location.
-
key
= 'say'¶
-
aliases
= ['"', "'"]¶
-
locks
= 'cmd:all()'¶
-
arg_regex
= None¶
-
help_category
= 'general'¶
-
lock_storage
= 'cmd:all()'¶
-
search_index_entry
= {'aliases': '" \'', 'category': 'general', 'key': 'say', 'no_prefix': ' " \'', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}¶
-
class
evennia.commands.default.general.
CmdWhisper
(**kwargs)[source]¶ Bases:
evennia.commands.default.muxcommand.MuxCommand
Speak privately as your character to another
- Usage:
whisper <character> = <message> whisper <char1>, <char2> = <message>
Talk privately to one or more characters in your current location, without others in the room being informed.
-
key
= 'whisper'¶
-
locks
= 'cmd:all()'¶
-
aliases
= []¶
-
help_category
= 'general'¶
-
lock_storage
= 'cmd:all()'¶
-
search_index_entry
= {'aliases': '', 'category': 'general', 'key': 'whisper', 'no_prefix': ' ', 'tags': '', 'text': '\n Speak privately as your character to another\n\n Usage:\n whisper <character> = <message>\n whisper <char1>, <char2> = <message>\n\n Talk privately to one or more characters in your current location, without\n others in the room being informed.\n '}¶
-
class
evennia.commands.default.general.
CmdPose
(**kwargs)[source]¶ Bases:
evennia.commands.default.muxcommand.MuxCommand
strike a pose
- Usage:
pose <pose text> pose’s <pose text>
Example
- pose is standing by the wall, smiling.
-> others will see:
Tom is standing by the wall, smiling.
Describe an action being taken. The pose text will automatically begin with your name.
-
key
= 'pose'¶
-
aliases
= [':', 'emote']¶
-
locks
= 'cmd:all()'¶
-
arg_regex
= None¶
-
parse
()[source]¶ Custom parse the cases where the emote starts with some special letter, such as ‘s, at which we don’t want to separate the caller’s name and the emote with a space.
-
help_category
= 'general'¶
-
lock_storage
= 'cmd:all()'¶
-
search_index_entry
= {'aliases': ': emote', 'category': 'general', 'key': 'pose', 'no_prefix': ' : emote', 'tags': '', 'text': "\n strike a pose\n\n Usage:\n pose <pose text>\n pose's <pose text>\n\n Example:\n pose is standing by the wall, smiling.\n -> others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n "}¶
-
class
evennia.commands.default.general.
CmdAccess
(**kwargs)[source]¶ Bases:
evennia.commands.default.muxcommand.MuxCommand
show your current game access
- Usage:
access
This command shows you the permission hierarchy and which permission groups you are a member of.
-
key
= 'access'¶
-
aliases
= ['groups', 'hierarchy']¶
-
locks
= 'cmd:all()'¶
-
arg_regex
= re.compile('$', re.IGNORECASE)¶
-
help_category
= 'general'¶
-
lock_storage
= 'cmd:all()'¶
-
search_index_entry
= {'aliases': 'groups hierarchy', 'category': 'general', 'key': 'access', 'no_prefix': ' groups hierarchy', 'tags': '', 'text': '\n show your current game access\n\n Usage:\n access\n\n This command shows you the permission hierarchy and\n which permission groups you are a member of.\n '}¶