mud
index
(built-in)

The mud module, for all MUD misc mud utils.

 
Functions
       
erase_global(...)
erase_global(name)
 
Delete a value from the global variable table.
expand_text(...)
expand_text(text, dict={}, newline=False)
 
Take text with embedded Python statements. Statements can be embedded
between [ and ]. Expand them out and return the new text. Variables can
be added to the scripting environment by specifying their names and
values in an optional dictionary. Statements are expanded in the default
scripting environment.
extract(...)
extract(thing)
 
Extracts an object, character, or room from the game.
format_string(...)
format_string(text, indent=True, width=80)
 
Format a block of text to be of the specified width, possibly indenting
paragraphs.
generic_find(...)
Deprecated. Use mud.parse_args instead.
get_global(...)
get_global(name)
 
Return a non-persistent global variable, or None.
get_greeting(...)
get_greeting()
 
returns the mud's connection greeting.
get_hour(...)
get_hour()
 
Return the current in-game hour of day.
get_motd(...)
get_motd()
 
Returns the mud's message of the day.
get_time(...)
get_time()
 
Return time of day (morning, afternoon, evening, night).
is_afternoon(...)
True or False if it is afternoon.
is_evening(...)
True or False if it is evening.
is_morning(...)
True or False if it is morning.
is_night(...)
True or False if it is night.
is_race(...)
is_race(name)
 
Returns True or False if the string is a valid race name.
ite(...)
ite(logic_statement, if_statement, else_statement=None)
 
A functional form of if/then/else.
keys_equal(...)
keys_equal(key1, key2)
 
Returns whether two world database keys are equal, relative to the
locale (if any) that the current script is running in.
list_races(...)
list_races(player_only=False)
 
Return a list of available races. If player_only is True, list only the
races that players have access to.
log_string(...)
log_string(mssg)
Send a message to the mud's log.
message(...)
message(ch, vict, obj, vobj, show_invis, range, mssg)
 
Send a message via the mud messaging system using $ expansions. Range
can be 'to_room', 'to_char', 'to_vict', or 'to_world'.
parse_args(...)
parse_args(ch, show_usage_errors, cmd, args, format)
 
equivalent to parse_args written in C. See parse.h for information.
send(...)
send(list, mssg, dict = None, newline = True)
 
Sends a message to a list of characters. Messages can have scripts
embedded in them, using [ and ]. If so, a variable dictionary must be
provided. By default, 'ch' references each character being sent the
message, for embedded scripts.
set_global(...)
set_global(name, val)
 
Sets a non-persistent global variable. Val can be any type.