mirror of
https://github.com/evennia/evennia.git
synced 2026-03-17 05:16:31 +01:00
166 lines
8.4 KiB
Python
166 lines
8.4 KiB
Python
"""
|
|
These are the base object typeclasses, a convenient shortcut to the
|
|
objects in src/objects/objects.py. You can start building your game
|
|
from these bases if you want.
|
|
|
|
To change these defaults to point to some other object,
|
|
change some or all of these variables in settings.py:
|
|
BASE_OBJECT_TYPECLASS
|
|
BASE_CHARACTER_TYPECLASS
|
|
BASE_ROOM_TYPECLASS
|
|
BASE_EXIT_TYPECLASS
|
|
BASE_PLAYER_TYPECLASS
|
|
|
|
Some of the main uses for these settings are not hard-coded in
|
|
Evennia, rather they are convenient defaults for in-game commands
|
|
(which you may change) Example would be build commands like '@dig'
|
|
knowing to create a particular room-type object).
|
|
|
|
New instances of Objects (inheriting from these typeclasses)
|
|
are created with src.utils.create.create_object(typeclass, ...)
|
|
where typeclass is the python path to the class you want to use.
|
|
"""
|
|
from src.objects.objects import Object as BaseObject
|
|
from src.objects.objects import Character as BaseCharacter
|
|
from src.objects.objects import Room as BaseRoom
|
|
from src.objects.objects import Exit as BaseExit
|
|
from src.players.player import Player as BasePlayer
|
|
|
|
class Object(BaseObject):
|
|
"""
|
|
This is the root typeclass object, implementing an in-game Evennia
|
|
game object, such as having a location, being able to be
|
|
manipulated or looked at, etc. If you create a new typeclass, it
|
|
must always inherit from this object (or any of the other objects
|
|
in this file, since they all actually inherit from BaseObject, as
|
|
seen in src.object.objects).
|
|
|
|
The BaseObject class implements several hooks tying into the game
|
|
engine. By re-implementing these hooks you can control the
|
|
system. You should never need to re-implement special Python
|
|
methods, such as __init__ and especially never __getattribute__ and
|
|
__setattr__ since these are used heavily by the typeclass system
|
|
of Evennia and messing with them might well break things for you.
|
|
|
|
Hooks (these are class methods, so their arguments should also start with self):
|
|
|
|
at_object_creation() - only called once, when object is first created.
|
|
Almost all object customizations go here.
|
|
at_first_login() - only called once, the very first time user logs in.
|
|
at_pre_login() - called every time the user connects, after they have
|
|
identified, just before the system actually logs them in.
|
|
at_post_login() - called at the end of login, just before setting the
|
|
player loose in the world.
|
|
at_disconnect() - called just before the use is disconnected (this is also
|
|
called if the system determines the player lost their link)
|
|
at_object_delete() - called just before the database object is permanently
|
|
deleted from the database with obj.delete(). Note that cleaning out contents
|
|
and deleting connected exits is not needed, this is handled
|
|
automatically when doing obj.delete(). If this method returns
|
|
False, deletion is aborted.
|
|
|
|
at_before_move(destination) - called by obj.move_to() just before moving object to the destination.
|
|
If this method returns False, move is cancelled.
|
|
announce_move_from(destination) - called while still standing in the old location,
|
|
if obj.move_to() has argument quiet=False.
|
|
announce_move_to(source_location) - called after move, while standing in the new location
|
|
if obj.move_to() has argument quiet=False.
|
|
at_after_move(source_location) - always called after a move has been performed.
|
|
|
|
at_object_leave(obj, target_location) - called when this object loose an object (e.g.
|
|
someone leaving the room, an object is given away etc)
|
|
at_object_receive(obj, source_location) - called when this object receives another object
|
|
(e.g. a room being entered, an object moved into inventory)
|
|
|
|
|
|
|
|
|
|
return_appearance(looker) - by default, this is used by the 'look' command to
|
|
request this object to describe itself. Looker
|
|
is the object requesting to get the information.
|
|
at_desc(looker=None) - by default called whenever the appearance is requested.
|
|
|
|
at_msg_receive(self, msg, from_obj=None, data=None) - called whenever someone sends a message to this object.
|
|
message aborted if hook returns False.
|
|
at_msg_send(self, msg, to_obj=None, data=None) - called when this objects sends a message. This can only be
|
|
called if from_obj is specified in the call to msg().
|
|
at_object_delete() - calleed when this object is to be deleted. If returns False, deletion is aborted.
|
|
|
|
at_get(getter) - called after object has been picked up. Does not stop pickup.
|
|
at_drop(dropper) - called when this object has been dropped.
|
|
at_say(speaker, message) - by default, called if an object inside this object speaks
|
|
|
|
at_server_reload() - called when server is reloading
|
|
at_server_shutdown() - called when server is resetting/shutting down
|
|
"""
|
|
pass
|
|
|
|
|
|
class Character(BaseCharacter):
|
|
"""
|
|
This is the default object created for a new user connecting - the
|
|
in-game player character representation. The basetype_setup always
|
|
assigns the default_cmdset as a fallback to objects of this type.
|
|
The default hooks also hide the character object away (by moving
|
|
it to a Null location whenever the player logs off (otherwise the
|
|
character would remain in the world, "headless" so to say).
|
|
"""
|
|
pass
|
|
|
|
class Room(BaseRoom):
|
|
"""
|
|
Rooms are like any object, except their location is None
|
|
(which is default). Usually this object should be
|
|
assigned to room-building commands by use of the
|
|
settings.BASE_ROOM_TYPECLASS variable.
|
|
"""
|
|
pass
|
|
|
|
class Exit(BaseExit):
|
|
"""
|
|
Exits are connectors between rooms. Exits defines the
|
|
'destination' property and sets up a command on itself with the
|
|
same name as the Exit object - this command allows the player to
|
|
traverse the exit to the destination just by writing the name of
|
|
the object on the command line.
|
|
|
|
Relevant hooks:
|
|
at_before_traverse(traveller) - called just before traversing
|
|
at_after_traverse(traveller, source_loc) - called just after traversing
|
|
at_failed_traverse(traveller) - called if traversal failed for some reason. Will
|
|
not be called if the attribute 'err_traverse' is
|
|
defined, in which case that will simply be echoed.
|
|
"""
|
|
pass
|
|
|
|
class Player(BasePlayer):
|
|
"""
|
|
This class describes the actual OOC player (i.e. the user connecting
|
|
to the MUD). It does NOT have visual appearance in the game world (that
|
|
|
|
is handled by the character which is connected to this). Comm channels
|
|
are attended/joined using this object.
|
|
|
|
It can be useful e.g. for storing configuration options for your game, but
|
|
should generally not hold any character-related info (that's best handled
|
|
on the character level).
|
|
|
|
Can be set using BASE_PLAYER_TYPECLASS.
|
|
|
|
The following hooks are called by the engine. Note that all of the following
|
|
are called on the character object too, and mostly at the same time.
|
|
|
|
at_player_creation() - This is called once, the very first time
|
|
the player is created (i.e. first time they
|
|
register with the game). It's a good place
|
|
to store attributes all players should have,
|
|
like configuration values etc.
|
|
at_pre_login() - called every time the user connects, after they have
|
|
identified, just before the system actually logs them in.
|
|
at_post_login() - called at the end of login, just before setting the
|
|
player loose in the world.
|
|
at_disconnect() - called just before the use is disconnected (this is also
|
|
called if the system determines the player lost their link)
|
|
|
|
"""
|
|
pass
|