evennia.contrib.tutorial_world.intro_menu

Intro menu / game tutor

Evennia contrib - Griatch 2020

This contrib is an intro-menu for general MUD and evennia usage using the EvMenu menu-templating system.

EvMenu templating is a way to create a menu using a string-format instead of creating all nodes manually. Of course, for full functionality one must still create the goto-callbacks.

evennia.contrib.tutorial_world.intro_menu.do_nothing(caller, raw_string, **kwargs)

Re-runs the current node

evennia.contrib.tutorial_world.intro_menu.send_testing_tagged(caller, raw_string, **kwargs)

Test to send a message to a pane tagged with ‘testing’ in the webclient.

class evennia.contrib.tutorial_world.intro_menu.DemoCommandSetHelp(cmdsetobj=None, key=None)

Bases: evennia.commands.cmdset.CmdSet

Demo the help command

key = 'Help Demo Set'

priority = 2

at_cmdset_creation()

Hook method - this should be overloaded in the inheriting class, and should take care of populating the cmdset by use of self.add().

path = 'evennia.contrib.tutorial_world.intro_menu.DemoCommandSetHelp'

evennia.contrib.tutorial_world.intro_menu.goto_command_demo_help(caller, raw_string, **kwargs)

Sets things up before going to the help-demo node

class evennia.contrib.tutorial_world.intro_menu.DemoCommandSetComms(cmdsetobj=None, key=None)

Bases: evennia.commands.cmdset.CmdSet

Demo communications

key = 'Color Demo Set'

priority = 2

no_exits = True

no_objs = True

at_cmdset_creation()

Hook method - this should be overloaded in the inheriting class, and should take care of populating the cmdset by use of self.add().

path = 'evennia.contrib.tutorial_world.intro_menu.DemoCommandSetComms'

evennia.contrib.tutorial_world.intro_menu.goto_command_demo_comms(caller, raw_string, **kwargs)

Setup and go to the color demo node.

class evennia.contrib.tutorial_world.intro_menu.DemoCommandSetRoom(cmdsetobj=None, key=None)

Bases: evennia.commands.cmdset.CmdSet

Demo some general in-game commands command.

key = 'Room Demo Set'

priority = 2

no_exits = False

no_objs = False

at_cmdset_creation()

Hook method - this should be overloaded in the inheriting class, and should take care of populating the cmdset by use of self.add().

path = 'evennia.contrib.tutorial_world.intro_menu.DemoCommandSetRoom'

evennia.contrib.tutorial_world.intro_menu.goto_command_demo_room(caller, raw_string, **kwargs)

Setup and go to the demo-room node. Generates a little 2-room environment for testing out some commands.

evennia.contrib.tutorial_world.intro_menu.goto_cleanup_cmdsets(caller, raw_strings, **kwargs)

Cleanup all cmdsets.

class evennia.contrib.tutorial_world.intro_menu.TutorialEvMenu(caller, menudata, startnode='start', cmdset_mergetype='Replace', cmdset_priority=1, auto_quit=True, auto_look=True, auto_help=True, cmd_on_exit='look', persistent=False, startnode_input='', session=None, debug=False, **kwargs)

Bases: evennia.utils.evmenu.EvMenu

Custom EvMenu for displaying the intro-menu

close_menu()

Custom cleanup actions when closing menu

options_formatter(optionslist)

Formats the option block.

Parameters

• optionlist (list) – List of (key, description) tuples for every option related to this node.

• caller (Object, Account or None, optional) – The caller of the node.

Returns

options (str) – The formatted option display.

evennia.contrib.tutorial_world.intro_menu.init_menu(caller)

Call to initialize the menu.