Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix a couple typos and improve consistency of builder command argument text (in help and doc strings)

Browse source
This commit is contained in:
BigJMoney 2017-06-06 14:49:49 -04:00
parent 62e74144f9
commit b7f6fe5bc1
1 changed files with 33 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

61
evennia/commands/default/building.py
View file

@ -184,7 +184,8 @@ class CmdCopy(ObjManipCommand):
copy an object and its properties copy an object and its properties
Usage: Usage:
@copy[/reset] <original obj> [= new_name][;alias;alias..][:new_location] [,new_name2 ...] @copy[/reset] <original obj> [= <new_name>][;alias;alias..][
:<new_location>] [,<new_name2> ...]
switch: switch:
reset - make a 'clean' copy off the object, thus reset - make a 'clean' copy off the object, thus
@ -205,7 +206,8 @@ class CmdCopy(ObjManipCommand):
caller = self.caller caller = self.caller
args = self.args args = self.args
if not args: if not args:
caller.msg("Usage: @copy <obj> [=new_name[;alias;alias..]][:new_location] [, new_name2...]") caller.msg("Usage: @copy <obj> [=<new_name>[;alias;alias..]]["
":<new_location>] [, <new_name2>...]")
return return
if not self.rhs: if not self.rhs:
@ -446,7 +448,7 @@ class CmdCreate(ObjManipCommand):
create new objects create new objects
Usage: Usage:
@create[/drop] objname[;alias;alias...][:typeclass], objname... @create[/drop] <objname>[;alias;alias...][:typeclass], <objname>...
switch: switch:
drop - automatically drop the new object into your current drop - automatically drop the new object into your current
@ -684,9 +686,9 @@ class CmdDig(ObjManipCommand):
build new rooms and connect them to the current location build new rooms and connect them to the current location
Usage: Usage:
@dig[/switches] roomname[;alias;alias...][:typeclass] @dig[/switches] <roomname>[;alias;alias...][:typeclass]
[= exit_to_there[;alias][:typeclass]] [= <exit_to_there>[;alias][:typeclass]]
[, exit_to_here[;alias][:typeclass]] [, <exit_to_here>[;alias][:typeclass]]
Switches: Switches:
tel or teleport - move yourself to the new room tel or teleport - move yourself to the new room
@ -718,9 +720,10 @@ class CmdDig(ObjManipCommand):
caller = self.caller caller = self.caller
if not self.lhs: if not self.lhs:
string = "Usage: @dig[/teleport] roomname[;alias;alias...][:parent] [= exit_there" string = "Usage: @dig[/teleport] <roomname>[;alias;alias...][" \
":parent] [= <exit_there>"
string += "[;alias;alias..][:parent]] " string += "[;alias;alias..][:parent]] "
string += "[, exit_back_here[;alias;alias..][:parent]]" string += "[, <exit_back_here>[;alias;alias..][:parent]]"
caller.msg(string) caller.msg(string)
return return
@ -823,7 +826,7 @@ class CmdTunnel(COMMAND_DEFAULT_CLASS):
create new rooms in cardinal directions only create new rooms in cardinal directions only
Usage: Usage:
@tunnel[/switch] <direction> [= roomname[;alias;alias;...][:typeclass]] @tunnel[/switch] <direction> [= <roomname>[;alias;alias;...][:typeclass]]
Switches: Switches:
oneway - do not create an exit back to the current location oneway - do not create an exit back to the current location
@ -868,7 +871,8 @@ class CmdTunnel(COMMAND_DEFAULT_CLASS):
"Implements the tunnel command" "Implements the tunnel command"
if not self.args or not self.lhs: if not self.args or not self.lhs:
string = "Usage: @tunnel[/switch] <direction> [= roomname[;alias;alias;...][:typeclass]]" string = "Usage: @tunnel[/switch] <direction> [= <roomname>[" \
";alias;alias;...][:typeclass]]"
self.caller.msg(string) self.caller.msg(string)
return return
if self.lhs not in self.directions: if self.lhs not in self.directions:
@ -1025,7 +1029,7 @@ class CmdSetHome(CmdLink):
set an object's home location set an object's home location
Usage: Usage:
@home <obj> [= home_location] @home <obj> [= <home_location>]
The "home" location is a "safety" location for objects; they The "home" location is a "safety" location for objects; they
will be moved there if their current location ceases to exist. All will be moved there if their current location ceases to exist. All
@ -1043,7 +1047,7 @@ class CmdSetHome(CmdLink):
def func(self): def func(self):
"implement the command" "implement the command"
if not self.args: if not self.args:
string = "Usage: @home <obj> [= home_location]" string = "Usage: @home <obj> [= <home_location>]"
self.caller.msg(string) self.caller.msg(string)
return return
@ -1077,7 +1081,7 @@ class CmdListCmdSets(COMMAND_DEFAULT_CLASS):
list command sets defined on an object list command sets defined on an object
Usage: Usage:
@cmdsets [obj] @cmdsets <obj>
This displays all cmdsets assigned This displays all cmdsets assigned
to a user. Defaults to yourself. to a user. Defaults to yourself.
@ -1106,7 +1110,7 @@ class CmdName(ObjManipCommand):
change the name and/or aliases of an object change the name and/or aliases of an object
Usage: Usage:
@name obj = name;alias1;alias2 @name <obj> = <newname>;alias1;alias2
Rename an object to something new. Use *obj to Rename an object to something new. Use *obj to
rename a player. rename a player.
@ -1323,7 +1327,7 @@ def _convert_from_string(cmd, strobj):
Python 2.6 and later: Python 2.6 and later:
Supports all Python structures through literal_eval as long as they Supports all Python structures through literal_eval as long as they
are valid Python syntax. If they are not (such as [test, test2], ie are valid Python syntax. If they are not (such as [test, test2], ie
withtout the quotes around the strings), the entire structure will without the quotes around the strings), the entire structure will
be converted to a string and a warning will be given. be converted to a string and a warning will be given.
We need to convert like this since all data being sent over the We need to convert like this since all data being sent over the
@ -1388,7 +1392,7 @@ class CmdSetAttribute(ObjManipCommand):
@set <obj>/<attr> = <value> @set <obj>/<attr> = <value>
@set <obj>/<attr> = @set <obj>/<attr> =
@set <obj>/<attr> @set <obj>/<attr>
@set *<player>/attr = <value> @set *<player>/<attr> = <value>
Switch: Switch:
edit: Open the line editor (string values only) edit: Open the line editor (string values only)
@ -1399,7 +1403,7 @@ class CmdSetAttribute(ObjManipCommand):
(if any). (if any).
The most common data to save with this command are strings and The most common data to save with this command are strings and
numbers. You can however also set Python primities such as lists, numbers. You can however also set Python primitives such as lists,
dictionaries and tuples on objects (this might be important for dictionaries and tuples on objects (this might be important for
the functionality of certain custom objects). This is indicated the functionality of certain custom objects). This is indicated
by you starting your value with one of |c'|n, |c"|n, |c(|n, |c[|n by you starting your value with one of |c'|n, |c"|n, |c(|n, |c[|n
@ -1558,7 +1562,7 @@ class CmdTypeclass(COMMAND_DEFAULT_CLASS):
set or change an object's typeclass set or change an object's typeclass
Usage: Usage:
@typclass[/switch] <object> [= <typeclass.path>] @typeclass[/switch] <object> [= typeclass_path]
@type '' @type ''
@parent '' @parent ''
@swap - this is a shorthand for using /force/reset flags. @swap - this is a shorthand for using /force/reset flags.
@ -1575,7 +1579,7 @@ class CmdTypeclass(COMMAND_DEFAULT_CLASS):
Example: Example:
@type button = examples.red_button.RedButton @type button = examples.red_button.RedButton
If the typeclass.path is not given, the current object's If the typeclass_path is not given, the current object's
typeclass is assumed. typeclass is assumed.
View or set an object's typeclass. If setting, the creation hooks View or set an object's typeclass. If setting, the creation hooks
@ -1604,7 +1608,7 @@ class CmdTypeclass(COMMAND_DEFAULT_CLASS):
caller = self.caller caller = self.caller
if not self.args: if not self.args:
caller.msg("Usage: %s <object> [=<typeclass]" % self.cmdstring) caller.msg("Usage: %s <object> [= typeclass]" % self.cmdstring)
return return
# get object to swap on # get object to swap on
@ -1675,7 +1679,7 @@ class CmdWipe(ObjManipCommand):
clear all attributes from an object clear all attributes from an object
Usage: Usage:
@wipe <object>[/attribute[/attribute...]] @wipe <object>[/<attr>[/<attr>...]]
Example: Example:
@wipe box @wipe box
@ -1696,7 +1700,7 @@ class CmdWipe(ObjManipCommand):
caller = self.caller caller = self.caller
if not self.args: if not self.args:
caller.msg("Usage: @wipe <object>[/attribute/attribute...]") caller.msg("Usage: @wipe <object>[/<attr>/<attr>...]")
return return
# get the attributes set by our custom parser # get the attributes set by our custom parser
@ -1728,7 +1732,7 @@ class CmdLock(ObjManipCommand):
Usage: Usage:
@lock <object>[ = <lockstring>] @lock <object>[ = <lockstring>]
or or
@lock[/switch] object/<access_type> @lock[/switch] <object>/<access_type>
Switch: Switch:
del - delete given access type del - delete given access type
@ -1748,7 +1752,7 @@ class CmdLock(ObjManipCommand):
an object locked with this string will only be possible to an object locked with this string will only be possible to
pick up by Wizards or by object with id 25. pick up by Wizards or by object with id 25.
You can add several access_types after oneanother by separating You can add several access_types after one another by separating
them by ';', i.e: them by ';', i.e:
'get:id(25);delete:perm(Builders)' 'get:id(25);delete:perm(Builders)'
""" """
@ -1762,7 +1766,8 @@ class CmdLock(ObjManipCommand):
caller = self.caller caller = self.caller
if not self.args: if not self.args:
string = "@lock <object>[ = <lockstring>] or @lock[/switch] object/<access_type>" string = "@lock <object>[ = <lockstring>] or @lock[/switch] " \
"<object>/<access_type>"
caller.msg(string) caller.msg(string)
return return
@ -2335,7 +2340,7 @@ class CmdScript(COMMAND_DEFAULT_CLASS):
attach a script to an object attach a script to an object
Usage: Usage:
@script[/switch] <obj> [= <script.path or scriptkey>] @script[/switch] <obj> [= script_path or <scriptkey>]
Switches: Switches:
start - start all non-running scripts on object, or a given script only start - start all non-running scripts on object, or a given script only
@ -2361,7 +2366,7 @@ class CmdScript(COMMAND_DEFAULT_CLASS):
caller = self.caller caller = self.caller
if not self.args: if not self.args:
string = "Usage: @script[/switch] <obj> [= <script.path or script key>]" string = "Usage: @script[/switch] <obj> [= script_path or <script key>]"
caller.msg(string) caller.msg(string)
return return
@ -2562,7 +2567,7 @@ class CmdSpawn(COMMAND_DEFAULT_CLASS):
Usage: Usage:
@spawn @spawn
@spawn[/switch] prototype_name @spawn[/switch] <prototype_name>
@spawn[/switch] {prototype dictionary} @spawn[/switch] {prototype dictionary}
Switch: Switch: