Made some cleanup of docstrings to clarify hook load order.

This commit is contained in:
Griatch 2015-09-05 21:49:54 +02:00
parent a7e42b2a5b
commit b59340784c
2 changed files with 5 additions and 1 deletions

View file

@ -186,8 +186,8 @@ class CmdUnconnectedConnect(MuxCommand):
# actually do the login. This will call all other hooks:
# session.at_login()
# player.at_init() # always called when object is loaded from disk
# player.at_first_login() # only once, for player-centric setup
# player.at_pre_login()
# player.at_first_login() # only once
# player.at_post_login(sessid=sessid)
session.sessionhandler.login(session, player)

View file

@ -615,6 +615,10 @@ class DefaultPlayer(PlayerDB):
def at_first_login(self):
"""
Called the very first time this player logs into the game.
Note that this is called *before* at_pre_login, so no session
is established and usually no character is yet assigned at
this point. This hook is intended for player-specific setup
like configurations.
"""
pass