mirror of
https://github.com/evennia/evennia.git
synced 2026-03-20 06:46:31 +01:00
a9dbac8aae
- Made it so user #1 is also affected by the on_player_creation() function. - Added an event folder for custom events, including a working example - Expanded the example commands and parents to include the changes to how they should be initialized. - Added an optional ansi scheme (not active by default)
67 lines
2.5 KiB
Python
67 lines
2.5 KiB
Python
"""
|
|
This is an example of customizing the basic player character object.
|
|
You will want to do this to add all sorts of custom things like
|
|
attributes, skill values, injuries and so on.
|
|
|
|
If you want to make this the default player object for all players, move it
|
|
into gamesrc/parents and set SCRIPT_DEFAULT_PLAYER = 'custom_basicplayer'
|
|
in game/settings.py.
|
|
"""
|
|
|
|
from game.gamesrc.parents.base.basicplayer import BasicPlayer
|
|
|
|
class CustomBasicPlayer(BasicPlayer):
|
|
|
|
def at_player_creation(self):
|
|
"""
|
|
Called when player object is first created. Use this
|
|
instead of __init__ to define any custom attributes
|
|
all your player characters should have.
|
|
"""
|
|
|
|
#Example: Adding a default sdesc (short description)
|
|
|
|
#get the stored object related to this class
|
|
pobject = self.scripted_obj
|
|
#set the attribute
|
|
pobject.set_attribute('sdesc', 'A normal person')
|
|
|
|
def at_pre_login(self, session):
|
|
"""
|
|
Called when the player has entered the game but has not
|
|
logged in yet.
|
|
"""
|
|
pass
|
|
|
|
def at_post_login(self, session):
|
|
"""
|
|
This command is called after the player has logged in but
|
|
before he is allowed to give any commands.
|
|
"""
|
|
#get the object linked to this class
|
|
pobject = self.scripted_obj
|
|
|
|
#find out more about our object
|
|
name = pobject.get_name(fullname=False,
|
|
show_dbref=False,
|
|
show_flags=False)
|
|
sdesc = pobject.get_attribute_value('sdesc')
|
|
|
|
#send a greeting using our new sdesc attribute
|
|
pobject.emit_to("You are now logged in as %s - %s." % (name, sdesc))
|
|
|
|
#tell everyone else we're here
|
|
pobject.get_location().emit_to_contents("%s - %s, has connected." %
|
|
(name, sdesc), exclude=pobject)
|
|
#show us our surroundings
|
|
pobject.execute_cmd("look")
|
|
|
|
|
|
def class_factory(source_obj):
|
|
"""
|
|
This method is called by any script you retrieve (via the scripthandler). It
|
|
creates an instance of the class and returns it transparently.
|
|
|
|
source_obj: (Object) A reference to the object being scripted (the child).
|
|
"""
|
|
return CustomBasicPlayer(source_obj)
|