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

Updated all of players/ directory to Google style docstrings as per #709.

Browse source
This commit is contained in:
Griatch 2015-06-21 13:51:32 +02:00
parent 8ac424c216
commit da9c97b699
6 changed files with 334 additions and 205 deletions
Download patch file Download diff file Expand all files Collapse all files

45
evennia/objects/models.py
View file

@ -120,31 +120,32 @@ class ObjectDB(TypedObject):
type class with new database-stored variables. type class with new database-stored variables.
The TypedObject supplies the following (inherited) properties: The TypedObject supplies the following (inherited) properties:
key - main name
name - alias for key - key - main name
typeclass_path - the path to the decorating typeclass - name - alias for key
typeclass - auto-linked typeclass - db_typeclass_path - the path to the decorating typeclass
date_created - time stamp of object creation - db_date_created - time stamp of object creation
permissions - perm strings - permissions - perm strings
locks - lock definitions (handler) - locks - lock definitions (handler)
dbref - #id of object - dbref - #id of object
db - persistent attribute storage - db - persistent attribute storage
ndb - non-persistent attribute storage - ndb - non-persistent attribute storage
The ObjectDB adds the following properties: The ObjectDB adds the following properties:
player - optional connected player (always together with sessid)
sessid - optional connection session id (always together with player)
location - in-game location of object
home - safety location for object (handler)
scripts - scripts assigned to object (handler from typeclass) - player - optional connected player (always together with sessid)
cmdset - active cmdset on object (handler from typeclass) - sessid - optional connection session id (always together with player)
aliases - aliases for this object (property) - location - in-game location of object
nicks - nicknames for *other* things in Evennia (handler) - home - safety location for object (handler)
sessions - sessions connected to this object (see also player) - scripts - scripts assigned to object (handler from typeclass)
has_player - bool if an active player is currently connected - cmdset - active cmdset on object (handler from typeclass)
contents - other objects having this object as location - aliases - aliases for this object (property)
exits - exits from this object - nicks - nicknames for *other* things in Evennia (handler)
- sessions - sessions connected to this object (see also player)
- has_player - bool if an active player is currently connected
- contents - other objects having this object as location
- exits - exits from this object
""" """
# #
# ObjectDB Database model setup # ObjectDB Database model setup

3
evennia/players/admin.py
View file

