Optionally read connection screen from connection_screen() callable
This commit is contained in:
parent
1d0d6bc7cf
commit
c4d178c6c7
3 changed files with 24 additions and 11 deletions
|
|
@ -1,17 +1,22 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
Connection screen
|
||||
Connection screen
|
||||
|
||||
Texts in this module will be shown to the user at login-time.
|
||||
This is the text to show the user when they first connect to the game (before
|
||||
they log in).
|
||||
|
||||
Evennia will look at global string variables (variables defined
|
||||
at the "outermost" scope of this module and use it as the
|
||||
connection screen. If there are more than one, Evennia will
|
||||
randomize which one it displays.
|
||||
To change the login screen in this module, do one of the following:
|
||||
|
||||
- Define a function `connection_screen()`, taking no arguments. This will be
|
||||
called first and must return the full string to act as the connection screen.
|
||||
This can be used to produce more dynamic screens.
|
||||
- Alternatively, define a string variable in the outermost scope of this module
|
||||
with the connection string that should be displayed. If more than one such
|
||||
variable is given, Evennia will pick one of them at random.
|
||||
|
||||
The commands available to the user when the connection screen is shown
|
||||
are defined in commands.default_cmdsets. UnloggedinCmdSet and the
|
||||
screen is read and displayed by the unlogged-in "look" command.
|
||||
are defined in evennia.default_cmds.UnloggedinCmdSet. The parsing and display
|
||||
of the screen is done by the unlogged-in "look" command.
|
||||
|
||||
"""
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue