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

Updated ReST docs.

Browse source
This commit is contained in:
Griatch 2013-12-02 16:43:44 +01:00
parent 3aeec1298a
commit 64a30c655d
29 changed files with 1391 additions and 1186 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/sphinx/source/wiki/Nicks.rst
View file

@ -78,8 +78,8 @@ Coding with nicks
Nicks are are stored as the ``Nick`` database model and are referred
from the normal Evennia `object <Objects.html>`_ through the ``nicks``
property. `` nicks`` is a special handler that offers effective error
checking, searches and conversion.
property - this is known as the NickHandler. The NickHandler offers
effective error checking, searches and conversion.
::
@ -87,16 +87,16 @@ checking, searches and conversion.
object.nicks.add("greetjack", "tell Jack = Hello pal!")
# An object nick:
object.nicks.add("rose", "The red flower", nick_type="object")
obj.nicks.add("rose", "The red flower", nick_type="object")
# An player nick:
object.nicks("tom", "Tommy Hill", nick_type="player")
obj.nicks.add("tom", "Tommy Hill", nick_type="player")
# My own custom nick type (handled by my own game code somehow):
object.nicks.add("hood", "The hooded man", nick_type="my_identsystem")
obj.nicks.add("hood", "The hooded man", nick_type="my_identsystem")
# get back the translated nick:
full_name = object.nicks.get("rose", nick_type="object")
full_name = obj.nicks.get("rose", nick_type="object")
# delete a previous set nick
object.nicks.del("rose", nick_type="object")