@ -71,6 +71,9 @@ class PlayerDBCreationForm(UserCreationForm):
"@/./+/-/_ only.") "@/./+/-/_ only.")
def clean_username(self): def clean_username(self):
"""
Cleanup username.
"""
username = self.cleaned_data['username'] username = self.cleaned_data['username']
if PlayerDB.objects.filter(username__iexact=username): if PlayerDB.objects.filter(username__iexact=username):
raise forms.ValidationError('A player with that name already ' raise forms.ValidationError('A player with that name already '

4
evennia/players/bots.py
View file

@ -26,6 +26,10 @@ class BotStarter(DefaultScript):
""" """
def at_script_creation(self): def at_script_creation(self):
"""
Called once, when script is created.
"""
self.key = "botstarter" self.key = "botstarter"
self.desc = "bot start/keepalive" self.desc = "bot start/keepalive"
self.persistent = True self.persistent = True

100
evennia/players/manager.py
View file

@ -43,22 +43,37 @@ class PlayerDBManager(TypedObjectManager, UserManager):
""" """
def num_total_players(self): def num_total_players(self):
""" """
Returns the total number of registered players. Get total number of players.
Returns:
count (int): The total number of registered players.
""" """
return self.count() return self.count()
@returns_typeclass_list @returns_typeclass_list
def get_connected_players(self): def get_connected_players(self):
""" """
Returns a list of player objects with currently connected users/players. Get all currently connected players.
Returns:
count (list): Player objects with currently
connected sessions.
""" """
return self.filter(db_is_connected=True) return self.filter(db_is_connected=True)
@returns_typeclass_list @returns_typeclass_list
def get_recently_created_players(self, days=7): def get_recently_created_players(self, days=7):
""" """
Returns a QuerySet containing the player User accounts that have been Get players recently created.
connected within the last <days> days.
Args:
days (int, optional): How many days in the past "recently" means.
Returns:
players (list): The Players created the last `days` interval.
""" """
end_date = timezone.now() end_date = timezone.now()
tdelta = datetime.timedelta(days) tdelta = datetime.timedelta(days)
@ -68,10 +83,15 @@ class PlayerDBManager(TypedObjectManager, UserManager):
@returns_typeclass_list @returns_typeclass_list
def get_recently_connected_players(self, days=7): def get_recently_connected_players(self, days=7):
""" """
Returns a QuerySet containing the player accounts that have been Get players recently connected to the game.
connected within the last <days> days.
Args:
days (int, optional): Number of days backwards to check
Returns:
players (list): The Players connected to the game in the
last `days` interval.
days - number of days backwards to check
""" """
end_date = timezone.now() end_date = timezone.now()
tdelta = datetime.timedelta(days) tdelta = datetime.timedelta(days)
@ -82,14 +102,29 @@ class PlayerDBManager(TypedObjectManager, UserManager):
@returns_typeclass @returns_typeclass
def get_player_from_email(self, uemail): def get_player_from_email(self, uemail):
""" """
Returns a player object when given an email address. Search player by
Returns a player object based on email address.
Args:
uemail (str): An email address to search for.
Returns:
player (Player): A found player, if found.
""" """
return self.filter(email__iexact=uemail) return self.filter(email__iexact=uemail)
@returns_typeclass @returns_typeclass
def get_player_from_uid(self, uid): def get_player_from_uid(self, uid):
""" """
Returns a player object based on User id. Get a player by id.
Args:
uid (int): Player database id.
Returns:
player (Player): The result.
""" """
try: try:
return self.get(id=uid) return self.get(id=uid)
@ -98,7 +133,16 @@ class PlayerDBManager(TypedObjectManager, UserManager):
@returns_typeclass @returns_typeclass
def get_player_from_name(self, uname): def get_player_from_name(self, uname):
"Get player object based on name" """
Get player object based on name.
Args:
uname (str): The Player name to search for.
Returns:
player (Player): The found player.
"""
try: try:
return self.get(username__iexact=uname) return self.get(username__iexact=uname)
except self.model.DoesNotExist: except self.model.DoesNotExist:
@ -110,8 +154,13 @@ class PlayerDBManager(TypedObjectManager, UserManager):
Searches for a particular player by name or Searches for a particular player by name or
database id. database id.
ostring - a string or database id. Args:
exact - allow for a partial match ostring (str or int): A key string or database id.
exact (bool, optional): Only valid for string matches. If
`True`, requires exact (non-case-sensitive) match,
otherwise also match also keys containing the `ostring`
(non-case-sensitive fuzzy match).
""" """
dbref = self.dbref(ostring) dbref = self.dbref(ostring)
if dbref or dbref == 0: if dbref or dbref == 0:
@ -124,33 +173,6 @@ class PlayerDBManager(TypedObjectManager, UserManager):
else: else:
return self.filter(username__icontains=ostring) return self.filter(username__icontains=ostring)
# def swap_character(self, player, new_character, delete_old_character=False):
# """
# This disconnects a player from the current character (if any) and
# connects to a new character object.
#
# """
#
# if new_character.player:
# # the new character is already linked to a player!
# return False
#
# # do the swap
# old_character = player.character
# if old_character:
# old_character.player = None
# try:
# player.character = new_character
# new_character.player = player
# except Exception:
# # recover old setup
# if old_character:
# old_character.player = player
# player.character = old_character
# return False
# if old_character and delete_old_character:
# old_character.delete()
# return True
class PlayerManager(PlayerDBManager, TypeclassManager): class PlayerManager(PlayerDBManager, TypeclassManager):
pass pass

36
evennia/players/models.py
View file

@ -55,21 +55,23 @@ class PlayerDB(TypedObject, AbstractUser):
our liking. our liking.
The TypedObject supplies the following (inherited) properties: The TypedObject supplies the following (inherited) properties:
key - main name
typeclass_path - the path to the decorating typeclass - key - main name
typeclass - auto-linked typeclass - typeclass_path - the path to the decorating typeclass
date_created - time stamp of object creation - typeclass - auto-linked typeclass
permissions - perm strings - date_created - time stamp of object creation
dbref - #id of object - permissions - perm strings
db - persistent attribute storage - dbref - #id of object
ndb - non-persistent attribute storage - db - persistent attribute storage
- ndb - non-persistent attribute storage
The PlayerDB adds the following properties: The PlayerDB adds the following properties:
user - Connected User object. django field, needs to be save():d.
name - alias for user.username - is_connected - If any Session is currently connected to this Player
sessions - sessions connected to this player - name - alias for user.username
is_superuser - bool if this player is a superuser - sessions - sessions connected to this player
is_bot - bool if this player is a bot and not a real player - is_superuser - bool if this player is a superuser
- is_bot - bool if this player is a bot and not a real player
""" """
@ -115,7 +117,7 @@ class PlayerDB(TypedObject, AbstractUser):
# cmdset_storage property # cmdset_storage property
# This seems very sensitive to caching, so leaving it be for now /Griatch # This seems very sensitive to caching, so leaving it be for now /Griatch
#@property #@property
def cmdset_storage_get(self): def __cmdset_storage_get(self):
""" """
Getter. Allows for value = self.name. Returns a list of cmdset_storage. Getter. Allows for value = self.name. Returns a list of cmdset_storage.
""" """
@ -124,7 +126,7 @@ class PlayerDB(TypedObject, AbstractUser):
return [path.strip() for path in storage.split(',')] if storage else [] return [path.strip() for path in storage.split(',')] if storage else []
#@cmdset_storage.setter #@cmdset_storage.setter
def cmdset_storage_set(self, value): def __cmdset_storage_set(self, value):
""" """
Setter. Allows for self.name = value. Stores as a comma-separated Setter. Allows for self.name = value. Stores as a comma-separated
string. string.
@ -133,11 +135,11 @@ class PlayerDB(TypedObject, AbstractUser):
_GA(self, "save")() _GA(self, "save")()
#@cmdset_storage.deleter #@cmdset_storage.deleter
def cmdset_storage_del(self): def __cmdset_storage_del(self):
"Deleter. Allows for del self.name" "Deleter. Allows for del self.name"
_SA(self, "db_cmdset_storage", None) _SA(self, "db_cmdset_storage", None)
_GA(self, "save")() _GA(self, "save")()
cmdset_storage = property(cmdset_storage_get, cmdset_storage_set, cmdset_storage_del) cmdset_storage = property(__cmdset_storage_get, __cmdset_storage_set, __cmdset_storage_del)
# #
# property/field access # property/field access

351
evennia/players/players.py
View file

@ -49,62 +49,60 @@ class DefaultPlayer(PlayerDB):
* Available properties (only available on initiated typeclass objects) * Available properties (only available on initiated typeclass objects)
key (string) - name of player - key (string) - name of player
name (string)- wrapper for user.username - name (string)- wrapper for user.username
aliases (list of strings) - aliases to the object. Will be saved to - aliases (list of strings) - aliases to the object. Will be saved to
database as AliasDB entries but returned as strings. database as AliasDB entries but returned as strings.
dbref (int, read-only) - unique #id-number. Also "id" can be used. - dbref (int, read-only) - unique #id-number. Also "id" can be used.
date_created (string) - time stamp of object creation - date_created (string) - time stamp of object creation
permissions (list of strings) - list of permission strings - permissions (list of strings) - list of permission strings
- user (User, read-only) - django User authorization object
user (User, read-only) - django User authorization object - obj (Object) - game object controlled by player. 'character' can also
obj (Object) - game object controlled by player. 'character' can also be used.
be used. - sessions (list of Sessions) - sessions connected to this player
sessions (list of Sessions) - sessions connected to this player - is_superuser (bool, read-only) - if the connected user is a superuser
is_superuser (bool, read-only) - if the connected user is a superuser
* Handlers * Handlers
locks - lock-handler: use locks.add() to add new lock strings - locks - lock-handler: use locks.add() to add new lock strings
db - attribute-handler: store/retrieve database attributes on this - db - attribute-handler: store/retrieve database attributes on this
self.db.myattr=val, val=self.db.myattr self.db.myattr=val, val=self.db.myattr
ndb - non-persistent attribute handler: same as db but does not - ndb - non-persistent attribute handler: same as db but does not
create a database entry when storing data create a database entry when storing data
scripts - script-handler. Add new scripts to object with scripts.add() - scripts - script-handler. Add new scripts to object with scripts.add()
cmdset - cmdset-handler. Use cmdset.add() to add new cmdsets to object - cmdset - cmdset-handler. Use cmdset.add() to add new cmdsets to object
nicks - nick-handler. New nicks with nicks.add(). - nicks - nick-handler. New nicks with nicks.add().
* Helper methods * Helper methods
msg(outgoing_string, from_obj=None, **kwargs) - msg(outgoing_string, from_obj=None, **kwargs)
#swap_character(new_character, delete_old_character=False) - execute_cmd(raw_string)
execute_cmd(raw_string) - search(ostring, global_search=False, attribute_name=None,
search(ostring, global_search=False, attribute_name=None, use_nicks=False, location=None,
use_nicks=False, location=None, ignore_errors=False, player=False)
ignore_errors=False, player=False) - is_typeclass(typeclass, exact=False)
is_typeclass(typeclass, exact=False) - swap_typeclass(new_typeclass, clean_attributes=False, no_default=True)
swap_typeclass(new_typeclass, clean_attributes=False, no_default=True) - access(accessing_obj, access_type='read', default=False, no_superuser_bypass=False)
access(accessing_obj, access_type='read', default=False, no_superuser_bypass=False) - check_permstring(permstring)
check_permstring(permstring)
* Hook methods * Hook methods
basetype_setup() basetype_setup()
at_player_creation() at_player_creation()
- note that the following hooks are also found on Objects and are > note that the following hooks are also found on Objects and are
usually handled on the character level: usually handled on the character level:
at_init() - at_init()
at_access() - at_access()
at_cmdset_get(**kwargs) - at_cmdset_get(**kwargs)
at_first_login() - at_first_login()
at_post_login(sessid=None) - at_post_login(sessid=None)
at_disconnect() - at_disconnect()
at_message_receive() - at_message_receive()
at_message_send() - at_message_send()
at_server_reload() - at_server_reload()
at_server_shutdown() - at_server_shutdown()
""" """
@ -130,8 +128,16 @@ class DefaultPlayer(PlayerDB):
def get_session(self, sessid): def get_session(self, sessid):
""" """
Return session with given sessid connected to this player. Retrieve given session.
note that the sessionhandler also accepts sessid as an iterable.
Args:
sessid (int or list): A session id or list of such to retrieve.
Returns:
session (Session or list): One or more Sessions matching
the given `sessid`s while also being connected to this
Player.
""" """
global _SESSIONS global _SESSIONS
if not _SESSIONS: if not _SESSIONS:
@ -139,7 +145,14 @@ class DefaultPlayer(PlayerDB):
return _SESSIONS.session_from_player(self, sessid) return _SESSIONS.session_from_player(self, sessid)
def get_all_sessions(self): def get_all_sessions(self):
"Return all sessions connected to this player" """
Get all sessions connected to this player.
Returns:
sessions (list): All Sessions currently connected to this
player.
"""
global _SESSIONS global _SESSIONS
if not _SESSIONS: if not _SESSIONS:
from evennia.server.sessionhandler import SESSIONS as _SESSIONS from evennia.server.sessionhandler import SESSIONS as _SESSIONS
@ -148,8 +161,13 @@ class DefaultPlayer(PlayerDB):
def disconnect_session_from_player(self, sessid): def disconnect_session_from_player(self, sessid):
""" """
Access method for disconnecting a given session from the player Access method for disconnecting a given session from the
(connection happens automatically in the sessionhandler) player (connection happens automatically in the
sessionhandler)
Args:
sessid (int): Session id to disconnect.
""" """
# this should only be one value, loop just to make sure to # this should only be one value, loop just to make sure to
# clean everything # clean everything
@ -171,9 +189,10 @@ class DefaultPlayer(PlayerDB):
obj (Object): the object to start puppeting obj (Object): the object to start puppeting
Raises: Raises:
RuntimeError with message if puppeting is not possible RuntimeError: If puppeting is not possible, the
`exception.msg` will contain the reason.
returns True if successful, False otherwise
""" """
# safety checks # safety checks
if not obj: if not obj:
@ -231,13 +250,14 @@ class DefaultPlayer(PlayerDB):
def unpuppet_object(self, sessid): def unpuppet_object(self, sessid):
""" """
Disengage control over an object Disengage control over an object.
Args: Args:
sessid(int): the session id to disengage sessid(int): The session id to disengage.
Raises: Raises:
RuntimeError with message about error. RuntimeError With message about error.
""" """
if _MULTISESSION_MODE == 1: if _MULTISESSION_MODE == 1:
sessions = self.get_all_sessions() sessions = self.get_all_sessions()
@ -262,41 +282,49 @@ class DefaultPlayer(PlayerDB):
def unpuppet_all(self): def unpuppet_all(self):
""" """
Disconnect all puppets. This is called by server Disconnect all puppets. This is called by server before a
before a reset/shutdown. reset/shutdown.
""" """
for session in (sess for sess in self.get_all_sessions() if sess.puppet): for session in (sess for sess in self.get_all_sessions() if sess.puppet):
self.unpuppet_object(session.sessid) self.unpuppet_object(session.sessid)
def get_puppet(self, sessid, return_dbobj=False): def get_puppet(self, sessid):
""" """
Get an object puppeted by this session through this player. This is Get an object puppeted by this session through this player. This is
the main method for retrieving the puppeted object from the the main method for retrieving the puppeted object from the
player's end. player's end.
sessid - return character connected to this sessid, Args:
sessid (int): Find puppeted object based on this sessid.
Returns:
puppet (Object): The matching puppeted object, if any.
""" """
session = self.get_session(sessid) session = self.get_session(sessid)
if not session: return session.puppet if session and session.puppet else None
return None
if return_dbobj:
return session.puppet
return session.puppet and session.puppet or None
def get_all_puppets(self): def get_all_puppets(self):
""" """
Get all currently puppeted objects as a list. Get all currently puppeted objects.
Returns:
puppets (list): All puppeted objects currently controlled
by this Player.
""" """
return list(set(session.puppet for session in self.get_all_sessions() return list(set(session.puppet for session in self.get_all_sessions()
if session.puppet)) if session.puppet))
def __get_single_puppet(self): def __get_single_puppet(self):
""" """
This is a legacy convenience link for users of This is a legacy convenience link for use with `MULTISESSION_MODE`.
MULTISESSION_MODE 0 or 1. It will return
only the first puppet. For mode 2, this returns Returns:
a list of all characters. puppets (Object or list): Users of `MULTISESSION_MODE` 0 or 1 will
always get the first puppet back. Users of higher `MULTISESSION_MODE`s will
get a list of all puppeted objects.
""" """
puppets = self.get_all_puppets() puppets = self.get_all_puppets()
if _MULTISESSION_MODE in (0, 1): if _MULTISESSION_MODE in (0, 1):
@ -310,6 +338,11 @@ class DefaultPlayer(PlayerDB):
def delete(self, *args, **kwargs): def delete(self, *args, **kwargs):
""" """
Deletes the player permanently. Deletes the player permanently.
Notes:
`*args` and `**kwargs` are passed on to the base delete
mechanism (these are usually not used).
""" """
for session in self.get_all_sessions(): for session in self.get_all_sessions():
# unpuppeting all objects and disconnecting the user, if any # unpuppeting all objects and disconnecting the user, if any
@ -342,6 +375,7 @@ class DefaultPlayer(PlayerDB):
send. If given, overrules MULTISESSION_MODE. send. If given, overrules MULTISESSION_MODE.
Notes: Notes:
All other keywords are passed on to the protocol. All other keywords are passed on to the protocol.
""" """
text = to_str(text, force_string=True) if text else "" text = to_str(text, force_string=True) if text else ""
if from_obj: if from_obj:
@ -375,12 +409,18 @@ class DefaultPlayer(PlayerDB):
command. It takes player nicks into account, but not nicks of command. It takes player nicks into account, but not nicks of
eventual puppets. eventual puppets.
raw_string - raw command input coming from the command line. Args:
sessid - the optional session id to be responsible for the command-send raw_string (str): Raw command input coming from the command line.
**kwargs - other keyword arguments will be added to the found command sessid (int, optional): The optional session id to be
object instace as variables before it executes. This is responsible for the command-send
unused by default Evennia but may be used to set flags and
change operating paramaters for commands at run-time. Kwargs:
kwargs (any): Other keyword arguments will be added to the
found command object instance as variables before it
executes. This is unused by default Evennia but may be
used to set flags and change operating paramaters for
commands at run-time.
""" """
raw_string = to_unicode(raw_string) raw_string = to_unicode(raw_string)
raw_string = self.nicks.nickreplace(raw_string, raw_string = self.nicks.nickreplace(raw_string,
@ -400,18 +440,26 @@ class DefaultPlayer(PlayerDB):
def search(self, searchdata, return_puppet=False, def search(self, searchdata, return_puppet=False,
nofound_string=None, multimatch_string=None, **kwargs): nofound_string=None, multimatch_string=None, **kwargs):
""" """
This is similar to the ObjectDB search method but will search for This is similar to `DefaultObject.search` but will search for
Players only. Errors will be echoed, and None returned if no Player Players only.
is found.
searchdata - search criterion, the Player's key or dbref to search for Args:
return_puppet - will try to return the object the player controls searchdata (str or int): Search criterion, the Player's
instead of the Player object itself. If no key or dbref to search for.
puppeted object exists (since Player is OOC), None will return_puppet (bool, optional): Instructs the method to
be returned. return matches as the object the Player controls rather
nofound_string - optional custom string for not-found error message. than the Player itself (or None) if nothing is puppeted).
multimatch_string - optional custom string for multimatch error header. nofound_string (str, optional): A one-time error message
Extra keywords are ignored, but are allowed in call in order to make to echo if `searchdata` leads to no matches. If not given,
API more consistent with objects.models.TypedObject.search. will fall back to the default handler.
multimatch_string (str, optional): A one-time error
message to echo if `searchdata` leads to multiple matches.
If not given, will fall back to the default handler.
Notes:
Extra keywords are ignored, but are allowed in call in
order to make API more consistent with
objects.models.TypedObject.search.
""" """
# handle me, self and *me, *self # handle me, self and *me, *self
if isinstance(searchdata, basestring): if isinstance(searchdata, basestring):
@ -431,18 +479,19 @@ class DefaultPlayer(PlayerDB):
def access(self, accessing_obj, access_type='read', default=False, no_superuser_bypass=False, **kwargs): def access(self, accessing_obj, access_type='read', default=False, no_superuser_bypass=False, **kwargs):
""" """
Determines if another object has permission to access this object Determines if another object has permission to access this
in whatever way. object in whatever way.
Args: Args:
accessing_obj (Object): Object trying to access this one accessing_obj (Object): Object trying to access this one.
access_type (str, optional): Type of access sought access_type (str, optional): Type of access sought.
default (bool, optional): What to return if no lock of access_type was found default (bool, optional): What to return if no lock of
access_type was found
no_superuser_bypass (bool, optional): Turn off superuser no_superuser_bypass (bool, optional): Turn off superuser
lock bypassing. Be careful with this one. lock bypassing. Be careful with this one.
Kwargs: Kwargs:
Passed to the at_access hook along with the result. kwargs (any): Passed to the at_access hook along with the result.
Returns: Returns:
result (bool): Result of access check. result (bool): Result of access check.
@ -457,13 +506,13 @@ class DefaultPlayer(PlayerDB):
def basetype_setup(self): def basetype_setup(self):
""" """
This sets up the basic properties for a player. This sets up the basic properties for a player. Overload this
Overload this with at_player_creation rather than with at_player_creation rather than changing this method.
changing this method.
""" """
# A basic security setup # A basic security setup
lockstring = "examine:perm(Wizards);edit:perm(Wizards);delete:perm(Wizards);boot:perm(Wizards);msg:all()" lockstring = "examine:perm(Wizards);edit:perm(Wizards);" \
"delete:perm(Wizards);boot:perm(Wizards);msg:all()"
self.locks.add(lockstring) self.locks.add(lockstring)
# The ooc player cmdset # The ooc player cmdset
@ -471,14 +520,15 @@ class DefaultPlayer(PlayerDB):
def at_player_creation(self): def at_player_creation(self):
""" """
This is called once, the very first time This is called once, the very first time the player is created
the player is created (i.e. first time they (i.e. first time they register with the game). It's a good
register with the game). It's a good place place to store attributes all players should have, like
to store attributes all players should have, configuration values etc.
like configuration values etc.
""" """
# set an (empty) attribute holding the characters this player has # set an (empty) attribute holding the characters this player has
lockstring = "attrread:perm(Admins);attredit:perm(Admins);attrcreate:perm(Admins)" lockstring = "attrread:perm(Admins);attredit:perm(Admins);" \
"attrcreate:perm(Admins)"
self.attributes.add("_playable_characters", [], lockstring=lockstring) self.attributes.add("_playable_characters", [], lockstring=lockstring)
def at_init(self): def at_init(self):
@ -490,6 +540,7 @@ class DefaultPlayer(PlayerDB):
restart or reload. In the case of player objects, this usually restart or reload. In the case of player objects, this usually
happens the moment the player logs in or reconnects after a happens the moment the player logs in or reconnects after a
reload. reload.
""" """
pass pass
@ -505,6 +556,7 @@ class DefaultPlayer(PlayerDB):
This is a generic hook called by Evennia when this object is This is a generic hook called by Evennia when this object is
saved to the database the very first time. You generally saved to the database the very first time. You generally
don't override this method but the hooks called by it. don't override this method but the hooks called by it.
""" """
self.basetype_setup() self.basetype_setup()
self.at_player_creation() self.at_player_creation()
@ -524,28 +576,46 @@ class DefaultPlayer(PlayerDB):
def at_access(self, result, accessing_obj, access_type, **kwargs): def at_access(self, result, accessing_obj, access_type, **kwargs):
""" """
This is called with the result of an access call, along with This is triggered after an access-call on this Player has
any kwargs used for that call. The return of this method does completed.
not affect the result of the lock check. It can be used e.g. to
customize error messages in a central location or other effects Args:
based on the access result. result (bool): The result of the access check.
accessing_obj (any): The object requesting the access
check.
access_type (str): The type of access checked.
Kwargs:
kwargs (any): These are passed on from the access check
and can be used to relay custom instructions from the
check mechanism.
Notes:
This method cannot affect the result of the lock check and
its return value is not used in any way. It can be used
e.g. to customize error messages in a central location or
create other effects based on the access result.
""" """
pass pass
def at_cmdset_get(self, **kwargs): def at_cmdset_get(self, **kwargs):
""" """
Called just before cmdsets on this player are requested by the Called just *before* cmdsets on this player are requested by
command handler. If changes need to be done on the fly to the the command handler. The cmdsets are available as
`self.cmdset`. If changes need to be done on the fly to the
cmdset before passing them on to the cmdhandler, this is the cmdset before passing them on to the cmdhandler, this is the
place to do it. This is called also if the player currently place to do it. This is called also if the player currently
have no cmdsets. kwargs are usually not used unless the have no cmdsets. kwargs are usually not used unless the
cmdset is generated dynamically. cmdset is generated dynamically.
""" """
pass pass
def at_first_login(self): def at_first_login(self):
""" """
Called the very first time this player logs into the game. Called the very first time this player logs into the game.
""" """
pass pass
@ -553,11 +623,19 @@ class DefaultPlayer(PlayerDB):
""" """
Called every time the user logs in, just before the actual Called every time the user logs in, just before the actual
login-state is set. login-state is set.
""" """
pass pass
def _send_to_connect_channel(self, message): def _send_to_connect_channel(self, message):
"Helper method for loading the default comm channel" """
Helper method for loading and sending to the comm channel
dedicated to connection messages.
Args:
message (str): A message to send to the connect channel.
"""
global _CONNECT_CHANNEL global _CONNECT_CHANNEL
if not _CONNECT_CHANNEL: if not _CONNECT_CHANNEL:
try: try:
@ -575,8 +653,16 @@ class DefaultPlayer(PlayerDB):
def at_post_login(self, sessid=None): def at_post_login(self, sessid=None):
""" """
Called at the end of the login process, just before letting Called at the end of the login process, just before letting
the player loose. This is called before an eventual Character's the player loose.
at_post_login hook.
Args:
sessid (int, optional): Session logging in, if any.
Notes:
This is called *before* an eventual Character's
`at_post_login` hook. By default it is used to set up
auto-puppeting based on `MULTISESSION_MODE`.
""" """
self._send_to_connect_channel("{G%s connected{n" % self.key) self._send_to_connect_channel("{G%s connected{n" % self.key)
if _MULTISESSION_MODE == 0: if _MULTISESSION_MODE == 0:
@ -594,13 +680,18 @@ class DefaultPlayer(PlayerDB):
def at_disconnect(self, reason=None): def at_disconnect(self, reason=None):
""" """
Called just before user is disconnected. Called just before user is disconnected.
Args:
reason (str, optional): The reason given for the disconnect,
(echoed to the connection channel by default).
""" """
reason = reason and "(%s)" % reason or "" reason = reason and "(%s)" % reason or ""
self._send_to_connect_channel("{R%s disconnected %s{n" % (self.key, reason)) self._send_to_connect_channel("{R%s disconnected %s{n" % (self.key, reason))
def at_post_disconnect(self): def at_post_disconnect(self):
""" """
This is called after disconnection is complete. No messages This is called *after* disconnection is complete. No messages
can be relayed to the player from here. After this call, the can be relayed to the player from here. After this call, the
player should not be accessed any more, making this a good player should not be accessed any more, making this a good
spot for deleting it (in the case of a guest player account, spot for deleting it (in the case of a guest player account,
@ -610,25 +701,24 @@ class DefaultPlayer(PlayerDB):
def at_message_receive(self, message, from_obj=None): def at_message_receive(self, message, from_obj=None):
""" """
Called when any text is emitted to this This is currently unused.
object. If it returns False, no text
will be sent automatically.
""" """
return True return True
def at_message_send(self, message, to_object): def at_message_send(self, message, to_object):
""" """
Called whenever this object tries to send text This is currently unused.
to another object. Only called if the object supplied
itself as a sender in the msg() call.
""" """
pass pass
def at_server_reload(self): def at_server_reload(self):
""" """
This hook is called whenever the server is shutting down for This hook is called whenever the server is shutting down for
restart/reboot. If you want to, for example, save non-persistent restart/reboot. If you want to, for example, save
properties across a restart, this is the place to do it. non-persistent properties across a restart, this is the place
to do it.
""" """
pass pass
@ -642,21 +732,26 @@ class DefaultPlayer(PlayerDB):
class DefaultGuest(DefaultPlayer): class DefaultGuest(DefaultPlayer):
""" """
This class is used for guest logins. Unlike Players, Guests and their This class is used for guest logins. Unlike Players, Guests and
characters are deleted after disconnection. their characters are deleted after disconnection.
""" """
def at_post_login(self, sessid=None): def at_post_login(self, sessid=None):
""" """
In theory, guests only have one character regardless of which In theory, guests only have one character regardless of which
MULTISESSION_MODE we're in. They don't get a choice. MULTISESSION_MODE we're in. They don't get a choice.
Args:
sessid (int, optional): Id of Session connecting.
""" """
self._send_to_connect_channel("{G%s connected{n" % self.key) self._send_to_connect_channel("{G%s connected{n" % self.key)
self.puppet_object(sessid, self.db._last_puppet) self.puppet_object(sessid, self.db._last_puppet)
def at_disconnect(self): def at_disconnect(self):
""" """
A Guest's characters aren't meant to linger on the server. When a A Guest's characters aren't meant to linger on the server.
Guest disconnects, we remove its character. When a Guest disconnects, we remove its character.
""" """
super(DefaultGuest, self).at_disconnect() super(DefaultGuest, self).at_disconnect()
characters = self.db._playable_characters characters = self.db._playable_characters
@ -665,7 +760,8 @@ class DefaultGuest(DefaultPlayer):
def at_server_shutdown(self): def at_server_shutdown(self):
""" """
We repeat at_disconnect() here just to be on the safe side. We repeat the functionality of `at_disconnect()` here just to
be on the safe side.
""" """
super(DefaultGuest, self).at_server_shutdown() super(DefaultGuest, self).at_server_shutdown()
characters = self.db._playable_characters characters = self.db._playable_characters
@ -674,8 +770,9 @@ class DefaultGuest(DefaultPlayer):
def at_post_disconnect(self): def at_post_disconnect(self):
""" """
Guests aren't meant to linger on the server, either. We need to wait Guests aren't meant to linger on the server, either. We need
until after the Guest disconnects to delete it, though. to wait until after the Guest disconnects to delete it,
though.
""" """
super(DefaultGuest, self).at_post_disconnect() super(DefaultGuest, self).at_post_disconnect()
self.delete() self.delete()