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

Cleanup of API documentation.

Browse source
This commit is contained in:
Griatch 2012-05-02 00:39:56 +02:00
parent fce5c79561
commit 7058b9f210
2 changed files with 42 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

18
src/objects/objects.py
View file

@ -31,17 +31,21 @@ class Object(TypeClass):
# __init__ is only defined here in order to present docstring to API. # __init__ is only defined here in order to present docstring to API.
def __init__(self, dbobj): def __init__(self, dbobj):
""" """
This is the root typeclass object, implementing an in-game Evennia This is the root typeclass object representing all entities
game object, such as having a location, being able to be that has and actual presence in-game. Objects generally has a
manipulated or looked at, etc. If you create a new typeclass, it location, can be manipulated and looked at. Most game entities
must always inherit from this object (or any of the other objects you define should inherit from Object at some distance.
in this file, since they all actually inherit from BaseObject, as Important subclasses of Object are that Evennia defines by
seen in src.object.objects). default for you are Characters, Exits and Rooms.
Note that all Objects and its subclasses *must* always be
created using the ev.create_object() function. This is so the
typeclass system can be correctly initiated behind the scenes.
Object Typeclass API: Object Typeclass API:
* Available properties (only available on initiated typeclass objects) * Available properties (only available on *initiated* typeclass objects)
key (string) - name of object key (string) - name of object
name (string)- same as key name (string)- same as key