mirror of
https://github.com/evennia/evennia.git
synced 2026-03-31 04:57:16 +02:00
Updated HTML docs
This commit is contained in:
Griatch
parent
f7e699eaa2
commit
7a8f150ed9
764 changed files with 60139 additions and 76788 deletions
|
|
@ -87,149 +87,288 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.html">evennia.contrib</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.barter.html">evennia.contrib.barter</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.building_menu.html">evennia.contrib.building_menu</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.chargen.html">evennia.contrib.chargen</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.clothing.html">evennia.contrib.clothing</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.color_markups.html">evennia.contrib.color_markups</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.custom_gametime.html">evennia.contrib.custom_gametime</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.dice.html">evennia.contrib.dice</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.email_login.html">evennia.contrib.email_login</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.extended_room.html">evennia.contrib.extended_room</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.fieldfill.html">evennia.contrib.fieldfill</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.gendersub.html">evennia.contrib.gendersub</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.health_bar.html">evennia.contrib.health_bar</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.mail.html">evennia.contrib.mail</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.mapbuilder.html">evennia.contrib.mapbuilder</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.menu_login.html">evennia.contrib.menu_login</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.multidescer.html">evennia.contrib.multidescer</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.puzzles.html">evennia.contrib.puzzles</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.random_string_generator.html">evennia.contrib.random_string_generator</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rplanguage.html">evennia.contrib.rplanguage</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpsystem.html">evennia.contrib.rpsystem</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.simpledoor.html">evennia.contrib.simpledoor</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.slow_exit.html">evennia.contrib.slow_exit</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.talking_npc.html">evennia.contrib.talking_npc</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.test_traits.html">evennia.contrib.test_traits</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.traits.html">evennia.contrib.traits</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.traits.html#adding-traits-to-a-typeclass">Adding Traits to a typeclass</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.traits.html#traits-with-traithandler">Traits with TraitHandler</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.traits.html#traitproperties">TraitProperties</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.base_systems.html">evennia.contrib.base_systems</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.awsstorage.html">evennia.contrib.base_systems.awsstorage</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.awsstorage.aws_s3_cdn.html">evennia.contrib.base_systems.awsstorage.aws_s3_cdn</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.awsstorage.tests.html">evennia.contrib.base_systems.awsstorage.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.traits.html#using-traits">Using traits</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.traits.html#trait-types">Trait types</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.traits.html#static-trait">Static trait</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.traits.html#counter">Counter</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.traits.html#descs">.descs</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.traits.html#rate">.rate</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.traits.html#percent">.percent()</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.building_menu.html">evennia.contrib.base_systems.building_menu</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.building_menu.building_menu.html">evennia.contrib.base_systems.building_menu.building_menu</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.building_menu.tests.html">evennia.contrib.base_systems.building_menu.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.traits.html#gauge">Gauge</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.traits.html#trait">Trait</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.color_markups.html">evennia.contrib.base_systems.color_markups</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.color_markups.color_markups.html">evennia.contrib.base_systems.color_markups.color_markups</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.color_markups.tests.html">evennia.contrib.base_systems.color_markups.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.traits.html#expanding-with-your-own-traits">Expanding with your own Traits</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.custom_gametime.html">evennia.contrib.base_systems.custom_gametime</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.custom_gametime.custom_gametime.html">evennia.contrib.base_systems.custom_gametime.custom_gametime</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.custom_gametime.tests.html">evennia.contrib.base_systems.custom_gametime.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tree_select.html">evennia.contrib.tree_select</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.unixcommand.html">evennia.contrib.unixcommand</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.wilderness.html">evennia.contrib.wilderness</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.awsstorage.html">evennia.contrib.awsstorage</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.awsstorage.aws_s3_cdn.html">evennia.contrib.awsstorage.aws_s3_cdn</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.awsstorage.tests.html">evennia.contrib.awsstorage.tests</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.email_login.html">evennia.contrib.base_systems.email_login</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.email_login.connection_screens.html">evennia.contrib.base_systems.email_login.connection_screens</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.email_login.email_login.html">evennia.contrib.base_systems.email_login.email_login</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.email_login.tests.html">evennia.contrib.base_systems.email_login.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.crafting.html">evennia.contrib.crafting</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.crafting.crafting.html">evennia.contrib.crafting.crafting</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.crafting.crafting.html#installation">Installation</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.crafting.crafting.html#crafting-in-game">Crafting in game</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.crafting.crafting.html#crafting-in-code">Crafting in code</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.crafting.crafting.html#recipes">Recipes</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.html">evennia.contrib.base_systems.ingame_python</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.callbackhandler.html">evennia.contrib.base_systems.ingame_python.callbackhandler</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.commands.html">evennia.contrib.base_systems.ingame_python.commands</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.eventfuncs.html">evennia.contrib.base_systems.ingame_python.eventfuncs</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.scripts.html">evennia.contrib.base_systems.ingame_python.scripts</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.tests.html">evennia.contrib.base_systems.ingame_python.tests</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.typeclasses.html">evennia.contrib.base_systems.ingame_python.typeclasses</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.utils.html">evennia.contrib.base_systems.ingame_python.utils</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.crafting.example_recipes.html">evennia.contrib.crafting.example_recipes</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.crafting.example_recipes.html#sword-crafting-tree">Sword crafting tree</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.crafting.example_recipes.html#recipes-used-for-spell-casting">Recipes used for spell casting</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.html">evennia.contrib.base_systems.menu_login</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.connection_screens.html">evennia.contrib.base_systems.menu_login.connection_screens</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.menu_login.html">evennia.contrib.base_systems.menu_login.menu_login</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.tests.html">evennia.contrib.base_systems.menu_login.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.crafting.tests.html">evennia.contrib.crafting.tests</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.mux_comms_cmds.html">evennia.contrib.base_systems.mux_comms_cmds</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.mux_comms_cmds.tests.html">evennia.contrib.base_systems.mux_comms_cmds.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.evscaperoom.html">evennia.contrib.evscaperoom</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.evscaperoom.commands.html">evennia.contrib.evscaperoom.commands</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.evscaperoom.menu.html">evennia.contrib.evscaperoom.menu</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.evscaperoom.objects.html">evennia.contrib.evscaperoom.objects</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.evscaperoom.room.html">evennia.contrib.evscaperoom.room</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.evscaperoom.scripts.html">evennia.contrib.evscaperoom.scripts</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.evscaperoom.state.html">evennia.contrib.evscaperoom.state</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.evscaperoom.tests.html">evennia.contrib.evscaperoom.tests</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.evscaperoom.utils.html">evennia.contrib.evscaperoom.utils</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.html">evennia.contrib.ingame_python</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.callbackhandler.html">evennia.contrib.ingame_python.callbackhandler</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.commands.html">evennia.contrib.ingame_python.commands</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.eventfuncs.html">evennia.contrib.ingame_python.eventfuncs</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.scripts.html">evennia.contrib.ingame_python.scripts</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.tests.html">evennia.contrib.ingame_python.tests</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.typeclasses.html">evennia.contrib.ingame_python.typeclasses</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.ingame_python.utils.html">evennia.contrib.ingame_python.utils</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.security.html">evennia.contrib.security</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.security.auditing.html">evennia.contrib.security.auditing</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.security.auditing.outputs.html">evennia.contrib.security.auditing.outputs</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.security.auditing.server.html">evennia.contrib.security.auditing.server</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.security.auditing.tests.html">evennia.contrib.security.auditing.tests</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.unixcommand.html">evennia.contrib.base_systems.unixcommand</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.unixcommand.tests.html">evennia.contrib.base_systems.unixcommand.tests</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.unixcommand.unixcommand.html">evennia.contrib.base_systems.unixcommand.unixcommand</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.html">evennia.contrib.turnbattle</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.turnbattle.tb_basic.html">evennia.contrib.turnbattle.tb_basic</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.turnbattle.tb_equip.html">evennia.contrib.turnbattle.tb_equip</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.turnbattle.tb_items.html">evennia.contrib.turnbattle.tb_items</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.turnbattle.tb_magic.html">evennia.contrib.turnbattle.tb_magic</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.turnbattle.tb_range.html">evennia.contrib.turnbattle.tb_range</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.full_systems.html">evennia.contrib.full_systems</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.html">evennia.contrib.full_systems.evscaperoom</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.commands.html">evennia.contrib.full_systems.evscaperoom.commands</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.menu.html">evennia.contrib.full_systems.evscaperoom.menu</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.objects.html">evennia.contrib.full_systems.evscaperoom.objects</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.room.html">evennia.contrib.full_systems.evscaperoom.room</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.scripts.html">evennia.contrib.full_systems.evscaperoom.scripts</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.state.html">evennia.contrib.full_systems.evscaperoom.state</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.tests.html">evennia.contrib.full_systems.evscaperoom.tests</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.utils.html">evennia.contrib.full_systems.evscaperoom.utils</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.html">evennia.contrib.tutorial_examples</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_examples.bodyfunctions.html">evennia.contrib.tutorial_examples.bodyfunctions</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_examples.example_batch_code.html">evennia.contrib.tutorial_examples.example_batch_code</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_examples.mirror.html">evennia.contrib.tutorial_examples.mirror</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_examples.red_button.html">evennia.contrib.tutorial_examples.red_button</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorial_examples.red_button.html#technical">Technical</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_examples.tests.html">evennia.contrib.tutorial_examples.tests</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.html">evennia.contrib.game_systems</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.game_systems.barter.html">evennia.contrib.game_systems.barter</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.barter.barter.html">evennia.contrib.game_systems.barter.barter</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.barter.tests.html">evennia.contrib.game_systems.barter.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_world.html">evennia.contrib.tutorial_world</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_world.intro_menu.html">evennia.contrib.tutorial_world.intro_menu</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_world.mob.html">evennia.contrib.tutorial_world.mob</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_world.objects.html">evennia.contrib.tutorial_world.objects</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorial_world.rooms.html">evennia.contrib.tutorial_world.rooms</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.game_systems.clothing.html">evennia.contrib.game_systems.clothing</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.clothing.clothing.html">evennia.contrib.game_systems.clothing.clothing</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.clothing.tests.html">evennia.contrib.game_systems.clothing.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.xyzgrid.html">evennia.contrib.xyzgrid</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.xyzgrid.commands.html">evennia.contrib.xyzgrid.commands</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.xyzgrid.example.html">evennia.contrib.xyzgrid.example</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.xyzgrid.launchcmd.html">evennia.contrib.xyzgrid.launchcmd</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.xyzgrid.prototypes.html">evennia.contrib.xyzgrid.prototypes</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.xyzgrid.tests.html">evennia.contrib.xyzgrid.tests</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.xyzgrid.utils.html">evennia.contrib.xyzgrid.utils</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.xyzgrid.xymap.html">evennia.contrib.xyzgrid.xymap</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.xyzgrid.xymap.html#xymap">XYMap</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.game_systems.cooldowns.html">evennia.contrib.game_systems.cooldowns</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.cooldowns.cooldowns.html">evennia.contrib.game_systems.cooldowns.cooldowns</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.cooldowns.tests.html">evennia.contrib.game_systems.cooldowns.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.xyzgrid.xymap_legend.html">evennia.contrib.xyzgrid.xymap_legend</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.xyzgrid.xymap_legend.html#map-legend-components">Map legend components</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.game_systems.crafting.html">evennia.contrib.game_systems.crafting</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html">evennia.contrib.game_systems.crafting.crafting</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#installation">Installation</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#crafting-in-game">Crafting in game</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#crafting-in-code">Crafting in code</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#recipes">Recipes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.crafting.example_recipes.html">evennia.contrib.game_systems.crafting.example_recipes</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.game_systems.crafting.example_recipes.html#sword-crafting-tree">Sword crafting tree</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.game_systems.crafting.example_recipes.html#recipes-used-for-spell-casting">Recipes used for spell casting</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.crafting.tests.html">evennia.contrib.game_systems.crafting.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.game_systems.gendersub.html">evennia.contrib.game_systems.gendersub</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.gendersub.gendersub.html">evennia.contrib.game_systems.gendersub.gendersub</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.gendersub.tests.html">evennia.contrib.game_systems.gendersub.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.game_systems.mail.html">evennia.contrib.game_systems.mail</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.mail.mail.html">evennia.contrib.game_systems.mail.mail</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.mail.tests.html">evennia.contrib.game_systems.mail.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.game_systems.multidescer.html">evennia.contrib.game_systems.multidescer</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.multidescer.multidescer.html">evennia.contrib.game_systems.multidescer.multidescer</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.multidescer.tests.html">evennia.contrib.game_systems.multidescer.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.game_systems.puzzles.html">evennia.contrib.game_systems.puzzles</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.puzzles.puzzles.html">evennia.contrib.game_systems.puzzles.puzzles</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.puzzles.tests.html">evennia.contrib.game_systems.puzzles.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.html">evennia.contrib.game_systems.turnbattle</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_basic.html">evennia.contrib.game_systems.turnbattle.tb_basic</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_equip.html">evennia.contrib.game_systems.turnbattle.tb_equip</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_items.html">evennia.contrib.game_systems.turnbattle.tb_items</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_magic.html">evennia.contrib.game_systems.turnbattle.tb_magic</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_range.html">evennia.contrib.game_systems.turnbattle.tb_range</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tests.html">evennia.contrib.game_systems.turnbattle.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.grid.html">evennia.contrib.grid</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.grid.extended_room.html">evennia.contrib.grid.extended_room</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.extended_room.extended_room.html">evennia.contrib.grid.extended_room.extended_room</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.extended_room.tests.html">evennia.contrib.grid.extended_room.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.grid.mapbuilder.html">evennia.contrib.grid.mapbuilder</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.mapbuilder.mapbuilder.html">evennia.contrib.grid.mapbuilder.mapbuilder</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.mapbuilder.tests.html">evennia.contrib.grid.mapbuilder.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.grid.simpledoor.html">evennia.contrib.grid.simpledoor</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.simpledoor.simpledoor.html">evennia.contrib.grid.simpledoor.simpledoor</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.simpledoor.tests.html">evennia.contrib.grid.simpledoor.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.grid.slow_exit.html">evennia.contrib.grid.slow_exit</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.slow_exit.slow_exit.html">evennia.contrib.grid.slow_exit.slow_exit</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.grid.slow_exit.slow_exit.html#installation">Installation:</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.grid.slow_exit.slow_exit.html#notes">Notes:</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.slow_exit.tests.html">evennia.contrib.grid.slow_exit.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.grid.wilderness.html">evennia.contrib.grid.wilderness</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.wilderness.tests.html">evennia.contrib.grid.wilderness.tests</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.wilderness.wilderness.html">evennia.contrib.grid.wilderness.wilderness</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.grid.wilderness.wilderness.html#usage">Usage</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.grid.wilderness.wilderness.html#customisation">Customisation</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.grid.wilderness.wilderness.html#example">Example</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.grid.wilderness.wilderness.html#implementation-details">Implementation details</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.html">evennia.contrib.grid.xyzgrid</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.commands.html">evennia.contrib.grid.xyzgrid.commands</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.example.html">evennia.contrib.grid.xyzgrid.example</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.launchcmd.html">evennia.contrib.grid.xyzgrid.launchcmd</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.prototypes.html">evennia.contrib.grid.xyzgrid.prototypes</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.tests.html">evennia.contrib.grid.xyzgrid.tests</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.utils.html">evennia.contrib.grid.xyzgrid.utils</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.xymap.html">evennia.contrib.grid.xyzgrid.xymap</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.xymap.html#xymap">XYMap</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.xymap_legend.html">evennia.contrib.grid.xyzgrid.xymap_legend</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.xymap_legend.html#map-legend-components">Map legend components</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.xyzgrid.html">evennia.contrib.grid.xyzgrid.xyzgrid</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.xyzroom.html">evennia.contrib.grid.xyzgrid.xyzroom</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.rpg.html">evennia.contrib.rpg</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.rpg.dice.html">evennia.contrib.rpg.dice</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.rpg.dice.dice.html">evennia.contrib.rpg.dice.dice</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.rpg.dice.dice.html#dice">Dice</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.rpg.dice.dice.html#installation">Installation:</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.rpg.dice.dice.html#usage">Usage:</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.rpg.dice.tests.html">evennia.contrib.rpg.dice.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.rpg.health_bar.html">evennia.contrib.rpg.health_bar</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.rpg.health_bar.health_bar.html">evennia.contrib.rpg.health_bar.health_bar</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.rpg.health_bar.tests.html">evennia.contrib.rpg.health_bar.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.rpg.rpsystem.html">evennia.contrib.rpg.rpsystem</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.rpg.rpsystem.rplanguage.html">evennia.contrib.rpg.rpsystem.rplanguage</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.rpg.rpsystem.rpsystem.html">evennia.contrib.rpg.rpsystem.rpsystem</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.rpg.rpsystem.tests.html">evennia.contrib.rpg.rpsystem.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.rpg.traits.html">evennia.contrib.rpg.traits</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.rpg.traits.tests.html">evennia.contrib.rpg.traits.tests</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html">evennia.contrib.rpg.traits.traits</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#installation">Installation</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#using-traits">Using traits</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#trait-types">Trait types</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#static-trait">Static trait</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.rpg.traits.traits.html#expanding-with-your-own-traits">Expanding with your own Traits</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.html">evennia.contrib.tutorials</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.batchprocessor.html">evennia.contrib.tutorials.batchprocessor</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.batchprocessor.example_batch_code.html">evennia.contrib.tutorials.batchprocessor.example_batch_code</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.bodyfunctions.html">evennia.contrib.tutorials.bodyfunctions</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.bodyfunctions.bodyfunctions.html">evennia.contrib.tutorials.bodyfunctions.bodyfunctions</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.bodyfunctions.tests.html">evennia.contrib.tutorials.bodyfunctions.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.mirror.html">evennia.contrib.tutorials.mirror</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.mirror.mirror.html">evennia.contrib.tutorials.mirror.mirror</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.red_button.html">evennia.contrib.tutorials.red_button</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.red_button.red_button.html">evennia.contrib.tutorials.red_button.red_button</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.tutorials.red_button.red_button.html#technical">Technical</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.talking_npc.html">evennia.contrib.tutorials.talking_npc</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.talking_npc.talking_npc.html">evennia.contrib.tutorials.talking_npc.talking_npc</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.talking_npc.tests.html">evennia.contrib.tutorials.talking_npc.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.tutorial_world.html">evennia.contrib.tutorials.tutorial_world</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.tutorial_world.intro_menu.html">evennia.contrib.tutorials.tutorial_world.intro_menu</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.tutorial_world.mob.html">evennia.contrib.tutorials.tutorial_world.mob</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.tutorial_world.objects.html">evennia.contrib.tutorials.tutorial_world.objects</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.tutorial_world.rooms.html">evennia.contrib.tutorials.tutorial_world.rooms</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.tutorial_world.tests.html">evennia.contrib.tutorials.tutorial_world.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.html">evennia.contrib.utils</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.auditing.html">evennia.contrib.utils.auditing</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.utils.auditing.outputs.html">evennia.contrib.utils.auditing.outputs</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.utils.auditing.server.html">evennia.contrib.utils.auditing.server</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.utils.auditing.tests.html">evennia.contrib.utils.auditing.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.fieldfill.html">evennia.contrib.utils.fieldfill</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html">evennia.contrib.utils.fieldfill.fieldfill</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.html">evennia.contrib.utils.random_string_generator</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html">evennia.contrib.utils.random_string_generator.random_string_generator</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.tests.html">evennia.contrib.utils.random_string_generator.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.tree_select.html">evennia.contrib.utils.tree_select</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.utils.tree_select.tests.html">evennia.contrib.utils.tree_select.tests</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html">evennia.contrib.utils.tree_select.tree_select</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.xyzgrid.xyzgrid.html">evennia.contrib.xyzgrid.xyzgrid</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.xyzgrid.xyzroom.html">evennia.contrib.xyzgrid.xyzroom</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -279,7 +279,7 @@ command. Note that this is the bot.</p></li>
|
|||
<li><p><strong>channel</strong> (<em>str</em>) – The name of channel the message was sent to.</p></li>
|
||||
<li><p><strong>type</strong> (<em>str</em>) – Nature of message. Either ‘msg’, ‘action’, ‘nicklist’
|
||||
or ‘ping’.</p></li>
|
||||
<li><p><strong>nicklist</strong> (<a class="reference internal" href="evennia.contrib.barter.html#evennia.contrib.barter.TradeHandler.list" title="evennia.contrib.barter.TradeHandler.list"><em>list</em></a><em>, </em><em>optional</em>) – Set if <strong>type=’nicklist’</strong>. This is a list
|
||||
<li><p><strong>nicklist</strong> (<a class="reference internal" href="evennia.contrib.game_systems.barter.barter.html#evennia.contrib.game_systems.barter.barter.TradeHandler.list" title="evennia.contrib.game_systems.barter.barter.TradeHandler.list"><em>list</em></a><em>, </em><em>optional</em>) – Set if <strong>type=’nicklist’</strong>. This is a list
|
||||
of nicks returned by calling the <strong>self.get_nicklist</strong>. It must look
|
||||
for a list <strong>self._nicklist_callers</strong> which will contain all callers
|
||||
waiting for the nicklist.</p></li>
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@ method. Otherwise all text will be returned to all connected sessions.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.account.CmdOOCLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -104,7 +104,7 @@ method. Otherwise all text will be returned to all connected sessions.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.account.CmdOOCLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -257,7 +257,7 @@ to accounts respectively.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.admin.CmdEmit.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['pemit', 'remit']</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['remit', 'pemit']</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -288,7 +288,7 @@ to accounts respectively.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.admin.CmdEmit.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'pemit remit', 'category': 'admin', 'key': 'emit', 'no_prefix': ' pemit remit', 'tags': '', 'text': '\n admin command for emitting message to multiple objects\n\n Usage:\n emit[/switches] [<obj>, <obj>, ... =] <message>\n remit [<obj>, <obj>, ... =] <message>\n pemit [<obj>, <obj>, ... =] <message>\n\n Switches:\n room - limit emits to rooms only (default)\n accounts - limit emits to accounts only\n contents - send to the contents of matched objects too\n\n Emits a message to the selected objects or to\n your immediate surroundings. If the object is a room,\n send to its contents. remit and pemit are just\n limited forms of emit, for sending to rooms and\n to accounts respectively.\n '}</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'remit pemit', 'category': 'admin', 'key': 'emit', 'no_prefix': ' remit pemit', 'tags': '', 'text': '\n admin command for emitting message to multiple objects\n\n Usage:\n emit[/switches] [<obj>, <obj>, ... =] <message>\n remit [<obj>, <obj>, ... =] <message>\n pemit [<obj>, <obj>, ... =] <message>\n\n Switches:\n room - limit emits to rooms only (default)\n accounts - limit emits to accounts only\n contents - send to the contents of matched objects too\n\n Emits a message to the selected objects or to\n your immediate surroundings. If the object is a room,\n send to its contents. remit and pemit are just\n limited forms of emit, for sending to rooms and\n to accounts respectively.\n '}</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -1278,7 +1278,7 @@ server settings.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdTypeclass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@parent', '@type', '@typeclasses', '@swap', '@update']</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@update', '@typeclasses', '@type', '@parent', '@swap']</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -1309,7 +1309,7 @@ server settings.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdTypeclass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@parent @type @typeclasses @swap @update', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass parent type typeclasses swap update', 'tags': '', 'text': "\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] <object> [= typeclass.path]\n typeclass/prototype <object> = prototype_key\n\n typeclasses or typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object. This will also\n reset cmdsets!\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n "}</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@update @typeclasses @type @parent @swap', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass update typeclasses type parent swap', 'tags': '', 'text': "\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] <object> [= typeclass.path]\n typeclass/prototype <object> = prototype_key\n\n typeclasses or typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object. This will also\n reset cmdsets!\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n "}</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -1729,7 +1729,7 @@ one is given.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdFind.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@locate', '@search']</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@search', '@locate']</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -1760,7 +1760,7 @@ one is given.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdFind.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@locate @search', 'category': 'building', 'key': '@find', 'no_prefix': 'find locate search', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] <name or dbref or *account> [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@search @locate', 'category': 'building', 'key': '@find', 'no_prefix': 'find search locate', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] <name or dbref or *account> [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -115,7 +115,7 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a><account&g
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -146,7 +146,7 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a><account&g
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -208,7 +208,7 @@ for everyone to use, you need build privileges and the alias command.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdNick.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['nicks', 'nickname']</em><a class="headerlink" href="#evennia.commands.default.general.CmdNick.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['nickname', 'nicks']</em><a class="headerlink" href="#evennia.commands.default.general.CmdNick.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -240,7 +240,7 @@ for everyone to use, you need build privileges and the alias command.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdNick.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'nicks nickname', 'category': 'general', 'key': 'nick', 'no_prefix': ' nicks nickname', 'tags': '', 'text': '\n define a personal alias/nick by defining a string to\n match and replace it with another on the fly\n\n Usage:\n nick[/switches] <string> [= [replacement_string]]\n nick[/switches] <template> = <replacement_template>\n nick/delete <string> or number\n nicks\n\n Switches:\n inputline - replace on the inputline (default)\n object - replace on object-lookup\n account - replace on account-lookup\n list - show all defined aliases (also "nicks" works)\n delete - remove nick by index in /list\n clearall - clear all nicks\n\n Examples:\n nick hi = say Hello, I\'m Sarah!\n nick/object tom = the tall man\n nick build $1 $2 = create/drop $1;$2\n nick tell $1 $2=page $1=$2\n nick tm?$1=page tallman=$1\n nick tm\\=$1=page tallman=$1\n\n A \'nick\' is a personal string replacement. Use $1, $2, ... to catch arguments.\n Put the last $-marker without an ending space to catch all remaining text. You\n can also use unix-glob matching for the left-hand side <string>:\n\n * - matches everything\n ? - matches 0 or 1 single characters\n [abcd] - matches these chars in any order\n [!abcd] - matches everything not among these chars\n \\= - escape literal \'=\' you want in your <string>\n\n Note that no objects are actually renamed or changed by this command - your nicks\n are only available to you. If you want to permanently add keywords to an object\n for everyone to use, you need build privileges and the alias command.\n\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdNick.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'nickname nicks', 'category': 'general', 'key': 'nick', 'no_prefix': ' nickname nicks', 'tags': '', 'text': '\n define a personal alias/nick by defining a string to\n match and replace it with another on the fly\n\n Usage:\n nick[/switches] <string> [= [replacement_string]]\n nick[/switches] <template> = <replacement_template>\n nick/delete <string> or number\n nicks\n\n Switches:\n inputline - replace on the inputline (default)\n object - replace on object-lookup\n account - replace on account-lookup\n list - show all defined aliases (also "nicks" works)\n delete - remove nick by index in /list\n clearall - clear all nicks\n\n Examples:\n nick hi = say Hello, I\'m Sarah!\n nick/object tom = the tall man\n nick build $1 $2 = create/drop $1;$2\n nick tell $1 $2=page $1=$2\n nick tm?$1=page tallman=$1\n nick tm\\=$1=page tallman=$1\n\n A \'nick\' is a personal string replacement. Use $1, $2, ... to catch arguments.\n Put the last $-marker without an ending space to catch all remaining text. You\n can also use unix-glob matching for the left-hand side <string>:\n\n * - matches everything\n ? - matches 0 or 1 single characters\n [abcd] - matches these chars in any order\n [!abcd] - matches everything not among these chars\n \\= - escape literal \'=\' you want in your <string>\n\n Note that no objects are actually renamed or changed by this command - your nicks\n are only available to you. If you want to permanently add keywords to an object\n for everyone to use, you need build privileges and the alias command.\n\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdNick.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -649,7 +649,7 @@ automatically begin with your name.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdPose.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['emote', ':']</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = [':', 'emote']</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -690,7 +690,7 @@ space.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdPose.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'emote :', 'category': 'general', 'key': 'pose', 'no_prefix': ' emote :', 'tags': '', 'text': "\n strike a pose\n\n Usage:\n pose <pose text>\n pose's <pose text>\n\n Example:\n pose is standing by the wall, smiling.\n -> others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n "}</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ': emote', 'category': 'general', 'key': 'pose', 'no_prefix': ' : emote', 'tags': '', 'text': "\n strike a pose\n\n Usage:\n pose <pose text>\n pose's <pose text>\n\n Example:\n pose is standing by the wall, smiling.\n -> others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n "}</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -623,7 +623,7 @@ See <a href="#id11"><span class="problematic" id="id12">|</span></a>luhttps://ww
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.system.CmdTasks.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@task', '@delays']</em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@delays', '@task']</em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -669,7 +669,7 @@ to all the variables defined therein.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.system.CmdTasks.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@task @delays', 'category': 'system', 'key': '@tasks', 'no_prefix': 'tasks task delays', 'tags': '', 'text': "\n Display or terminate active tasks (delays).\n\n Usage:\n tasks[/switch] [task_id or function_name]\n\n Switches:\n pause - Pause the callback of a task.\n unpause - Process all callbacks made since pause() was called.\n do_task - Execute the task (call its callback).\n call - Call the callback of this task.\n remove - Remove a task without executing it.\n cancel - Stop a task from automatically executing.\n\n Notes:\n A task is a single use method of delaying the call of a function. Calls are created\n in code, using `evennia.utils.delay`.\n See |luhttps://www.evennia.com/docs/latest/Command-Duration.html|ltthe docs|le for help.\n\n By default, tasks that are canceled and never called are cleaned up after one minute.\n\n Examples:\n - `tasks/cancel move_callback` - Cancels all movement delays from the slow_exit contrib.\n In this example slow exits creates it's tasks with\n `utils.delay(move_delay, move_callback)`\n - `tasks/cancel 2` - Cancel task id 2.\n\n "}</em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@delays @task', 'category': 'system', 'key': '@tasks', 'no_prefix': 'tasks delays task', 'tags': '', 'text': "\n Display or terminate active tasks (delays).\n\n Usage:\n tasks[/switch] [task_id or function_name]\n\n Switches:\n pause - Pause the callback of a task.\n unpause - Process all callbacks made since pause() was called.\n do_task - Execute the task (call its callback).\n call - Call the callback of this task.\n remove - Remove a task without executing it.\n cancel - Stop a task from automatically executing.\n\n Notes:\n A task is a single use method of delaying the call of a function. Calls are created\n in code, using `evennia.utils.delay`.\n See |luhttps://www.evennia.com/docs/latest/Command-Duration.html|ltthe docs|le for help.\n\n By default, tasks that are canceled and never called are cleaned up after one minute.\n\n Examples:\n - `tasks/cancel move_callback` - Cancels all movement delays from the slow_exit contrib.\n In this example slow exits creates it's tasks with\n `utils.delay(move_delay, move_callback)`\n - `tasks/cancel 2` - Cancel task id 2.\n\n "}</em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -51,16 +51,18 @@ main test suite started with</p>
|
|||
<div><p>> python game/manage.py test.</p>
|
||||
</div></blockquote>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.CommandTest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">CommandTest</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#CommandTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.CommandTest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.EvenniaTest" title="evennia.utils.test_resources.EvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.EvenniaTest</span></code></a></p>
|
||||
<dt id="evennia.commands.default.tests.CommandTestMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">CommandTestMixin</code><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#CommandTestMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.CommandTestMixin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Mixin to add to a test in order to provide the <strong>.call</strong> helper for
|
||||
testing the execution and returns of a command.</p>
|
||||
<p>Tests a Command by running it and comparing what messages it sends with
|
||||
expected values. This tests without actually spinning up the cmdhandler
|
||||
for every test, which is more controlled.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">commands.echo</span> <span class="kn">import</span> <span class="n">CmdEcho</span>
|
||||
|
||||
<span class="k">class</span> <span class="nc">MyCommandTest</span><span class="p">(</span><span class="n">CommandTest</span><span class="p">):</span>
|
||||
<span class="k">class</span> <span class="nc">MyCommandTest</span><span class="p">(</span><span class="n">EvenniaTest</span><span class="p">,</span> <span class="n">CommandTestMixin</span><span class="p">):</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">test_echo</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="sd">'''</span>
|
||||
|
|
@ -72,8 +74,8 @@ for every test, which is more controlled.</p>
|
|||
</pre></div>
|
||||
</div>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.CommandTest.call">
|
||||
<code class="sig-name descname">call</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdobj</span></em>, <em class="sig-param"><span class="n">input_args</span></em>, <em class="sig-param"><span class="n">msg</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cmdset</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">noansi</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">receiver</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cmdstring</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inputs</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">raw_string</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#CommandTest.call"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.CommandTest.call" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.commands.default.tests.CommandTestMixin.call">
|
||||
<code class="sig-name descname">call</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdobj</span></em>, <em class="sig-param"><span class="n">input_args</span></em>, <em class="sig-param"><span class="n">msg</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cmdset</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">noansi</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">receiver</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cmdstring</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inputs</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">raw_string</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#CommandTestMixin.call"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.CommandTestMixin.call" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test a command by assigning all the needed properties to a cmdobj and
|
||||
running the sequence. The resulting <strong>.msg</strong> calls will be mocked and
|
||||
the text= calls to them compared to a expected output.</p>
|
||||
|
|
@ -159,10 +161,25 @@ the proper order:</p>
|
|||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.EvenniaCommandTest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">EvenniaCommandTest</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#EvenniaCommandTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.EvenniaCommandTest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a>, <a class="reference internal" href="#evennia.commands.default.tests.CommandTestMixin" title="evennia.commands.default.tests.CommandTestMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTestMixin</span></code></a></p>
|
||||
<p>Commands only using the default settings.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.CommandTest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">CommandTest</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#CommandTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.CommandTest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.EvenniaTest" title="evennia.utils.test_resources.EvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.EvenniaTest</span></code></a>, <a class="reference internal" href="#evennia.commands.default.tests.CommandTestMixin" title="evennia.commands.default.tests.CommandTestMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTestMixin</span></code></a></p>
|
||||
<p>Parent class to inherit from - makes tests use your own
|
||||
classes and settings in mygame.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.TestGeneral">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">TestGeneral</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestGeneral"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestGeneral" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestGeneral.test_look">
|
||||
<code class="sig-name descname">test_look</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestGeneral.test_look"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestGeneral.test_look" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -223,7 +240,7 @@ the proper order:</p>
|
|||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.TestHelp">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">TestHelp</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestHelp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.tests.TestHelp.maxDiff">
|
||||
<code class="sig-name descname">maxDiff</code><em class="property"> = None</em><a class="headerlink" href="#evennia.commands.default.tests.TestHelp.maxDiff" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -333,7 +350,7 @@ the proper order:</p>
|
|||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.TestSystem">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">TestSystem</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestSystem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestSystem" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestSystem.test_py">
|
||||
<code class="sig-name descname">test_py</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestSystem.test_py"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestSystem.test_py" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -369,7 +386,7 @@ the proper order:</p>
|
|||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.TestCmdTasks">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">TestCmdTasks</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestCmdTasks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestCmdTasks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestCmdTasks.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestCmdTasks.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestCmdTasks.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -464,7 +481,7 @@ the proper order:</p>
|
|||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.TestAdmin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">TestAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestAdmin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAdmin.test_emit">
|
||||
<code class="sig-name descname">test_emit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestAdmin.test_emit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestAdmin.test_emit" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -495,7 +512,7 @@ the proper order:</p>
|
|||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.TestAccount">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">TestAccount</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestAccount"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestAccount" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look">
|
||||
<code class="sig-name descname">test_ooc_look</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestAccount.test_ooc_look"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -571,7 +588,7 @@ the proper order:</p>
|
|||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.TestBuilding">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">TestBuilding</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestBuilding"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestBuilding" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestBuilding.test_create">
|
||||
<code class="sig-name descname">test_create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestBuilding.test_create" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -714,7 +731,7 @@ the proper order:</p>
|
|||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.TestCommsChannel">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">TestCommsChannel</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestCommsChannel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestCommsChannel" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<p>Test the central <strong>channel</strong> command.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestCommsChannel.setUp">
|
||||
|
|
@ -825,7 +842,7 @@ the proper order:</p>
|
|||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.TestComms">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">TestComms</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestComms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestComms" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestComms.test_page">
|
||||
<code class="sig-name descname">test_page</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestComms.test_page"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestComms.test_page" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -836,10 +853,16 @@ the proper order:</p>
|
|||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.TestBatchProcess">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">TestBatchProcess</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestBatchProcess"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestBatchProcess" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<p>Test the batch processor.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.tests.TestBatchProcess.red_button">
|
||||
<code class="sig-name descname">red_button</code><em class="property"> = <module 'evennia.contrib.tutorials.red_button.red_button' from '/home/griatch/Devel/Home/evennia/evennia/evennia/contrib/tutorials/red_button/red_button.py'></em><a class="headerlink" href="#evennia.commands.default.tests.TestBatchProcess.red_button" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestBatchProcess.test_batch_commands">
|
||||
<code class="sig-name descname">test_batch_commands</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_delay</span></em>, <em class="sig-param"><span class="n">mock_repeat</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestBatchProcess.test_batch_commands"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestBatchProcess.test_batch_commands" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">test_batch_commands</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_tutorials</span></em>, <em class="sig-param"><span class="n">mock_repeat</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestBatchProcess.test_batch_commands"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestBatchProcess.test_batch_commands" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -949,7 +972,7 @@ set in self.parse())</p>
|
|||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.TestInterruptCommand">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">TestInterruptCommand</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestInterruptCommand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestInterruptCommand" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestInterruptCommand.test_interrupt_command">
|
||||
<code class="sig-name descname">test_interrupt_command</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestInterruptCommand.test_interrupt_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestInterruptCommand.test_interrupt_command" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -960,7 +983,7 @@ set in self.parse())</p>
|
|||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.TestUnconnectedCommand">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">TestUnconnectedCommand</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestUnconnectedCommand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestUnconnectedCommand" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestUnconnectedCommand.test_info_command">
|
||||
<code class="sig-name descname">test_info_command</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestUnconnectedCommand.test_info_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestUnconnectedCommand.test_info_command" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -971,7 +994,7 @@ set in self.parse())</p>
|
|||
<dl class="py class">
|
||||
<dt id="evennia.commands.default.tests.TestSystemCommands">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.tests.</code><code class="sig-name descname">TestSystemCommands</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestSystemCommands"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestSystemCommands" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestSystemCommands.test_simple_defaults">
|
||||
<code class="sig-name descname">test_simple_defaults</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestSystemCommands.test_simple_defaults"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestSystemCommands.test_simple_defaults" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ connect “account name” “pass word”</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['con', 'conn', 'co']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['con', 'co', 'conn']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -97,7 +97,7 @@ there is no object yet before the account has logged in)</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'con conn co', 'category': 'general', 'key': 'connect', 'no_prefix': ' con conn co', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name" "pass word"\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'con co conn', 'category': 'general', 'key': 'connect', 'no_prefix': ' con co conn', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name" "pass word"\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -121,7 +121,7 @@ create “account name” “pass word”</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedCreate.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['cre', 'cr']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['cr', 'cre']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -152,7 +152,7 @@ create “account name” “pass word”</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedCreate.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'cre cr', 'category': 'general', 'key': 'create', 'no_prefix': ' cre cr', 'tags': '', 'text': '\n create a new account account\n\n Usage (at login screen):\n create <accountname> <password>\n create "account name" "pass word"\n\n This creates a new account account.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'cr cre', 'category': 'general', 'key': 'create', 'no_prefix': ' cr cre', 'tags': '', 'text': '\n create a new account account\n\n Usage (at login screen):\n create <accountname> <password>\n create "account name" "pass word"\n\n This creates a new account account.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -226,7 +226,7 @@ All it does is display the connect screen.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['look', 'l']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'look']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -252,7 +252,7 @@ All it does is display the connect screen.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' look l', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' l look', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -275,7 +275,7 @@ for simplicity. It shows a pane of info.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['h', '?']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?', 'h']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -301,7 +301,7 @@ for simplicity. It shows a pane of info.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '? h', 'category': 'general', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -1,330 +0,0 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.awsstorage.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.awsstorage.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.awsstorage.tests">
|
||||
<span id="evennia-contrib-awsstorage-tests"></span><h1>evennia.contrib.awsstorage.tests<a class="headerlink" href="#module-evennia.contrib.awsstorage.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3TestCase">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.awsstorage.tests.</code><code class="sig-name descname">S3Boto3TestCase</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3TestCase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3TestCase" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.test.testcases.TestCase</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3TestCase.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3TestCase.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3TestCase.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.awsstorage.tests.</code><code class="sig-name descname">S3Boto3StorageTests</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.awsstorage.tests.S3Boto3TestCase" title="evennia.contrib.awsstorage.tests.S3Boto3TestCase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.awsstorage.tests.S3Boto3TestCase</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_clean_name">
|
||||
<code class="sig-name descname">test_clean_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_clean_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_clean_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the base case of _clean_name</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_clean_name_normalize">
|
||||
<code class="sig-name descname">test_clean_name_normalize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_clean_name_normalize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_clean_name_normalize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the normalization of _clean_name</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_clean_name_trailing_slash">
|
||||
<code class="sig-name descname">test_clean_name_trailing_slash</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_clean_name_trailing_slash"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_clean_name_trailing_slash" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the _clean_name when the path has a trailing slash</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_clean_name_windows">
|
||||
<code class="sig-name descname">test_clean_name_windows</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_clean_name_windows"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_clean_name_windows" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the _clean_name when the path has a trailing slash</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_pickle_with_bucket">
|
||||
<code class="sig-name descname">test_pickle_with_bucket</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_pickle_with_bucket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_pickle_with_bucket" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test that the storage can be pickled with a bucket attached</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_pickle_without_bucket">
|
||||
<code class="sig-name descname">test_pickle_without_bucket</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_pickle_without_bucket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_pickle_without_bucket" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test that the storage can be pickled, without a bucket instance</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_url_slashes">
|
||||
<code class="sig-name descname">test_storage_url_slashes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_url_slashes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_url_slashes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test URL generation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_save">
|
||||
<code class="sig-name descname">test_storage_save</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_save" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test saving a file</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_save_with_acl">
|
||||
<code class="sig-name descname">test_storage_save_with_acl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_save_with_acl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_save_with_acl" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test saving a file with user defined ACL.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_content_type">
|
||||
<code class="sig-name descname">test_content_type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_content_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_content_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test saving a file with a None content type.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_save_gzipped">
|
||||
<code class="sig-name descname">test_storage_save_gzipped</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_save_gzipped"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_save_gzipped" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test saving a gzipped file</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_save_gzip">
|
||||
<code class="sig-name descname">test_storage_save_gzip</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_save_gzip"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_save_gzip" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test saving a file with gzip enabled.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_save_gzip_twice">
|
||||
<code class="sig-name descname">test_storage_save_gzip_twice</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_save_gzip_twice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_save_gzip_twice" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test saving the same file content twice with gzip enabled.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_compress_content_len">
|
||||
<code class="sig-name descname">test_compress_content_len</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_compress_content_len"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_compress_content_len" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test that file returned by _compress_content() is readable.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_open_write">
|
||||
<code class="sig-name descname">test_storage_open_write</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_open_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_open_write" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test opening a file in write mode</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_open_no_write">
|
||||
<code class="sig-name descname">test_storage_open_no_write</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_open_no_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_open_no_write" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test opening file in write mode and closing without writing.</p>
|
||||
<p>A file should be created as by obj.put(…).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_open_no_overwrite_existing">
|
||||
<code class="sig-name descname">test_storage_open_no_overwrite_existing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_open_no_overwrite_existing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_open_no_overwrite_existing" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test opening an existing file in write mode and closing without writing.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_write_beyond_buffer_size">
|
||||
<code class="sig-name descname">test_storage_write_beyond_buffer_size</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_write_beyond_buffer_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_write_beyond_buffer_size" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test writing content that exceeds the buffer size</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_auto_creating_bucket">
|
||||
<code class="sig-name descname">test_auto_creating_bucket</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_auto_creating_bucket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_auto_creating_bucket" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_auto_creating_bucket_with_acl">
|
||||
<code class="sig-name descname">test_auto_creating_bucket_with_acl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_auto_creating_bucket_with_acl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_auto_creating_bucket_with_acl" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_exists">
|
||||
<code class="sig-name descname">test_storage_exists</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_exists" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_exists_false">
|
||||
<code class="sig-name descname">test_storage_exists_false</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_exists_false"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_exists_false" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_exists_doesnt_create_bucket">
|
||||
<code class="sig-name descname">test_storage_exists_doesnt_create_bucket</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_exists_doesnt_create_bucket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_exists_doesnt_create_bucket" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_delete">
|
||||
<code class="sig-name descname">test_storage_delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_listdir_base">
|
||||
<code class="sig-name descname">test_storage_listdir_base</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_listdir_base"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_listdir_base" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_listdir_subdir">
|
||||
<code class="sig-name descname">test_storage_listdir_subdir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_listdir_subdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_listdir_subdir" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_size">
|
||||
<code class="sig-name descname">test_storage_size</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_size" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_mtime">
|
||||
<code class="sig-name descname">test_storage_mtime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_mtime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_mtime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_url">
|
||||
<code class="sig-name descname">test_storage_url</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_storage_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_storage_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_generated_url_is_encoded">
|
||||
<code class="sig-name descname">test_generated_url_is_encoded</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_generated_url_is_encoded"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_generated_url_is_encoded" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_special_characters">
|
||||
<code class="sig-name descname">test_special_characters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_special_characters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_special_characters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_strip_signing_parameters">
|
||||
<code class="sig-name descname">test_strip_signing_parameters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_strip_signing_parameters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_strip_signing_parameters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_connection_threading">
|
||||
<code class="sig-name descname">test_connection_threading</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_connection_threading"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_connection_threading" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_location_leading_slash">
|
||||
<code class="sig-name descname">test_location_leading_slash</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_location_leading_slash"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_location_leading_slash" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_override_class_variable">
|
||||
<code class="sig-name descname">test_override_class_variable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_override_class_variable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_override_class_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_override_init_argument">
|
||||
<code class="sig-name descname">test_override_init_argument</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/awsstorage/tests.html#S3Boto3StorageTests.test_override_init_argument"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.awsstorage.tests.S3Boto3StorageTests.test_override_init_argument" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.awsstorage.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.awsstorage.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.awsstorage.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.ingame_python.typeclasses — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.awsstorage.aws_s3_cdn — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python.typeclasses</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.awsstorage.aws_s3_cdn</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="evennia-contrib-ingame-python-typeclasses">
|
||||
<h1>evennia.contrib.ingame_python.typeclasses<a class="headerlink" href="#evennia-contrib-ingame-python-typeclasses" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="evennia-contrib-base-systems-awsstorage-aws-s3-cdn">
|
||||
<h1>evennia.contrib.base_systems.awsstorage.aws_s3_cdn<a class="headerlink" href="#evennia-contrib-base-systems-awsstorage-aws-s3-cdn" title="Permalink to this headline">¶</a></h1>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -67,7 +67,7 @@
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.ingame_python.typeclasses.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.awsstorage.aws_s3_cdn.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -83,8 +83,8 @@
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.ingame_python.typeclasses.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.ingame_python.typeclasses.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.awsstorage.aws_s3_cdn.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -101,7 +101,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python.typeclasses</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.awsstorage.aws_s3_cdn</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
120
docs/1.0-dev/api/evennia.contrib.base_systems.awsstorage.html
Normal file
120
docs/1.0-dev/api/evennia.contrib.base_systems.awsstorage.html
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.awsstorage — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.awsstorage</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.awsstorage">
|
||||
<span id="evennia-contrib-base-systems-awsstorage"></span><h1>evennia.contrib.base_systems.awsstorage<a class="headerlink" href="#module-evennia.contrib.base_systems.awsstorage" title="Permalink to this headline">¶</a></h1>
|
||||
<p>AWS storage system contrib - trhr 2020</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.awsstorage.aws_s3_cdn.html">evennia.contrib.base_systems.awsstorage.aws_s3_cdn</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.awsstorage.tests.html">evennia.contrib.base_systems.awsstorage.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.awsstorage.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.awsstorage.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.awsstorage</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,330 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.awsstorage.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.awsstorage.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.awsstorage.tests">
|
||||
<span id="evennia-contrib-base-systems-awsstorage-tests"></span><h1>evennia.contrib.base_systems.awsstorage.tests<a class="headerlink" href="#module-evennia.contrib.base_systems.awsstorage.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3TestCase">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.awsstorage.tests.</code><code class="sig-name descname">S3Boto3TestCase</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3TestCase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3TestCase" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.test.testcases.TestCase</span></code></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3TestCase.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3TestCase.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3TestCase.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.awsstorage.tests.</code><code class="sig-name descname">S3Boto3StorageTests</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3TestCase" title="evennia.contrib.base_systems.awsstorage.tests.S3Boto3TestCase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.awsstorage.tests.S3Boto3TestCase</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_clean_name">
|
||||
<code class="sig-name descname">test_clean_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_clean_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_clean_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the base case of _clean_name</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_clean_name_normalize">
|
||||
<code class="sig-name descname">test_clean_name_normalize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_clean_name_normalize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_clean_name_normalize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the normalization of _clean_name</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_clean_name_trailing_slash">
|
||||
<code class="sig-name descname">test_clean_name_trailing_slash</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_clean_name_trailing_slash"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_clean_name_trailing_slash" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the _clean_name when the path has a trailing slash</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_clean_name_windows">
|
||||
<code class="sig-name descname">test_clean_name_windows</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_clean_name_windows"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_clean_name_windows" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the _clean_name when the path has a trailing slash</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_pickle_with_bucket">
|
||||
<code class="sig-name descname">test_pickle_with_bucket</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_pickle_with_bucket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_pickle_with_bucket" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test that the storage can be pickled with a bucket attached</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_pickle_without_bucket">
|
||||
<code class="sig-name descname">test_pickle_without_bucket</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_pickle_without_bucket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_pickle_without_bucket" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test that the storage can be pickled, without a bucket instance</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_url_slashes">
|
||||
<code class="sig-name descname">test_storage_url_slashes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_url_slashes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_url_slashes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test URL generation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_save">
|
||||
<code class="sig-name descname">test_storage_save</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_save" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test saving a file</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_save_with_acl">
|
||||
<code class="sig-name descname">test_storage_save_with_acl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_save_with_acl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_save_with_acl" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test saving a file with user defined ACL.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_content_type">
|
||||
<code class="sig-name descname">test_content_type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_content_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_content_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test saving a file with a None content type.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_save_gzipped">
|
||||
<code class="sig-name descname">test_storage_save_gzipped</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_save_gzipped"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_save_gzipped" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test saving a gzipped file</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_save_gzip">
|
||||
<code class="sig-name descname">test_storage_save_gzip</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_save_gzip"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_save_gzip" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test saving a file with gzip enabled.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_save_gzip_twice">
|
||||
<code class="sig-name descname">test_storage_save_gzip_twice</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_save_gzip_twice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_save_gzip_twice" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test saving the same file content twice with gzip enabled.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_compress_content_len">
|
||||
<code class="sig-name descname">test_compress_content_len</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_compress_content_len"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_compress_content_len" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test that file returned by _compress_content() is readable.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_open_write">
|
||||
<code class="sig-name descname">test_storage_open_write</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_open_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_open_write" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test opening a file in write mode</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_open_no_write">
|
||||
<code class="sig-name descname">test_storage_open_no_write</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_open_no_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_open_no_write" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test opening file in write mode and closing without writing.</p>
|
||||
<p>A file should be created as by obj.put(…).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_open_no_overwrite_existing">
|
||||
<code class="sig-name descname">test_storage_open_no_overwrite_existing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_open_no_overwrite_existing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_open_no_overwrite_existing" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test opening an existing file in write mode and closing without writing.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_write_beyond_buffer_size">
|
||||
<code class="sig-name descname">test_storage_write_beyond_buffer_size</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_write_beyond_buffer_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_write_beyond_buffer_size" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test writing content that exceeds the buffer size</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_auto_creating_bucket">
|
||||
<code class="sig-name descname">test_auto_creating_bucket</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_auto_creating_bucket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_auto_creating_bucket" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_auto_creating_bucket_with_acl">
|
||||
<code class="sig-name descname">test_auto_creating_bucket_with_acl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_auto_creating_bucket_with_acl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_auto_creating_bucket_with_acl" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_exists">
|
||||
<code class="sig-name descname">test_storage_exists</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_exists" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_exists_false">
|
||||
<code class="sig-name descname">test_storage_exists_false</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_exists_false"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_exists_false" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_exists_doesnt_create_bucket">
|
||||
<code class="sig-name descname">test_storage_exists_doesnt_create_bucket</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_exists_doesnt_create_bucket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_exists_doesnt_create_bucket" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_delete">
|
||||
<code class="sig-name descname">test_storage_delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_listdir_base">
|
||||
<code class="sig-name descname">test_storage_listdir_base</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_listdir_base"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_listdir_base" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_listdir_subdir">
|
||||
<code class="sig-name descname">test_storage_listdir_subdir</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_listdir_subdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_listdir_subdir" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_size">
|
||||
<code class="sig-name descname">test_storage_size</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_size" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_mtime">
|
||||
<code class="sig-name descname">test_storage_mtime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_mtime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_mtime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_url">
|
||||
<code class="sig-name descname">test_storage_url</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_storage_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_storage_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_generated_url_is_encoded">
|
||||
<code class="sig-name descname">test_generated_url_is_encoded</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_generated_url_is_encoded"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_generated_url_is_encoded" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_special_characters">
|
||||
<code class="sig-name descname">test_special_characters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_special_characters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_special_characters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_strip_signing_parameters">
|
||||
<code class="sig-name descname">test_strip_signing_parameters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_strip_signing_parameters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_strip_signing_parameters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_connection_threading">
|
||||
<code class="sig-name descname">test_connection_threading</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_connection_threading"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_connection_threading" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_location_leading_slash">
|
||||
<code class="sig-name descname">test_location_leading_slash</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_location_leading_slash"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_location_leading_slash" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_override_class_variable">
|
||||
<code class="sig-name descname">test_override_class_variable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_override_class_variable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_override_class_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_override_init_argument">
|
||||
<code class="sig-name descname">test_override_init_argument</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/awsstorage/tests.html#S3Boto3StorageTests.test_override_init_argument"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.awsstorage.tests.S3Boto3StorageTests.test_override_init_argument" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.awsstorage.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.awsstorage.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.awsstorage.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.building_menu — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.building_menu.building_menu — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.building_menu</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.building_menu.building_menu</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.building_menu">
|
||||
<span id="evennia-contrib-building-menu"></span><h1>evennia.contrib.building_menu<a class="headerlink" href="#module-evennia.contrib.building_menu" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.base_systems.building_menu.building_menu">
|
||||
<span id="evennia-contrib-base-systems-building-menu-building-menu"></span><h1>evennia.contrib.base_systems.building_menu.building_menu<a class="headerlink" href="#module-evennia.contrib.base_systems.building_menu.building_menu" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Module containing the building menu system.</p>
|
||||
<p>Evennia contributor: vincent-lg 2018</p>
|
||||
<p>Building menus are in-game menus, not unlike <strong>EvMenu</strong> though using a
|
||||
|
|
@ -51,9 +51,10 @@ builders quick-editing of a given object, like a room. If you follow the
|
|||
steps below to add the contrib, you will have access to an <strong>@edit</strong> command
|
||||
that will edit any default object offering to change its key and description.</p>
|
||||
<ol class="arabic">
|
||||
<li><p>Import the <strong>GenericBuildingCmd</strong> class from this contrib in your <strong>mygame/commands/default_cmdset.py</strong> file:</p>
|
||||
<li><p>Import the <strong>GenericBuildingCmd</strong> class from this contrib in your
|
||||
<strong>mygame/commands/default_cmdset.py</strong> file:</p>
|
||||
<blockquote>
|
||||
<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">evennia.contrib.building_menu</span> <span class="kn">import</span> <span class="n">GenericBuildingCmd</span>
|
||||
<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">evennia.contrib.base_systems.building_menu</span> <span class="kn">import</span> <span class="n">GenericBuildingCmd</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div></blockquote>
|
||||
|
|
@ -99,7 +100,7 @@ change the room title by simply entering text, and go back to the
|
|||
main menu entering @ (all this is customizable). Press q to quit this menu.</p>
|
||||
<p>The first thing to do is to create a new module and place a class
|
||||
inheriting from <strong>BuildingMenu</strong> in it.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">evennia.contrib.building_menu</span> <span class="kn">import</span> <span class="n">BuildingMenu</span>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">evennia.contrib.base_systems.building_menu.building_menu</span> <span class="kn">import</span> <span class="n">BuildingMenu</span>
|
||||
|
||||
<span class="k">class</span> <span class="nc">RoomBuildingMenu</span><span class="p">(</span><span class="n">BuildingMenu</span><span class="p">):</span>
|
||||
<span class="c1"># ...</span>
|
||||
|
|
@ -154,13 +155,13 @@ then call <strong>open</strong>:</p>
|
|||
(<a class="reference external" href="https://github.com/evennia/evennia/wiki/Building-menus">https://github.com/evennia/evennia/wiki/Building-menus</a>) or read the
|
||||
heavily-documented code below.</p>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.building_menu.menu_setattr">
|
||||
<code class="sig-prename descclassname">evennia.contrib.building_menu.</code><code class="sig-name descname">menu_setattr</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">menu</span></em>, <em class="sig-param"><span class="n">choice</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#menu_setattr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.menu_setattr" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.menu_setattr">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.building_menu.building_menu.</code><code class="sig-name descname">menu_setattr</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">menu</span></em>, <em class="sig-param"><span class="n">choice</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#menu_setattr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.menu_setattr" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set the value at the specified attribute.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>menu</strong> (<a class="reference internal" href="#evennia.contrib.building_menu.BuildingMenu" title="evennia.contrib.building_menu.BuildingMenu"><em>BuildingMenu</em></a>) – the menu object.</p></li>
|
||||
<li><p><strong>menu</strong> (<a class="reference internal" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu" title="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu"><em>BuildingMenu</em></a>) – the menu object.</p></li>
|
||||
<li><p><strong>choice</strong> (<em>Chocie</em>) – the specific choice.</p></li>
|
||||
<li><p><strong>obj</strong> (<em>Object</em>) – the object to modify.</p></li>
|
||||
<li><p><strong>string</strong> (<em>str</em>) – the string with the new value.</p></li>
|
||||
|
|
@ -176,14 +177,14 @@ heavily-documented code below.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.building_menu.menu_quit">
|
||||
<code class="sig-prename descclassname">evennia.contrib.building_menu.</code><code class="sig-name descname">menu_quit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">menu</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#menu_quit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.menu_quit" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.menu_quit">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.building_menu.building_menu.</code><code class="sig-name descname">menu_quit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">menu</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#menu_quit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.menu_quit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Quit the menu, closing the CmdSet.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>caller</strong> (<em>Account</em><em> or </em><em>Object</em>) – the caller.</p></li>
|
||||
<li><p><strong>menu</strong> (<a class="reference internal" href="#evennia.contrib.building_menu.BuildingMenu" title="evennia.contrib.building_menu.BuildingMenu"><em>BuildingMenu</em></a>) – the building menu to close.</p></li>
|
||||
<li><p><strong>menu</strong> (<a class="reference internal" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu" title="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu"><em>BuildingMenu</em></a>) – the building menu to close.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
|
@ -196,14 +197,14 @@ automatically if the menu has no parent.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.building_menu.menu_edit">
|
||||
<code class="sig-prename descclassname">evennia.contrib.building_menu.</code><code class="sig-name descname">menu_edit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">choice</span></em>, <em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#menu_edit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.menu_edit" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.menu_edit">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.building_menu.building_menu.</code><code class="sig-name descname">menu_edit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">choice</span></em>, <em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#menu_edit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.menu_edit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Open the EvEditor to edit a specified attribute.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>caller</strong> (<em>Account</em><em> or </em><em>Object</em>) – the caller.</p></li>
|
||||
<li><p><strong>choice</strong> (<a class="reference internal" href="#evennia.contrib.building_menu.Choice" title="evennia.contrib.building_menu.Choice"><em>Choice</em></a>) – the choice object.</p></li>
|
||||
<li><p><strong>choice</strong> (<a class="reference internal" href="#evennia.contrib.base_systems.building_menu.building_menu.Choice" title="evennia.contrib.base_systems.building_menu.building_menu.Choice"><em>Choice</em></a>) – the choice object.</p></li>
|
||||
<li><p><strong>obj</strong> (<em>Object</em>) – the object to edit.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
|
@ -211,143 +212,143 @@ automatically if the menu has no parent.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoInput">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.building_menu.</code><code class="sig-name descname">CmdNoInput</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#CmdNoInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoInput" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.building_menu.building_menu.</code><code class="sig-name descname">CmdNoInput</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#CmdNoInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>No input has been found.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoInput.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '__noinput_command'</em><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoInput.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '__noinput_command'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoInput.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoInput.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoInput.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#CmdNoInput.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoInput.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#CmdNoInput.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The lockhandler works the same as for objects.
|
||||
optional kwargs will be set as properties on the Command at runtime,
|
||||
overloading evential same-named class properties.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoInput.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#CmdNoInput.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoInput.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#CmdNoInput.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Display the menu or choice text.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoInput.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoInput.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoInput.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoInput.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoInput.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoInput.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoInput.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' ', 'tags': '', 'text': 'No input has been found.'}</em><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoInput.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' ', 'tags': '', 'text': 'No input has been found.'}</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoInput.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoMatch">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.building_menu.</code><code class="sig-name descname">CmdNoMatch</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#CmdNoMatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoMatch" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.building_menu.building_menu.</code><code class="sig-name descname">CmdNoMatch</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#CmdNoMatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>No input has been found.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoMatch.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '__nomatch_command'</em><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoMatch.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '__nomatch_command'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoMatch.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoMatch.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoMatch.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#CmdNoMatch.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoMatch.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#CmdNoMatch.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The lockhandler works the same as for objects.
|
||||
optional kwargs will be set as properties on the Command at runtime,
|
||||
overloading evential same-named class properties.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoMatch.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#CmdNoMatch.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoMatch.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#CmdNoMatch.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Call the proper menu or redirect to nomatch.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoMatch.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoMatch.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoMatch.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoMatch.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoMatch.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoMatch.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.CmdNoMatch.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': '__nomatch_command', 'no_prefix': ' ', 'tags': '', 'text': 'No input has been found.'}</em><a class="headerlink" href="#evennia.contrib.building_menu.CmdNoMatch.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': '__nomatch_command', 'no_prefix': ' ', 'tags': '', 'text': 'No input has been found.'}</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenuCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.building_menu.</code><code class="sig-name descname">BuildingMenuCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenuCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenuCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenuCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.building_menu.building_menu.</code><code class="sig-name descname">BuildingMenuCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenuCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenuCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
|
||||
<p>Building menu CmdSet.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenuCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'building_menu'</em><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenuCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenuCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'building_menu'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenuCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenuCmdSet.priority">
|
||||
<code class="sig-name descname">priority</code><em class="property"> = 5</em><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenuCmdSet.priority" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenuCmdSet.priority">
|
||||
<code class="sig-name descname">priority</code><em class="property"> = 5</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenuCmdSet.priority" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenuCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenuCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenuCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenuCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenuCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenuCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Populates the cmdset with commands.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenuCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.building_menu.BuildingMenuCmdSet'</em><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenuCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenuCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.base_systems.building_menu.building_menu.BuildingMenuCmdSet'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenuCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.building_menu.Choice">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.building_menu.</code><code class="sig-name descname">Choice</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">title</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">aliases</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">attr</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">text</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">glance</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_enter</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_nomatch</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_leave</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">menu</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#Choice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.Choice" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.Choice">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.building_menu.building_menu.</code><code class="sig-name descname">Choice</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">title</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">aliases</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">attr</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">text</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">glance</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_enter</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_nomatch</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_leave</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">menu</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#Choice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.Choice" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>A choice object, created by <strong>add_choice</strong>.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.Choice.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">title</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">aliases</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">attr</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">text</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">glance</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_enter</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_nomatch</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_leave</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">menu</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#Choice.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.Choice.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.Choice.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">title</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">aliases</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">attr</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">text</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">glance</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_enter</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_nomatch</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_leave</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">menu</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#Choice.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.Choice.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Constructor.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -363,7 +364,7 @@ choice. It can be a callable.</p></li>
|
|||
sub-menu shown in the main menu. It can be set to
|
||||
display the current value of the attribute in the
|
||||
main menu itself.</p></li>
|
||||
<li><p><strong>menu</strong> (<a class="reference internal" href="#evennia.contrib.building_menu.BuildingMenu" title="evennia.contrib.building_menu.BuildingMenu"><em>BuildingMenu</em></a><em>, </em><em>optional</em>) – the parent building menu.</p></li>
|
||||
<li><p><strong>menu</strong> (<a class="reference internal" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu" title="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu"><em>BuildingMenu</em></a><em>, </em><em>optional</em>) – the parent building menu.</p></li>
|
||||
<li><p><strong>on_enter</strong> (<em>callable</em><em>, </em><em>optional</em>) – a callable to call when the
|
||||
caller enters into the choice.</p></li>
|
||||
<li><p><strong>on_nomatch</strong> (<em>callable</em><em>, </em><em>optional</em>) – a callable to call when no
|
||||
|
|
@ -378,20 +379,20 @@ leaves the choice.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.Choice.keys">
|
||||
<em class="property">property </em><code class="sig-name descname">keys</code><a class="headerlink" href="#evennia.contrib.building_menu.Choice.keys" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.Choice.keys">
|
||||
<em class="property">property </em><code class="sig-name descname">keys</code><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.Choice.keys" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return a tuple of keys separated by <strong>sep_keys</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.Choice.format_text">
|
||||
<code class="sig-name descname">format_text</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#Choice.format_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.Choice.format_text" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.Choice.format_text">
|
||||
<code class="sig-name descname">format_text</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#Choice.format_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.Choice.format_text" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Format the choice text and return it, or an empty string.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.Choice.enter">
|
||||
<code class="sig-name descname">enter</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#Choice.enter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.Choice.enter" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.Choice.enter">
|
||||
<code class="sig-name descname">enter</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#Choice.enter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.Choice.enter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when the user opens the choice.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -401,8 +402,8 @@ leaves the choice.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.Choice.nomatch">
|
||||
<code class="sig-name descname">nomatch</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#Choice.nomatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.Choice.nomatch" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.Choice.nomatch">
|
||||
<code class="sig-name descname">nomatch</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#Choice.nomatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.Choice.nomatch" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when the user entered something in the choice.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -417,8 +418,8 @@ then the choice or menu is displayed.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.Choice.leave">
|
||||
<code class="sig-name descname">leave</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#Choice.leave"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.Choice.leave" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.Choice.leave">
|
||||
<code class="sig-name descname">leave</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#Choice.leave"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.Choice.leave" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when the user closes the choice.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -430,8 +431,8 @@ then the choice or menu is displayed.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.building_menu.</code><code class="sig-name descname">BuildingMenu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">title</span><span class="o">=</span><span class="default_value">'Building menu: {obj}'</span></em>, <em class="sig-param"><span class="n">keys</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parents</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.building_menu.building_menu.</code><code class="sig-name descname">BuildingMenu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">title</span><span class="o">=</span><span class="default_value">'Building menu: {obj}'</span></em>, <em class="sig-param"><span class="n">keys</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parents</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Class allowing to create and set building menus to edit specific objects.</p>
|
||||
<p>A building menu is somewhat similar to <strong>EvMenu</strong>, but designed to edit
|
||||
|
|
@ -448,28 +449,28 @@ methods). Some helper functions are defined at the top of this
|
|||
module in order to be used as arguments to <strong>add_choice</strong>
|
||||
in frequent cases.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.keys_go_back">
|
||||
<code class="sig-name descname">keys_go_back</code><em class="property"> = ['@']</em><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.keys_go_back" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.keys_go_back">
|
||||
<code class="sig-name descname">keys_go_back</code><em class="property"> = ['@']</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.keys_go_back" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.sep_keys">
|
||||
<code class="sig-name descname">sep_keys</code><em class="property"> = '.'</em><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.sep_keys" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.sep_keys">
|
||||
<code class="sig-name descname">sep_keys</code><em class="property"> = '.'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.sep_keys" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.joker_key">
|
||||
<code class="sig-name descname">joker_key</code><em class="property"> = '*'</em><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.joker_key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.joker_key">
|
||||
<code class="sig-name descname">joker_key</code><em class="property"> = '*'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.joker_key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.min_shortcut">
|
||||
<code class="sig-name descname">min_shortcut</code><em class="property"> = 1</em><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.min_shortcut" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.min_shortcut">
|
||||
<code class="sig-name descname">min_shortcut</code><em class="property"> = 1</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.min_shortcut" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">title</span><span class="o">=</span><span class="default_value">'Building menu: {obj}'</span></em>, <em class="sig-param"><span class="n">keys</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parents</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">title</span><span class="o">=</span><span class="default_value">'Building menu: {obj}'</span></em>, <em class="sig-param"><span class="n">keys</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parents</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Constructor, you shouldn’t override. See <strong>init</strong> instead.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -505,8 +506,8 @@ override <strong>__init__</strong>. For instance:</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.current_choice">
|
||||
<em class="property">property </em><code class="sig-name descname">current_choice</code><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.current_choice" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.current_choice">
|
||||
<em class="property">property </em><code class="sig-name descname">current_choice</code><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.current_choice" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the current choice or None.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -522,8 +523,8 @@ keys that should match a choice to be usable.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.relevant_choices">
|
||||
<em class="property">property </em><code class="sig-name descname">relevant_choices</code><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.relevant_choices" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.relevant_choices">
|
||||
<em class="property">property </em><code class="sig-name descname">relevant_choices</code><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.relevant_choices" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Only return the relevant choices according to the current meny key.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -539,8 +540,8 @@ keys that should match a choice to be usable.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.init">
|
||||
<code class="sig-name descname">init</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu.init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.init" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.init">
|
||||
<code class="sig-name descname">init</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu.init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.init" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create the sub-menu to edit the specified object.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -555,8 +556,8 @@ Use <strong>add_choice</strong> and its variants to create menu choices.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.add_choice">
|
||||
<code class="sig-name descname">add_choice</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">title</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">aliases</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">attr</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">text</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">glance</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_enter</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_nomatch</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_leave</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu.add_choice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.add_choice" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.add_choice">
|
||||
<code class="sig-name descname">add_choice</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">title</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">aliases</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">attr</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">text</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">glance</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_enter</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_nomatch</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_leave</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu.add_choice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.add_choice" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add a choice, a valid sub-menu, in the current builder menu.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -621,8 +622,8 @@ arguments have to be present). For more information, see
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.add_choice_edit">
|
||||
<code class="sig-name descname">add_choice_edit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">title</span><span class="o">=</span><span class="default_value">'description'</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">'d'</span></em>, <em class="sig-param"><span class="n">aliases</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">attr</span><span class="o">=</span><span class="default_value">'db.desc'</span></em>, <em class="sig-param"><span class="n">glance</span><span class="o">=</span><span class="default_value">'\n {obj.db.desc}'</span></em>, <em class="sig-param"><span class="n">on_enter</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu.add_choice_edit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.add_choice_edit" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.add_choice_edit">
|
||||
<code class="sig-name descname">add_choice_edit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">title</span><span class="o">=</span><span class="default_value">'description'</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">'d'</span></em>, <em class="sig-param"><span class="n">aliases</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">attr</span><span class="o">=</span><span class="default_value">'db.desc'</span></em>, <em class="sig-param"><span class="n">glance</span><span class="o">=</span><span class="default_value">'\n {obj.db.desc}'</span></em>, <em class="sig-param"><span class="n">on_enter</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu.add_choice_edit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.add_choice_edit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add a simple choice to edit a given attribute in the EvEditor.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -650,8 +651,8 @@ will be re-opened.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.add_choice_quit">
|
||||
<code class="sig-name descname">add_choice_quit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">title</span><span class="o">=</span><span class="default_value">'quit the menu'</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">'q'</span></em>, <em class="sig-param"><span class="n">aliases</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_enter</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu.add_choice_quit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.add_choice_quit" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.add_choice_quit">
|
||||
<code class="sig-name descname">add_choice_quit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">title</span><span class="o">=</span><span class="default_value">'quit the menu'</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">'q'</span></em>, <em class="sig-param"><span class="n">aliases</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">on_enter</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu.add_choice_quit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.add_choice_quit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add a simple choice just to quit the building menu.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -675,8 +676,8 @@ another callable instead, make sure to do the same.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.open">
|
||||
<code class="sig-name descname">open</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu.open"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.open" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.open">
|
||||
<code class="sig-name descname">open</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu.open"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.open" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Open the building menu for the caller.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
|
|
@ -688,8 +689,8 @@ reloads/restarts, assuming <strong>persistent</strong> is set to <strong>True</s
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.open_parent_menu">
|
||||
<code class="sig-name descname">open_parent_menu</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu.open_parent_menu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.open_parent_menu" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.open_parent_menu">
|
||||
<code class="sig-name descname">open_parent_menu</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu.open_parent_menu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.open_parent_menu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Open the parent menu, using <strong>self.parents</strong>.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
|
|
@ -700,8 +701,8 @@ since the caller can go back to the parent menu using the
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.open_submenu">
|
||||
<code class="sig-name descname">open_submenu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">submenu_class</span></em>, <em class="sig-param"><span class="n">submenu_obj</span></em>, <em class="sig-param"><span class="n">parent_keys</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu.open_submenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.open_submenu" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.open_submenu">
|
||||
<code class="sig-name descname">open_submenu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">submenu_class</span></em>, <em class="sig-param"><span class="n">submenu_obj</span></em>, <em class="sig-param"><span class="n">parent_keys</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu.open_submenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.open_submenu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Open a sub-menu, closing the current menu and opening the new one.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -728,8 +729,8 @@ should be opened when the user leaves the submenu.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.move">
|
||||
<code class="sig-name descname">move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">back</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">quiet</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">string</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu.move"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.move" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.move">
|
||||
<code class="sig-name descname">move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">back</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">quiet</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">string</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu.move"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.move" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Move inside the menu.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -758,37 +759,37 @@ If that’s the case, you will need to use this method.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.close">
|
||||
<code class="sig-name descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.close" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.close">
|
||||
<code class="sig-name descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.close" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Close the building menu, removing the CmdSet.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.display_title">
|
||||
<code class="sig-name descname">display_title</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu.display_title"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.display_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.display_title">
|
||||
<code class="sig-name descname">display_title</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu.display_title"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.display_title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the menu title to be displayed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.display_choice">
|
||||
<code class="sig-name descname">display_choice</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">choice</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu.display_choice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.display_choice" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.display_choice">
|
||||
<code class="sig-name descname">display_choice</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">choice</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu.display_choice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.display_choice" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Display the specified choice.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>choice</strong> (<a class="reference internal" href="#evennia.contrib.building_menu.Choice" title="evennia.contrib.building_menu.Choice"><em>Choice</em></a>) – the menu choice.</p>
|
||||
<dd class="field-odd"><p><strong>choice</strong> (<a class="reference internal" href="#evennia.contrib.base_systems.building_menu.building_menu.Choice" title="evennia.contrib.base_systems.building_menu.building_menu.Choice"><em>Choice</em></a>) – the menu choice.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.display">
|
||||
<code class="sig-name descname">display</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu.display"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.display" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.display">
|
||||
<code class="sig-name descname">display</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu.display"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.display" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Display the entire menu or a single choice, depending on the keys.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.BuildingMenu.restore">
|
||||
<em class="property">static </em><code class="sig-name descname">restore</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#BuildingMenu.restore"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.BuildingMenu.restore" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.restore">
|
||||
<em class="property">static </em><code class="sig-name descname">restore</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#BuildingMenu.restore"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu.restore" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Restore the building menu for the caller.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -805,16 +806,16 @@ saved in the caller, but the object itself cannot be found.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.building_menu.GenericBuildingMenu">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.building_menu.</code><code class="sig-name descname">GenericBuildingMenu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">title</span><span class="o">=</span><span class="default_value">'Building menu: {obj}'</span></em>, <em class="sig-param"><span class="n">keys</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parents</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#GenericBuildingMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.GenericBuildingMenu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.building_menu.BuildingMenu" title="evennia.contrib.building_menu.BuildingMenu"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.building_menu.BuildingMenu</span></code></a></p>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingMenu">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.building_menu.building_menu.</code><code class="sig-name descname">GenericBuildingMenu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">title</span><span class="o">=</span><span class="default_value">'Building menu: {obj}'</span></em>, <em class="sig-param"><span class="n">keys</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parents</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#GenericBuildingMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingMenu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu" title="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu</span></code></a></p>
|
||||
<p>A generic building menu, allowing to edit any object.</p>
|
||||
<p>This is more a demonstration menu. By default, it allows to edit the
|
||||
object key and description. Nevertheless, it will be useful to demonstrate
|
||||
how building menus are meant to be used.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.GenericBuildingMenu.init">
|
||||
<code class="sig-name descname">init</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#GenericBuildingMenu.init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.GenericBuildingMenu.init" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingMenu.init">
|
||||
<code class="sig-name descname">init</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#GenericBuildingMenu.init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingMenu.init" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Build the meny, adding the ‘key’ and ‘description’ choices.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -831,8 +832,8 @@ call <strong>add_choice_quit</strong> to add this choice with different options.
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.building_menu.GenericBuildingCmd">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.building_menu.</code><code class="sig-name descname">GenericBuildingCmd</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#GenericBuildingCmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.GenericBuildingCmd" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingCmd">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.building_menu.building_menu.</code><code class="sig-name descname">GenericBuildingCmd</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#GenericBuildingCmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingCmd" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Generic building command.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -846,13 +847,13 @@ change the object’s key and description.</p>
|
|||
@edit self
|
||||
@edit #142</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.GenericBuildingCmd.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@edit'</em><a class="headerlink" href="#evennia.contrib.building_menu.GenericBuildingCmd.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingCmd.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@edit'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingCmd.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.building_menu.GenericBuildingCmd.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/building_menu.html#GenericBuildingCmd.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.building_menu.GenericBuildingCmd.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingCmd.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/building_menu.html#GenericBuildingCmd.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingCmd.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is the actual executing part of the command. It is
|
||||
called directly after self.parse(). See the docstring of this
|
||||
module for which object properties are available (beyond those
|
||||
|
|
@ -860,23 +861,23 @@ set in self.parse())</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.GenericBuildingCmd.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.building_menu.GenericBuildingCmd.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingCmd.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingCmd.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.GenericBuildingCmd.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.building_menu.GenericBuildingCmd.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingCmd.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingCmd.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.GenericBuildingCmd.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.building_menu.GenericBuildingCmd.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingCmd.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingCmd.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.building_menu.GenericBuildingCmd.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': '@edit', 'no_prefix': 'edit ', 'tags': '', 'text': "\n Generic building command.\n\n Syntax:\n @edit [object]\n\n Open a building menu to edit the specified object. This menu allows to\n change the object's key and description.\n\n Examples:\n @edit here\n @edit self\n @edit #142\n\n "}</em><a class="headerlink" href="#evennia.contrib.building_menu.GenericBuildingCmd.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingCmd.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': '@edit', 'no_prefix': 'edit ', 'tags': '', 'text': "\n Generic building command.\n\n Syntax:\n @edit [object]\n\n Open a building menu to edit the specified object. This menu allows to\n change the object's key and description.\n\n Examples:\n @edit here\n @edit self\n @edit #142\n\n "}</em><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.building_menu.GenericBuildingCmd.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -906,7 +907,7 @@ set in self.parse())</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.building_menu.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.building_menu.building_menu.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -922,8 +923,8 @@ set in self.parse())</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.building_menu.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.building_menu.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.building_menu.building_menu.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -940,7 +941,7 @@ set in self.parse())</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.building_menu</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.building_menu.building_menu</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
120
docs/1.0-dev/api/evennia.contrib.base_systems.building_menu.html
Normal file
120
docs/1.0-dev/api/evennia.contrib.base_systems.building_menu.html
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.building_menu — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.building_menu</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.building_menu">
|
||||
<span id="evennia-contrib-base-systems-building-menu"></span><h1>evennia.contrib.base_systems.building_menu<a class="headerlink" href="#module-evennia.contrib.base_systems.building_menu" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Build-menu contrib - vincent-lg 2018</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.building_menu.building_menu.html">evennia.contrib.base_systems.building_menu.building_menu</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.building_menu.tests.html">evennia.contrib.base_systems.building_menu.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.building_menu.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.building_menu.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.building_menu</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,184 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.building_menu.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.building_menu.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.building_menu.tests">
|
||||
<span id="evennia-contrib-base-systems-building-menu-tests"></span><h1>evennia.contrib.base_systems.building_menu.tests<a class="headerlink" href="#module-evennia.contrib.base_systems.building_menu.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Building menu tests.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.building_menu.tests.Submenu">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.building_menu.tests.</code><code class="sig-name descname">Submenu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">title</span><span class="o">=</span><span class="default_value">'Building menu: {obj}'</span></em>, <em class="sig-param"><span class="n">keys</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parents</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#Submenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.Submenu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.base_systems.building_menu.building_menu.html#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu" title="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.building_menu.tests.Submenu.init">
|
||||
<code class="sig-name descname">init</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">exit</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#Submenu.init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.Submenu.init" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create the sub-menu to edit the specified object.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>obj</strong> (<em>Object</em>) – the object to edit.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This method is probably to be overridden in your subclasses.
|
||||
Use <strong>add_choice</strong> and its variants to create menu choices.</p>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.building_menu.tests.</code><code class="sig-name descname">TestBuildingMenu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_quit">
|
||||
<code class="sig-name descname">test_quit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu.test_quit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_quit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Try to quit the building menu.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_setattr">
|
||||
<code class="sig-name descname">test_setattr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu.test_setattr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_setattr" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the simple setattr provided by building menus.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_add_choice_without_key">
|
||||
<code class="sig-name descname">test_add_choice_without_key</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu.test_add_choice_without_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_add_choice_without_key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Try to add choices without keys.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_callbacks">
|
||||
<code class="sig-name descname">test_callbacks</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu.test_callbacks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_callbacks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test callbacks in menus.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_multi_level">
|
||||
<code class="sig-name descname">test_multi_level</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu.test_multi_level"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_multi_level" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test multi-level choices.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_submenu">
|
||||
<code class="sig-name descname">test_submenu</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu.test_submenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_submenu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test to add sub-menus.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.building_menu.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.building_menu.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.building_menu.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.color_markups — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.color_markups.color_markups — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.color_markups</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.color_markups.color_markups</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.color_markups">
|
||||
<span id="evennia-contrib-color-markups"></span><h1>evennia.contrib.color_markups<a class="headerlink" href="#module-evennia.contrib.color_markups" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.base_systems.color_markups.color_markups">
|
||||
<span id="evennia-contrib-base-systems-color-markups-color-markups"></span><h1>evennia.contrib.base_systems.color_markups.color_markups<a class="headerlink" href="#module-evennia.contrib.base_systems.color_markups.color_markups" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Color markups</p>
|
||||
<p>Contribution, Griatch 2017</p>
|
||||
<p>Additional color markup styles for Evennia (extending or replacing the default <a href="#id1"><span class="problematic" id="id2">|</span></a>r, <a href="#id3"><span class="problematic" id="id4">|</span></a>234 etc).</p>
|
||||
|
|
@ -68,7 +68,7 @@ COLOR_ANSI_BRIGHT_BG_EXTRA_MAP = ANSI does not support bright backgrounds; we fa
|
|||
</div></blockquote>
|
||||
<p>To add the {- “curly-bracket” style, add the following to your settings file, then reboot both
|
||||
Server and Portal:</p>
|
||||
<p>from evennia.contrib import color_markups
|
||||
<p>from evennia.contrib.base_systems import color_markups
|
||||
COLOR_ANSI_EXTRA_MAP = color_markups.CURLY_COLOR_ANSI_EXTRA_MAP
|
||||
COLOR_XTERM256_EXTRA_FG = color_markups.CURLY_COLOR_XTERM256_EXTRA_FG
|
||||
COLOR_XTERM256_EXTRA_BG = color_markups.CURLY_COLOR_XTERM256_EXTRA_BG
|
||||
|
|
@ -77,7 +77,7 @@ COLOR_XTERM256_EXTRA_GBG = color_markups.CURLY_COLOR_XTERM256_EXTRA_GBG
|
|||
COLOR_ANSI_BRIGHT_BG_EXTRA_MAP = color_markups.CURLY_COLOR_ANSI_BRIGHT_BG_EXTRA_MAP</p>
|
||||
<p>To add the %c- “mux/mush” style, add the following to your settings file, then reboot both Server
|
||||
and Portal:</p>
|
||||
<p>from evennia.contrib import color_markups
|
||||
<p>from evennia.contrib.base_systems import color_markups
|
||||
COLOR_ANSI_EXTRA_MAP = color_markups.MUX_COLOR_ANSI_EXTRA_MAP
|
||||
COLOR_XTERM256_EXTRA_FG = color_markups.MUX_COLOR_XTERM256_EXTRA_FG
|
||||
COLOR_XTERM256_EXTRA_BG = color_markups.MUX_COLOR_XTERM256_EXTRA_BG
|
||||
|
|
@ -109,7 +109,7 @@ COLOR_ANSI_BRIGHT_BGS_EXTRA_MAP = color_markups.CURLY_COLOR_ANSI_BRIGHT_BGS_EXTR
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.color_markups.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.color_markups.color_markups.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -125,8 +125,8 @@ COLOR_ANSI_BRIGHT_BGS_EXTRA_MAP = color_markups.CURLY_COLOR_ANSI_BRIGHT_BGS_EXTR
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.color_markups.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.color_markups.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.color_markups.color_markups.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -143,7 +143,7 @@ COLOR_ANSI_BRIGHT_BGS_EXTRA_MAP = color_markups.CURLY_COLOR_ANSI_BRIGHT_BGS_EXTR
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.color_markups</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.color_markups.color_markups</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
120
docs/1.0-dev/api/evennia.contrib.base_systems.color_markups.html
Normal file
120
docs/1.0-dev/api/evennia.contrib.base_systems.color_markups.html
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.color_markups — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.color_markups</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.color_markups">
|
||||
<span id="evennia-contrib-base-systems-color-markups"></span><h1>evennia.contrib.base_systems.color_markups<a class="headerlink" href="#module-evennia.contrib.base_systems.color_markups" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Color markups contrib - Griatch 2017</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.color_markups.color_markups.html">evennia.contrib.base_systems.color_markups.color_markups</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.color_markups.tests.html">evennia.contrib.base_systems.color_markups.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.color_markups.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.color_markups.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.color_markups</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,135 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.color_markups.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.color_markups.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.color_markups.tests">
|
||||
<span id="evennia-contrib-base-systems-color-markups-tests"></span><h1>evennia.contrib.base_systems.color_markups.tests<a class="headerlink" href="#module-evennia.contrib.base_systems.color_markups.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Test Color markup.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.color_markups.tests.TestColorMarkup">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.color_markups.tests.</code><code class="sig-name descname">TestColorMarkup</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/color_markups/tests.html#TestColorMarkup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.color_markups.tests.TestColorMarkup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
|
||||
<p>Note: Normally this would be tested by importing the ansi parser and run
|
||||
the mappings through it. This is not possible since the ansi module creates
|
||||
its mapping at the module/class level; since the ansi module is used by so
|
||||
many other modules it appears that trying to overload
|
||||
settings to test it causes issues with unrelated tests.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.color_markups.tests.TestColorMarkup.test_curly_markup">
|
||||
<code class="sig-name descname">test_curly_markup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/color_markups/tests.html#TestColorMarkup.test_curly_markup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.color_markups.tests.TestColorMarkup.test_curly_markup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.color_markups.tests.TestColorMarkup.test_mux_markup">
|
||||
<code class="sig-name descname">test_mux_markup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/color_markups/tests.html#TestColorMarkup.test_mux_markup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.color_markups.tests.TestColorMarkup.test_mux_markup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.color_markups.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.color_markups.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.color_markups.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.custom_gametime — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.custom_gametime.custom_gametime — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.custom_gametime</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.custom_gametime.custom_gametime</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.custom_gametime">
|
||||
<span id="evennia-contrib-custom-gametime"></span><h1>evennia.contrib.custom_gametime<a class="headerlink" href="#module-evennia.contrib.custom_gametime" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.base_systems.custom_gametime.custom_gametime">
|
||||
<span id="evennia-contrib-base-systems-custom-gametime-custom-gametime"></span><h1>evennia.contrib.base_systems.custom_gametime.custom_gametime<a class="headerlink" href="#module-evennia.contrib.base_systems.custom_gametime.custom_gametime" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Custom gametime</p>
|
||||
<p>Contrib - Griatch 2017, vlgeoff 2017</p>
|
||||
<p>This implements the evennia.utils.gametime module but supporting
|
||||
|
|
@ -71,8 +71,8 @@ unit. Here’s the default as an example:</p>
|
|||
<p>When using a custom calendar, these time unit names are used as kwargs to
|
||||
the converter functions in this module.</p>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.custom_gametime.time_to_tuple">
|
||||
<code class="sig-prename descclassname">evennia.contrib.custom_gametime.</code><code class="sig-name descname">time_to_tuple</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">seconds</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">divisors</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/custom_gametime.html#time_to_tuple"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.custom_gametime.time_to_tuple" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.custom_gametime.time_to_tuple">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.custom_gametime.custom_gametime.</code><code class="sig-name descname">time_to_tuple</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">seconds</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">divisors</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/custom_gametime.html#time_to_tuple"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.custom_gametime.time_to_tuple" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Helper function. Creates a tuple of even dividends given a range
|
||||
of divisors.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -98,8 +98,8 @@ divided by the supplied dividends.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.custom_gametime.gametime_to_realtime">
|
||||
<code class="sig-prename descclassname">evennia.contrib.custom_gametime.</code><code class="sig-name descname">gametime_to_realtime</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">format</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/custom_gametime.html#gametime_to_realtime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.custom_gametime.gametime_to_realtime" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.custom_gametime.gametime_to_realtime">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.custom_gametime.custom_gametime.</code><code class="sig-name descname">gametime_to_realtime</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">format</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/custom_gametime.html#gametime_to_realtime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.custom_gametime.gametime_to_realtime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This method helps to figure out the real-world time it will take until an
|
||||
in-game time has passed. E.g. if an event should take place a month later
|
||||
in-game, you will be able to find the number of real-world seconds this
|
||||
|
|
@ -129,8 +129,8 @@ match the <strong>settings.TIME_UNITS</strong> dict keys.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.custom_gametime.realtime_to_gametime">
|
||||
<code class="sig-prename descclassname">evennia.contrib.custom_gametime.</code><code class="sig-name descname">realtime_to_gametime</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">secs</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">mins</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">hrs</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">days</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">weeks</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">months</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">yrs</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">format</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/custom_gametime.html#realtime_to_gametime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.custom_gametime.realtime_to_gametime" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.custom_gametime.realtime_to_gametime">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.custom_gametime.custom_gametime.</code><code class="sig-name descname">realtime_to_gametime</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">secs</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">mins</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">hrs</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">days</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">weeks</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">months</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">yrs</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">format</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/custom_gametime.html#realtime_to_gametime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.custom_gametime.realtime_to_gametime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This method calculates how much in-game time a real-world time
|
||||
interval would correspond to. This is usually a lot less
|
||||
interesting than the other way around.</p>
|
||||
|
|
@ -167,8 +167,8 @@ interesting than the other way around.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.custom_gametime.custom_gametime">
|
||||
<code class="sig-prename descclassname">evennia.contrib.custom_gametime.</code><code class="sig-name descname">custom_gametime</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">absolute</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/custom_gametime.html#custom_gametime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.custom_gametime.custom_gametime" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.custom_gametime.custom_gametime">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.custom_gametime.custom_gametime.</code><code class="sig-name descname">custom_gametime</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">absolute</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/custom_gametime.html#custom_gametime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.custom_gametime.custom_gametime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the custom game time as a tuple of units, as defined in settings.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -184,8 +184,8 @@ week, day, hour, minute, second).</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.custom_gametime.real_seconds_until">
|
||||
<code class="sig-prename descclassname">evennia.contrib.custom_gametime.</code><code class="sig-name descname">real_seconds_until</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/custom_gametime.html#real_seconds_until"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.custom_gametime.real_seconds_until" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.custom_gametime.real_seconds_until">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.custom_gametime.custom_gametime.</code><code class="sig-name descname">real_seconds_until</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/custom_gametime.html#real_seconds_until"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.custom_gametime.real_seconds_until" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the real seconds until game time.</p>
|
||||
<p>If the game time is 5:00, TIME_FACTOR is set to 2 and you ask
|
||||
the number of seconds until it’s 5:10, then this function should
|
||||
|
|
@ -207,8 +207,8 @@ return 300 (5 minutes).</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.custom_gametime.schedule">
|
||||
<code class="sig-prename descclassname">evennia.contrib.custom_gametime.</code><code class="sig-name descname">schedule</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback</span></em>, <em class="sig-param"><span class="n">repeat</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/custom_gametime.html#schedule"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.custom_gametime.schedule" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.custom_gametime.schedule">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.custom_gametime.custom_gametime.</code><code class="sig-name descname">schedule</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback</span></em>, <em class="sig-param"><span class="n">repeat</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/custom_gametime.html#schedule"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.custom_gametime.schedule" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Call the callback when the game time is up.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -241,42 +241,42 @@ The time is given in units as keyword arguments.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.custom_gametime.GametimeScript">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.custom_gametime.</code><code class="sig-name descname">GametimeScript</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/custom_gametime.html#GametimeScript"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.custom_gametime.GametimeScript" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.custom_gametime.custom_gametime.</code><code class="sig-name descname">GametimeScript</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/custom_gametime.html#GametimeScript"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript" title="evennia.scripts.scripts.DefaultScript"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript</span></code></a></p>
|
||||
<p>Gametime-sensitive script.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.custom_gametime.GametimeScript.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/custom_gametime.html#GametimeScript.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.custom_gametime.GametimeScript.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/custom_gametime.html#GametimeScript.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The script is created.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.custom_gametime.GametimeScript.at_repeat">
|
||||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/custom_gametime.html#GametimeScript.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.custom_gametime.GametimeScript.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript.at_repeat">
|
||||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/custom_gametime.html#GametimeScript.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Call the callback and reset interval.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.custom_gametime.GametimeScript.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.custom_gametime.GametimeScript.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.DoesNotExist" title="evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.custom_gametime.GametimeScript.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.custom_gametime.GametimeScript.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.custom_gametime.GametimeScript.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.custom_gametime.GametimeScript'</em><a class="headerlink" href="#evennia.contrib.custom_gametime.GametimeScript.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript'</em><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.custom_gametime.GametimeScript.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'GametimeScript'</em><a class="headerlink" href="#evennia.contrib.custom_gametime.GametimeScript.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'GametimeScript'</em><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.custom_gametime.GametimeScript.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -306,7 +306,7 @@ The time is given in units as keyword arguments.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.custom_gametime.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.custom_gametime.custom_gametime.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -322,8 +322,8 @@ The time is given in units as keyword arguments.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.custom_gametime.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.custom_gametime.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.custom_gametime.custom_gametime.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -340,7 +340,7 @@ The time is given in units as keyword arguments.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.custom_gametime</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.custom_gametime.custom_gametime</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,120 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.custom_gametime — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.custom_gametime</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.custom_gametime">
|
||||
<span id="evennia-contrib-base-systems-custom-gametime"></span><h1>evennia.contrib.base_systems.custom_gametime<a class="headerlink" href="#module-evennia.contrib.base_systems.custom_gametime" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Custom gametime contrib - Griatch, vlgeoff 2017</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.custom_gametime.custom_gametime.html">evennia.contrib.base_systems.custom_gametime.custom_gametime</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.custom_gametime.tests.html">evennia.contrib.base_systems.custom_gametime.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.custom_gametime.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.custom_gametime.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.custom_gametime</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,156 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.custom_gametime.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.custom_gametime.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.custom_gametime.tests">
|
||||
<span id="evennia-contrib-base-systems-custom-gametime-tests"></span><h1>evennia.contrib.base_systems.custom_gametime.tests<a class="headerlink" href="#module-evennia.contrib.base_systems.custom_gametime.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Testing custom game time</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.custom_gametime.tests.</code><code class="sig-name descname">TestCustomGameTime</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/tests.html#TestCustomGameTime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/tests.html#TestCustomGameTime.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.test_time_to_tuple">
|
||||
<code class="sig-name descname">test_time_to_tuple</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/tests.html#TestCustomGameTime.test_time_to_tuple"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.test_time_to_tuple" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.test_gametime_to_realtime">
|
||||
<code class="sig-name descname">test_gametime_to_realtime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/tests.html#TestCustomGameTime.test_gametime_to_realtime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.test_gametime_to_realtime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.test_realtime_to_gametime">
|
||||
<code class="sig-name descname">test_realtime_to_gametime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/tests.html#TestCustomGameTime.test_realtime_to_gametime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.test_realtime_to_gametime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.test_custom_gametime">
|
||||
<code class="sig-name descname">test_custom_gametime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/tests.html#TestCustomGameTime.test_custom_gametime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.test_custom_gametime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.test_real_seconds_until">
|
||||
<code class="sig-name descname">test_real_seconds_until</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/tests.html#TestCustomGameTime.test_real_seconds_until"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.test_real_seconds_until" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.test_schedule">
|
||||
<code class="sig-name descname">test_schedule</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/custom_gametime/tests.html#TestCustomGameTime.test_schedule"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.test_schedule" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.custom_gametime.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.custom_gametime.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.custom_gametime.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,128 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.email_login.connection_screens — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.email_login.connection_screens</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.email_login.connection_screens">
|
||||
<span id="evennia-contrib-base-systems-email-login-connection-screens"></span><h1>evennia.contrib.base_systems.email_login.connection_screens<a class="headerlink" href="#module-evennia.contrib.base_systems.email_login.connection_screens" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Connection screen</p>
|
||||
<p>This is the text to show the user when they first connect to the game (before
|
||||
they log in).</p>
|
||||
<p>To change the login screen in this module, do one of the following:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Define a function <strong>connection_screen()</strong>, 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.</p></li>
|
||||
<li><p>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.</p></li>
|
||||
</ul>
|
||||
<p>The commands available to the user when the connection screen is shown
|
||||
are defined in evennia.default_cmds.UnloggedinCmdSet. The parsing and display
|
||||
of the screen is done by the unlogged-in “look” command.</p>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.email_login.connection_screens.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.email_login.connection_screens.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.email_login.connection_screens</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.email_login — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.email_login.email_login — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.email_login</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.email_login.email_login</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.email_login">
|
||||
<span id="evennia-contrib-email-login"></span><h1>evennia.contrib.email_login<a class="headerlink" href="#module-evennia.contrib.email_login" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.base_systems.email_login.email_login">
|
||||
<span id="evennia-contrib-base-systems-email-login-email-login"></span><h1>evennia.contrib.base_systems.email_login.email_login<a class="headerlink" href="#module-evennia.contrib.base_systems.email_login.email_login" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Email-based login system</p>
|
||||
<p>Evennia contrib - Griatch 2012</p>
|
||||
<p>This is a variant of the login system that requires an email-address
|
||||
|
|
@ -52,8 +52,9 @@ for some reason caused a lot of confusion when people wanted to expand
|
|||
on it. The email is not strictly needed internally, nor is any
|
||||
confirmation email sent out anyway).</p>
|
||||
<p>Installation is simple:</p>
|
||||
<p>To your settings file, add/edit the line:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">CMDSET_UNLOGGEDIN</span> <span class="o">=</span> <span class="s2">"contrib.email_login.UnloggedinCmdSet"</span>
|
||||
<p>To your settings file, add/edit settings as follows:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">CMDSET_UNLOGGEDIN</span> <span class="o">=</span> <span class="s2">"contrib.base_systems.email_login.email_login.UnloggedinCmdSet"</span>
|
||||
<span class="n">CONNECTION_SCREEN_MODULE</span> <span class="o">=</span> <span class="s2">"contrib.base_systems.email_login.connection_screens"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>That’s it. Reload the server and try to log in to see it.</p>
|
||||
|
|
@ -61,8 +62,8 @@ confirmation email sent out anyway).</p>
|
|||
after this change. The login splashscreen is taken from strings in
|
||||
the module given by settings.CONNECTION_SCREEN_MODULE.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.email_login.</code><code class="sig-name descname">CmdUnconnectedConnect</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/email_login.html#CmdUnconnectedConnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.email_login.email_login.</code><code class="sig-name descname">CmdUnconnectedConnect</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/email_login.html#CmdUnconnectedConnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Connect to the game.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -71,23 +72,23 @@ the module given by settings.CONNECTION_SCREEN_MODULE.</p>
|
|||
</dl>
|
||||
<p>Use the create command to first create an account before logging in.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'connect'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'connect'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['con', 'conn', 'co']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['con', 'co', 'conn']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/email_login.html#CmdUnconnectedConnect.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/email_login.html#CmdUnconnectedConnect.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Uses the Django admin api. Note that unlogged-in commands
|
||||
have a unique position in that their <strong>func()</strong> receives
|
||||
a session object instead of a <strong>source_object</strong> like all
|
||||
|
|
@ -96,25 +97,25 @@ there is no object yet before the account has logged in)</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'con conn co', 'category': 'general', 'key': 'connect', 'no_prefix': ' con conn co', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect <email> <password>\n\n Use the create command to first create an account before logging in.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'con co conn', 'category': 'general', 'key': 'connect', 'no_prefix': ' con co conn', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect <email> <password>\n\n Use the create command to first create an account before logging in.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedCreate">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.email_login.</code><code class="sig-name descname">CmdUnconnectedCreate</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/email_login.html#CmdUnconnectedCreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.email_login.email_login.</code><code class="sig-name descname">CmdUnconnectedCreate</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/email_login.html#CmdUnconnectedCreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Create a new account.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -123,23 +124,23 @@ there is no object yet before the account has logged in)</p>
|
|||
</dl>
|
||||
<p>This creates a new account account.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedCreate.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'create'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'create'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedCreate.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['cre', 'cr']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['cr', 'cre']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedCreate.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedCreate.parse">
|
||||
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/email_login.html#CmdUnconnectedCreate.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.parse">
|
||||
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/email_login.html#CmdUnconnectedCreate.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The parser must handle the multiple-word account
|
||||
name enclosed in quotes:</p>
|
||||
<blockquote>
|
||||
|
|
@ -148,158 +149,158 @@ name enclosed in quotes:</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedCreate.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/email_login.html#CmdUnconnectedCreate.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/email_login.html#CmdUnconnectedCreate.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do checks and create account</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedCreate.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedCreate.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedCreate.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'cre cr', 'category': 'general', 'key': 'create', 'no_prefix': ' cre cr', 'tags': '', 'text': '\n Create a new account.\n\n Usage (at login screen):\n create "accountname" <email> <password>\n\n This creates a new account account.\n\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'cr cre', 'category': 'general', 'key': 'create', 'no_prefix': ' cr cre', 'tags': '', 'text': '\n Create a new account.\n\n Usage (at login screen):\n create "accountname" <email> <password>\n\n This creates a new account account.\n\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.email_login.</code><code class="sig-name descname">CmdUnconnectedQuit</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/email_login.html#CmdUnconnectedQuit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.email_login.email_login.</code><code class="sig-name descname">CmdUnconnectedQuit</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/email_login.html#CmdUnconnectedQuit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>We maintain a different version of the <strong>quit</strong> command
|
||||
here for unconnected accounts for the sake of simplicity. The logged in
|
||||
version is a bit more complicated.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'quit'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'quit'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['qu', 'q']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['qu', 'q']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/email_login.html#CmdUnconnectedQuit.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/email_login.html#CmdUnconnectedQuit.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Simply close the connection.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'qu q', 'category': 'general', 'key': 'quit', 'no_prefix': ' qu q', 'tags': '', 'text': '\n We maintain a different version of the `quit` command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'qu q', 'category': 'general', 'key': 'quit', 'no_prefix': ' qu q', 'tags': '', 'text': '\n We maintain a different version of the `quit` command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedLook">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.email_login.</code><code class="sig-name descname">CmdUnconnectedLook</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/email_login.html#CmdUnconnectedLook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.email_login.email_login.</code><code class="sig-name descname">CmdUnconnectedLook</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/email_login.html#CmdUnconnectedLook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>This is an unconnected version of the <strong>look</strong> command for simplicity.</p>
|
||||
<p>This is called by the server and kicks everything in gear.
|
||||
All it does is display the connect screen.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedLook.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '__unloggedin_look_command'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '__unloggedin_look_command'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['look', 'l']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'look']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedLook.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedLook.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/email_login.html#CmdUnconnectedLook.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/email_login.html#CmdUnconnectedLook.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Show the connect screen.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedLook.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedLook.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' look l', 'tags': '', 'text': '\n This is an unconnected version of the `look` command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' l look', 'tags': '', 'text': '\n This is an unconnected version of the `look` command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedHelp">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.email_login.</code><code class="sig-name descname">CmdUnconnectedHelp</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/email_login.html#CmdUnconnectedHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedHelp" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.email_login.email_login.</code><code class="sig-name descname">CmdUnconnectedHelp</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/email_login.html#CmdUnconnectedHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>This is an unconnected version of the help command,
|
||||
for simplicity. It shows a pane of info.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedHelp.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'help'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedHelp.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'help'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['h', '?']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?', 'h']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedHelp.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedHelp.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedHelp.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/email_login.html#CmdUnconnectedHelp.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedHelp.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/email_login.html#CmdUnconnectedHelp.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Shows help</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedHelp.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedHelp.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedHelp.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedHelp.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.email_login.CmdUnconnectedHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '? h', 'category': 'general', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -329,7 +330,7 @@ for simplicity. It shows a pane of info.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.email_login.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.email_login.email_login.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -345,8 +346,8 @@ for simplicity. It shows a pane of info.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.email_login.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.email_login.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.email_login.email_login.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -363,7 +364,7 @@ for simplicity. It shows a pane of info.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.email_login</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.email_login.email_login</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.turnbattle — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.email_login — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.turnbattle</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.email_login</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,15 +40,14 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.turnbattle">
|
||||
<span id="evennia-contrib-turnbattle"></span><h1>evennia.contrib.turnbattle<a class="headerlink" href="#module-evennia.contrib.turnbattle" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.base_systems.email_login">
|
||||
<span id="evennia-contrib-base-systems-email-login"></span><h1>evennia.contrib.base_systems.email_login<a class="headerlink" href="#module-evennia.contrib.base_systems.email_login" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Email login contrib - Griatch 2012</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.turnbattle.tb_basic.html">evennia.contrib.turnbattle.tb_basic</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.turnbattle.tb_equip.html">evennia.contrib.turnbattle.tb_equip</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.turnbattle.tb_items.html">evennia.contrib.turnbattle.tb_items</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.turnbattle.tb_magic.html">evennia.contrib.turnbattle.tb_magic</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.turnbattle.tb_range.html">evennia.contrib.turnbattle.tb_range</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.email_login.connection_screens.html">evennia.contrib.base_systems.email_login.connection_screens</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.email_login.email_login.html">evennia.contrib.base_systems.email_login.email_login</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.email_login.tests.html">evennia.contrib.base_systems.email_login.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -76,7 +75,7 @@
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.turnbattle.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.email_login.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -92,8 +91,8 @@
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.turnbattle.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.turnbattle.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.email_login.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -110,7 +109,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.turnbattle</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.email_login</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,140 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.email_login.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.email_login.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.email_login.tests">
|
||||
<span id="evennia-contrib-base-systems-email-login-tests"></span><h1>evennia.contrib.base_systems.email_login.tests<a class="headerlink" href="#module-evennia.contrib.base_systems.email_login.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Test email login.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.email_login.tests.TestEmailLogin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.email_login.tests.</code><code class="sig-name descname">TestEmailLogin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/tests.html#TestEmailLogin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.tests.TestEmailLogin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.email_login.tests.TestEmailLogin.test_connect">
|
||||
<code class="sig-name descname">test_connect</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/tests.html#TestEmailLogin.test_connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.tests.TestEmailLogin.test_connect" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.email_login.tests.TestEmailLogin.test_quit">
|
||||
<code class="sig-name descname">test_quit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/tests.html#TestEmailLogin.test_quit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.tests.TestEmailLogin.test_quit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.email_login.tests.TestEmailLogin.test_unconnectedlook">
|
||||
<code class="sig-name descname">test_unconnectedlook</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/tests.html#TestEmailLogin.test_unconnectedlook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.tests.TestEmailLogin.test_unconnectedlook" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.email_login.tests.TestEmailLogin.test_unconnectedhelp">
|
||||
<code class="sig-name descname">test_unconnectedhelp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/email_login/tests.html#TestEmailLogin.test_unconnectedhelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.email_login.tests.TestEmailLogin.test_unconnectedhelp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.email_login.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.email_login.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.email_login.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
169
docs/1.0-dev/api/evennia.contrib.base_systems.html
Normal file
169
docs/1.0-dev/api/evennia.contrib.base_systems.html
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems">
|
||||
<span id="evennia-contrib-base-systems"></span><h1>evennia.contrib.base_systems<a class="headerlink" href="#module-evennia.contrib.base_systems" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.awsstorage.html">evennia.contrib.base_systems.awsstorage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.awsstorage.aws_s3_cdn.html">evennia.contrib.base_systems.awsstorage.aws_s3_cdn</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.awsstorage.tests.html">evennia.contrib.base_systems.awsstorage.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.building_menu.html">evennia.contrib.base_systems.building_menu</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.building_menu.building_menu.html">evennia.contrib.base_systems.building_menu.building_menu</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.building_menu.tests.html">evennia.contrib.base_systems.building_menu.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.color_markups.html">evennia.contrib.base_systems.color_markups</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.color_markups.color_markups.html">evennia.contrib.base_systems.color_markups.color_markups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.color_markups.tests.html">evennia.contrib.base_systems.color_markups.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.custom_gametime.html">evennia.contrib.base_systems.custom_gametime</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.custom_gametime.custom_gametime.html">evennia.contrib.base_systems.custom_gametime.custom_gametime</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.custom_gametime.tests.html">evennia.contrib.base_systems.custom_gametime.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.email_login.html">evennia.contrib.base_systems.email_login</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.email_login.connection_screens.html">evennia.contrib.base_systems.email_login.connection_screens</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.email_login.email_login.html">evennia.contrib.base_systems.email_login.email_login</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.email_login.tests.html">evennia.contrib.base_systems.email_login.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.html">evennia.contrib.base_systems.ingame_python</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.callbackhandler.html">evennia.contrib.base_systems.ingame_python.callbackhandler</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.commands.html">evennia.contrib.base_systems.ingame_python.commands</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.eventfuncs.html">evennia.contrib.base_systems.ingame_python.eventfuncs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.scripts.html">evennia.contrib.base_systems.ingame_python.scripts</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.tests.html">evennia.contrib.base_systems.ingame_python.tests</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.typeclasses.html">evennia.contrib.base_systems.ingame_python.typeclasses</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.utils.html">evennia.contrib.base_systems.ingame_python.utils</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.html">evennia.contrib.base_systems.menu_login</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.connection_screens.html">evennia.contrib.base_systems.menu_login.connection_screens</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.menu_login.html">evennia.contrib.base_systems.menu_login.menu_login</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.tests.html">evennia.contrib.base_systems.menu_login.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.mux_comms_cmds.html">evennia.contrib.base_systems.mux_comms_cmds</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.mux_comms_cmds.tests.html">evennia.contrib.base_systems.mux_comms_cmds.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.unixcommand.html">evennia.contrib.base_systems.unixcommand</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.unixcommand.tests.html">evennia.contrib.base_systems.unixcommand.tests</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.unixcommand.unixcommand.html">evennia.contrib.base_systems.unixcommand.unixcommand</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.ingame_python.callbackhandler — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.ingame_python.callbackhandler — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python.callbackhandler</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.callbackhandler</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,12 +40,12 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.ingame_python.callbackhandler">
|
||||
<span id="evennia-contrib-ingame-python-callbackhandler"></span><h1>evennia.contrib.ingame_python.callbackhandler<a class="headerlink" href="#module-evennia.contrib.ingame_python.callbackhandler" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.base_systems.ingame_python.callbackhandler">
|
||||
<span id="evennia-contrib-base-systems-ingame-python-callbackhandler"></span><h1>evennia.contrib.base_systems.ingame_python.callbackhandler<a class="headerlink" href="#module-evennia.contrib.base_systems.ingame_python.callbackhandler" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Module containing the CallbackHandler for individual objects.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.CallbackHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.ingame_python.callbackhandler.</code><code class="sig-name descname">CallbackHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/callbackhandler.html#CallbackHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.CallbackHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.callbackhandler.</code><code class="sig-name descname">CallbackHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>The callback handler for a specific object.</p>
|
||||
<p>The script that contains all callbacks will be reached through this
|
||||
|
|
@ -54,19 +54,19 @@ developers. This handler (accessible through <strong>obj.callbacks</strong>) is
|
|||
shortcut to manipulating callbacks within this object, getting,
|
||||
adding, editing, deleting and calling them.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.CallbackHandler.script">
|
||||
<code class="sig-name descname">script</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.script" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.script">
|
||||
<code class="sig-name descname">script</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.script" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.CallbackHandler.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/callbackhandler.html#CallbackHandler.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.CallbackHandler.all">
|
||||
<code class="sig-name descname">all</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/callbackhandler.html#CallbackHandler.all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.all" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.all">
|
||||
<code class="sig-name descname">all</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.all" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return all callbacks linked to this object.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -77,8 +77,8 @@ is returned as a namedtuple to simplify manipulation.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.CallbackHandler.get">
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback_name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/callbackhandler.html#CallbackHandler.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.get">
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback_name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the callbacks associated with this name.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -97,8 +97,8 @@ object’s callbacks, return an empty list.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.CallbackHandler.get_variable">
|
||||
<code class="sig-name descname">get_variable</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">variable_name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/callbackhandler.html#CallbackHandler.get_variable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.get_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.get_variable">
|
||||
<code class="sig-name descname">get_variable</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">variable_name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.get_variable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.get_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the variable value or None.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -111,8 +111,8 @@ object’s callbacks, return an empty list.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.CallbackHandler.add">
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">author</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">valid</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">parameters</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/callbackhandler.html#CallbackHandler.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.add">
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">author</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">valid</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">parameters</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add a new callback for this object.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -131,8 +131,8 @@ object’s callbacks, return an empty list.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.CallbackHandler.edit">
|
||||
<code class="sig-name descname">edit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="n">number</span></em>, <em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">author</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">valid</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/callbackhandler.html#CallbackHandler.edit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.edit" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.edit">
|
||||
<code class="sig-name descname">edit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="n">number</span></em>, <em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">author</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">valid</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.edit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.edit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Edit an existing callback bound to this object.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -154,8 +154,8 @@ object’s callbacks, return an empty list.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.CallbackHandler.remove">
|
||||
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="n">number</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/callbackhandler.html#CallbackHandler.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.remove">
|
||||
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="n">number</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete the specified callback bound to this object.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -171,8 +171,8 @@ object’s callbacks, return an empty list.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.CallbackHandler.call">
|
||||
<code class="sig-name descname">call</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/callbackhandler.html#CallbackHandler.call"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.call" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.call">
|
||||
<code class="sig-name descname">call</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.call"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.call" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Call the specified callback(s) bound to this object.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -197,8 +197,8 @@ None.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.CallbackHandler.format_callback">
|
||||
<em class="property">static </em><code class="sig-name descname">format_callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/callbackhandler.html#CallbackHandler.format_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.format_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.format_callback">
|
||||
<em class="property">static </em><code class="sig-name descname">format_callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.format_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.format_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the callback namedtuple to represent the specified callback.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -212,66 +212,66 @@ the expected fields for a callback (code, author, valid…).</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.Callback">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.ingame_python.callbackhandler.</code><code class="sig-name descname">Callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">number</span></em>, <em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">author</span></em>, <em class="sig-param"><span class="n">valid</span></em>, <em class="sig-param"><span class="n">parameters</span></em>, <em class="sig-param"><span class="n">created_on</span></em>, <em class="sig-param"><span class="n">updated_by</span></em>, <em class="sig-param"><span class="n">updated_on</span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.Callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.callbackhandler.</code><code class="sig-name descname">Callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">number</span></em>, <em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">author</span></em>, <em class="sig-param"><span class="n">valid</span></em>, <em class="sig-param"><span class="n">parameters</span></em>, <em class="sig-param"><span class="n">created_on</span></em>, <em class="sig-param"><span class="n">updated_by</span></em>, <em class="sig-param"><span class="n">updated_on</span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.Callback.author">
|
||||
<code class="sig-name descname">author</code><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.Callback.author" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.author">
|
||||
<code class="sig-name descname">author</code><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.author" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 4</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.Callback.code">
|
||||
<code class="sig-name descname">code</code><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.Callback.code" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.code">
|
||||
<code class="sig-name descname">code</code><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.code" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 3</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.Callback.created_on">
|
||||
<code class="sig-name descname">created_on</code><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.Callback.created_on" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.created_on">
|
||||
<code class="sig-name descname">created_on</code><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.created_on" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 7</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.Callback.name">
|
||||
<code class="sig-name descname">name</code><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.Callback.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.name">
|
||||
<code class="sig-name descname">name</code><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.Callback.number">
|
||||
<code class="sig-name descname">number</code><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.Callback.number" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.number">
|
||||
<code class="sig-name descname">number</code><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.number" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.Callback.obj">
|
||||
<code class="sig-name descname">obj</code><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.Callback.obj" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.obj">
|
||||
<code class="sig-name descname">obj</code><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.obj" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.Callback.parameters">
|
||||
<code class="sig-name descname">parameters</code><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.Callback.parameters" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.parameters">
|
||||
<code class="sig-name descname">parameters</code><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.parameters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 6</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.Callback.updated_by">
|
||||
<code class="sig-name descname">updated_by</code><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.Callback.updated_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.updated_by">
|
||||
<code class="sig-name descname">updated_by</code><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.updated_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 8</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.Callback.updated_on">
|
||||
<code class="sig-name descname">updated_on</code><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.Callback.updated_on" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.updated_on">
|
||||
<code class="sig-name descname">updated_on</code><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.updated_on" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 9</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.callbackhandler.Callback.valid">
|
||||
<code class="sig-name descname">valid</code><a class="headerlink" href="#evennia.contrib.ingame_python.callbackhandler.Callback.valid" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.valid">
|
||||
<code class="sig-name descname">valid</code><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.valid" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Alias for field number 5</p>
|
||||
</dd></dl>
|
||||
|
||||
|
|
@ -302,7 +302,7 @@ the expected fields for a callback (code, author, valid…).</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.ingame_python.callbackhandler.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.ingame_python.callbackhandler.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -318,8 +318,8 @@ the expected fields for a callback (code, author, valid…).</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.ingame_python.callbackhandler.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.ingame_python.callbackhandler.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.ingame_python.callbackhandler.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -336,7 +336,7 @@ the expected fields for a callback (code, author, valid…).</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python.callbackhandler</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.callbackhandler</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.ingame_python.commands — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.ingame_python.commands — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python.commands</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.commands</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,37 +40,37 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.ingame_python.commands">
|
||||
<span id="evennia-contrib-ingame-python-commands"></span><h1>evennia.contrib.ingame_python.commands<a class="headerlink" href="#module-evennia.contrib.ingame_python.commands" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.base_systems.ingame_python.commands">
|
||||
<span id="evennia-contrib-base-systems-ingame-python-commands"></span><h1>evennia.contrib.base_systems.ingame_python.commands<a class="headerlink" href="#module-evennia.contrib.base_systems.ingame_python.commands" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Module containing the commands of the in-game Python system.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.ingame_python.commands.</code><code class="sig-name descname">CmdCallback</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.commands.</code><code class="sig-name descname">CmdCallback</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Command to edit callbacks.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@call'</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@call'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@calls', '@callbacks', '@callback']</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@callback', '@callbacks', '@calls']</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(developer)'</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(developer)'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'building'</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'building'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.get_help">
|
||||
<code class="sig-name descname">get_help</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">cmdset</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.get_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.get_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.get_help">
|
||||
<code class="sig-name descname">get_help</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">cmdset</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.get_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.get_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the help message for this command and this caller.</p>
|
||||
<p>The help text of this specific command will vary depending
|
||||
on user permission.</p>
|
||||
|
|
@ -88,55 +88,55 @@ on user permission.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Command body.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.list_callbacks">
|
||||
<code class="sig-name descname">list_callbacks</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.list_callbacks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.list_callbacks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.list_callbacks">
|
||||
<code class="sig-name descname">list_callbacks</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.list_callbacks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.list_callbacks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Display the list of callbacks connected to the object.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.add_callback">
|
||||
<code class="sig-name descname">add_callback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.add_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.add_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.add_callback">
|
||||
<code class="sig-name descname">add_callback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.add_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.add_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add a callback.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.edit_callback">
|
||||
<code class="sig-name descname">edit_callback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.edit_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.edit_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.edit_callback">
|
||||
<code class="sig-name descname">edit_callback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.edit_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.edit_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Edit a callback.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.del_callback">
|
||||
<code class="sig-name descname">del_callback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.del_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.del_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.del_callback">
|
||||
<code class="sig-name descname">del_callback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.del_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.del_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete a callback.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.accept_callback">
|
||||
<code class="sig-name descname">accept_callback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.accept_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.accept_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.accept_callback">
|
||||
<code class="sig-name descname">accept_callback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.accept_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.accept_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accept a callback.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.list_tasks">
|
||||
<code class="sig-name descname">list_tasks</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.list_tasks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.list_tasks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.list_tasks">
|
||||
<code class="sig-name descname">list_tasks</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.list_tasks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.list_tasks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>List the active tasks.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(developer)'</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(developer)'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@calls @callbacks @callback', 'category': 'building', 'key': '@call', 'no_prefix': 'call calls callbacks callback', 'tags': '', 'text': '\n Command to edit callbacks.\n '}</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@callback @callbacks @calls', 'category': 'building', 'key': '@call', 'no_prefix': 'call callback callbacks calls', 'tags': '', 'text': '\n Command to edit callbacks.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -166,7 +166,7 @@ on user permission.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.ingame_python.commands.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.ingame_python.commands.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -182,8 +182,8 @@ on user permission.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.ingame_python.commands.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.ingame_python.commands.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.ingame_python.commands.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -200,7 +200,7 @@ on user permission.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python.commands</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.commands</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.ingame_python.eventfuncs — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.ingame_python.eventfuncs — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python.eventfuncs</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.eventfuncs</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,13 +40,13 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.ingame_python.eventfuncs">
|
||||
<span id="evennia-contrib-ingame-python-eventfuncs"></span><h1>evennia.contrib.ingame_python.eventfuncs<a class="headerlink" href="#module-evennia.contrib.ingame_python.eventfuncs" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.base_systems.ingame_python.eventfuncs">
|
||||
<span id="evennia-contrib-base-systems-ingame-python-eventfuncs"></span><h1>evennia.contrib.base_systems.ingame_python.eventfuncs<a class="headerlink" href="#module-evennia.contrib.base_systems.ingame_python.eventfuncs" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Module defining basic eventfuncs for the event system.</p>
|
||||
<p>Eventfuncs are just Python functions that can be used inside of calllbacks.</p>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.ingame_python.eventfuncs.deny">
|
||||
<code class="sig-prename descclassname">evennia.contrib.ingame_python.eventfuncs.</code><code class="sig-name descname">deny</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/eventfuncs.html#deny"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.eventfuncs.deny" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.eventfuncs.deny">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.eventfuncs.</code><code class="sig-name descname">deny</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/eventfuncs.html#deny"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.eventfuncs.deny" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deny, that is stop, the callback here.</p>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>This function will raise an exception to terminate the callback
|
||||
|
|
@ -57,8 +57,8 @@ by <strong>can_</strong>, because they usually can be cancelled as easily as tha
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.ingame_python.eventfuncs.get">
|
||||
<code class="sig-prename descclassname">evennia.contrib.ingame_python.eventfuncs.</code><code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/eventfuncs.html#get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.eventfuncs.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.eventfuncs.get">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.eventfuncs.</code><code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/eventfuncs.html#get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.eventfuncs.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return an object with the given search option or None if None is found.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Keyword Arguments</dt>
|
||||
|
|
@ -84,8 +84,8 @@ argument) but remember several objects can share the same key.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.ingame_python.eventfuncs.call_event">
|
||||
<code class="sig-prename descclassname">evennia.contrib.ingame_python.eventfuncs.</code><code class="sig-name descname">call_event</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">event_name</span></em>, <em class="sig-param"><span class="n">seconds</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/eventfuncs.html#call_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.eventfuncs.call_event" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.eventfuncs.call_event">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.eventfuncs.</code><code class="sig-name descname">call_event</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">event_name</span></em>, <em class="sig-param"><span class="n">seconds</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/eventfuncs.html#call_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.eventfuncs.call_event" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Call the specified event in X seconds.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -134,7 +134,7 @@ to be called from inside another event.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.ingame_python.eventfuncs.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.ingame_python.eventfuncs.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -150,8 +150,8 @@ to be called from inside another event.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.ingame_python.eventfuncs.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.ingame_python.eventfuncs.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.ingame_python.eventfuncs.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -168,7 +168,7 @@ to be called from inside another event.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python.eventfuncs</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.eventfuncs</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.ingame_python — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.ingame_python — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,17 +40,17 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.ingame_python">
|
||||
<span id="evennia-contrib-ingame-python"></span><h1>evennia.contrib.ingame_python<a class="headerlink" href="#module-evennia.contrib.ingame_python" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="evennia-contrib-base-systems-ingame-python">
|
||||
<h1>evennia.contrib.base_systems.ingame_python<a class="headerlink" href="#evennia-contrib-base-systems-ingame-python" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.ingame_python.callbackhandler.html">evennia.contrib.ingame_python.callbackhandler</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.ingame_python.commands.html">evennia.contrib.ingame_python.commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.ingame_python.eventfuncs.html">evennia.contrib.ingame_python.eventfuncs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.ingame_python.scripts.html">evennia.contrib.ingame_python.scripts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.ingame_python.tests.html">evennia.contrib.ingame_python.tests</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.ingame_python.typeclasses.html">evennia.contrib.ingame_python.typeclasses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.ingame_python.utils.html">evennia.contrib.ingame_python.utils</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.callbackhandler.html">evennia.contrib.base_systems.ingame_python.callbackhandler</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.commands.html">evennia.contrib.base_systems.ingame_python.commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.eventfuncs.html">evennia.contrib.base_systems.ingame_python.eventfuncs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.scripts.html">evennia.contrib.base_systems.ingame_python.scripts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.tests.html">evennia.contrib.base_systems.ingame_python.tests</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.typeclasses.html">evennia.contrib.base_systems.ingame_python.typeclasses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.utils.html">evennia.contrib.base_systems.ingame_python.utils</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -78,7 +78,7 @@
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.ingame_python.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.ingame_python.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -94,8 +94,8 @@
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.ingame_python.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.ingame_python.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.ingame_python.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -112,7 +112,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.ingame_python.scripts — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.ingame_python.scripts — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python.scripts</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.scripts</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,12 +40,12 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.ingame_python.scripts">
|
||||
<span id="evennia-contrib-ingame-python-scripts"></span><h1>evennia.contrib.ingame_python.scripts<a class="headerlink" href="#module-evennia.contrib.ingame_python.scripts" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.base_systems.ingame_python.scripts">
|
||||
<span id="evennia-contrib-base-systems-ingame-python-scripts"></span><h1>evennia.contrib.base_systems.ingame_python.scripts<a class="headerlink" href="#module-evennia.contrib.base_systems.ingame_python.scripts" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Scripts for the in-game Python system.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.ingame_python.scripts.</code><code class="sig-name descname">EventHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#EventHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.scripts.</code><code class="sig-name descname">EventHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#EventHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript" title="evennia.scripts.scripts.DefaultScript"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript</span></code></a></p>
|
||||
<p>The event handler that contains all events in a global script.</p>
|
||||
<p>This script shouldn’t be created more than once. It contains
|
||||
|
|
@ -53,14 +53,14 @@ event (in a non-persistent attribute) and callbacks (in a
|
|||
persistent attribute). The script method would help adding,
|
||||
editing and deleting these events and callbacks.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#EventHandler.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#EventHandler.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook called when the script is created.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.at_server_start">
|
||||
<code class="sig-name descname">at_server_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#EventHandler.at_server_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.at_server_start" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.at_server_start">
|
||||
<code class="sig-name descname">at_server_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#EventHandler.at_server_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.at_server_start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set up the event system when starting.</p>
|
||||
<p>Note that this hook is called every time the server restarts
|
||||
(including when it’s reloaded). This hook performs the following
|
||||
|
|
@ -75,8 +75,8 @@ tasks:</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.get_events">
|
||||
<code class="sig-name descname">get_events</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#EventHandler.get_events"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.get_events" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.get_events">
|
||||
<code class="sig-name descname">get_events</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#EventHandler.get_events"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.get_events" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return a dictionary of events on this object.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -96,8 +96,8 @@ of events for a typeclass that has no object yet.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.get_variable">
|
||||
<code class="sig-name descname">get_variable</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">variable_name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#EventHandler.get_variable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.get_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.get_variable">
|
||||
<code class="sig-name descname">get_variable</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">variable_name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#EventHandler.get_variable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.get_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the variable defined in the locals.</p>
|
||||
<p>This can be very useful to check the value of a variable that can be modified in an event, and whose value will be used in code. This system allows additional customization.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -122,8 +122,8 @@ mean the same thing.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.get_callbacks">
|
||||
<code class="sig-name descname">get_callbacks</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#EventHandler.get_callbacks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.get_callbacks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.get_callbacks">
|
||||
<code class="sig-name descname">get_callbacks</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#EventHandler.get_callbacks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.get_callbacks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return a dictionary of the object’s callbacks.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -141,8 +141,8 @@ when several objects would share callbacks.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.add_callback">
|
||||
<code class="sig-name descname">add_callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">author</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">valid</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">parameters</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#EventHandler.add_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.add_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.add_callback">
|
||||
<code class="sig-name descname">add_callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">author</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">valid</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">parameters</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#EventHandler.add_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.add_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add the specified callback.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -163,8 +163,8 @@ when several objects would share callbacks.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.edit_callback">
|
||||
<code class="sig-name descname">edit_callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="n">number</span></em>, <em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">author</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">valid</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#EventHandler.edit_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.edit_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.edit_callback">
|
||||
<code class="sig-name descname">edit_callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="n">number</span></em>, <em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">author</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">valid</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#EventHandler.edit_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.edit_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Edit the specified callback.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -188,8 +188,8 @@ when several objects would share callbacks.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.del_callback">
|
||||
<code class="sig-name descname">del_callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="n">number</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#EventHandler.del_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.del_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.del_callback">
|
||||
<code class="sig-name descname">del_callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="n">number</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#EventHandler.del_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.del_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete the specified callback.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -206,8 +206,8 @@ when several objects would share callbacks.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.accept_callback">
|
||||
<code class="sig-name descname">accept_callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="n">number</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#EventHandler.accept_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.accept_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.accept_callback">
|
||||
<code class="sig-name descname">accept_callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="n">number</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#EventHandler.accept_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.accept_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Valid a callback.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -221,8 +221,8 @@ when several objects would share callbacks.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.call">
|
||||
<code class="sig-name descname">call</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#EventHandler.call"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.call" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.call">
|
||||
<code class="sig-name descname">call</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">callback_name</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#EventHandler.call"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.call" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Call the connected callbacks.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -247,8 +247,8 @@ False otherwise.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.handle_error">
|
||||
<code class="sig-name descname">handle_error</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback</span></em>, <em class="sig-param"><span class="n">trace</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#EventHandler.handle_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.handle_error" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.handle_error">
|
||||
<code class="sig-name descname">handle_error</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback</span></em>, <em class="sig-param"><span class="n">trace</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#EventHandler.handle_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.handle_error" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Handle an error in a callback.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -266,8 +266,8 @@ If not, display to the everror channel.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.add_event">
|
||||
<code class="sig-name descname">add_event</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">typeclass</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">variables</span></em>, <em class="sig-param"><span class="n">help_text</span></em>, <em class="sig-param"><span class="n">custom_call</span></em>, <em class="sig-param"><span class="n">custom_add</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#EventHandler.add_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.add_event" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.add_event">
|
||||
<code class="sig-name descname">add_event</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">typeclass</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">variables</span></em>, <em class="sig-param"><span class="n">help_text</span></em>, <em class="sig-param"><span class="n">custom_call</span></em>, <em class="sig-param"><span class="n">custom_add</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#EventHandler.add_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.add_event" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add a new event for a defined typeclass.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -286,8 +286,8 @@ a callback is added.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.set_task">
|
||||
<code class="sig-name descname">set_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">seconds</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">callback_name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#EventHandler.set_task"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.set_task" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.set_task">
|
||||
<code class="sig-name descname">set_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">seconds</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">callback_name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#EventHandler.set_task"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.set_task" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set and schedule a task to run.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -311,43 +311,43 @@ not be kept in the locals dictionary.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.DoesNotExist" title="evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.ingame_python.scripts.EventHandler'</em><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.base_systems.ingame_python.scripts.EventHandler'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.EventHandler.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EventHandler'</em><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.EventHandler.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.EventHandler.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EventHandler'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.TimeEventScript">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.ingame_python.scripts.</code><code class="sig-name descname">TimeEventScript</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#TimeEventScript"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.TimeEventScript" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.scripts.</code><code class="sig-name descname">TimeEventScript</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#TimeEventScript"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript" title="evennia.scripts.scripts.DefaultScript"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript</span></code></a></p>
|
||||
<p>Gametime-sensitive script.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.TimeEventScript.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#TimeEventScript.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.TimeEventScript.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#TimeEventScript.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The script is created.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.TimeEventScript.at_repeat">
|
||||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#TimeEventScript.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.TimeEventScript.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript.at_repeat">
|
||||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#TimeEventScript.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Call the event and reset interval.</p>
|
||||
<p>It is necessary to restart the script to reset its interval
|
||||
only twice after a reload. When the script has undergone
|
||||
|
|
@ -360,32 +360,32 @@ restart only twice.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.TimeEventScript.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.TimeEventScript.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.DoesNotExist" title="evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.TimeEventScript.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.TimeEventScript.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.TimeEventScript.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.ingame_python.scripts.TimeEventScript'</em><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.TimeEventScript.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.TimeEventScript.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TimeEventScript'</em><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.TimeEventScript.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TimeEventScript'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.ingame_python.scripts.complete_task">
|
||||
<code class="sig-prename descclassname">evennia.contrib.ingame_python.scripts.</code><code class="sig-name descname">complete_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">task_id</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/scripts.html#complete_task"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.scripts.complete_task" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.scripts.complete_task">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.scripts.</code><code class="sig-name descname">complete_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">task_id</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/scripts.html#complete_task"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.scripts.complete_task" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Mark the task in the event handler as complete.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -423,7 +423,7 @@ restart only twice.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.ingame_python.scripts.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.ingame_python.scripts.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -439,8 +439,8 @@ restart only twice.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.ingame_python.scripts.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.ingame_python.scripts.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.ingame_python.scripts.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -457,7 +457,7 @@ restart only twice.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python.scripts</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.scripts</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,255 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.ingame_python.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.ingame_python.tests">
|
||||
<span id="evennia-contrib-base-systems-ingame-python-tests"></span><h1>evennia.contrib.base_systems.ingame_python.tests<a class="headerlink" href="#module-evennia.contrib.base_systems.ingame_python.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Module containing the test cases for the in-game Python system.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.tests.</code><code class="sig-name descname">TestEventHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
|
||||
<p>Test cases of the event handler to add, edit or delete events.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create the event handler.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Stop the event handler.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_start">
|
||||
<code class="sig-name descname">test_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Simply make sure the handler runs with proper initial values.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_add_validation">
|
||||
<code class="sig-name descname">test_add_validation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_add_validation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_add_validation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add a callback while needing validation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_edit">
|
||||
<code class="sig-name descname">test_edit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_edit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_edit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test editing a callback.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_edit_validation">
|
||||
<code class="sig-name descname">test_edit_validation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_edit_validation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_edit_validation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Edit a callback when validation isn’t automatic.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_del">
|
||||
<code class="sig-name descname">test_del</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_del"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_del" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Try to delete a callback.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_accept">
|
||||
<code class="sig-name descname">test_accept</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_accept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_accept" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accept an callback.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_call">
|
||||
<code class="sig-name descname">test_call</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_call"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_call" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test to call amore complex callback.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_handler">
|
||||
<code class="sig-name descname">test_handler</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_handler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the object handler.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.tests.</code><code class="sig-name descname">TestCmdCallback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<p>Test the @callback command.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create the callback handler.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Stop the callback handler.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_list">
|
||||
<code class="sig-name descname">test_list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback.test_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test listing callbacks with different rights.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_add">
|
||||
<code class="sig-name descname">test_add</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback.test_add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test to add an callback.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_del">
|
||||
<code class="sig-name descname">test_del</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback.test_del"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_del" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add and remove an callback.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_lock">
|
||||
<code class="sig-name descname">test_lock</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback.test_lock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_lock" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the lock of multiple editing.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_accept">
|
||||
<code class="sig-name descname">test_accept</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback.test_accept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_accept" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accept an callback.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.tests.</code><code class="sig-name descname">TestDefaultCallbacks</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestDefaultCallbacks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<p>Test the default callbacks.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestDefaultCallbacks.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create the callback handler.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestDefaultCallbacks.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Stop the callback handler.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks.test_exit">
|
||||
<code class="sig-name descname">test_exit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestDefaultCallbacks.test_exit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks.test_exit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the callbacks of an exit.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.ingame_python.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.ingame_python.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,113 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.ingame_python.typeclasses — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.typeclasses</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="evennia-contrib-base-systems-ingame-python-typeclasses">
|
||||
<h1>evennia.contrib.base_systems.ingame_python.typeclasses<a class="headerlink" href="#evennia-contrib-base-systems-ingame-python-typeclasses" title="Permalink to this headline">¶</a></h1>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.ingame_python.typeclasses.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.ingame_python.typeclasses.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.typeclasses</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.ingame_python.utils — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.ingame_python.utils — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python.utils</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.utils</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,19 +40,19 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.ingame_python.utils">
|
||||
<span id="evennia-contrib-ingame-python-utils"></span><h1>evennia.contrib.ingame_python.utils<a class="headerlink" href="#module-evennia.contrib.ingame_python.utils" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.base_systems.ingame_python.utils">
|
||||
<span id="evennia-contrib-base-systems-ingame-python-utils"></span><h1>evennia.contrib.base_systems.ingame_python.utils<a class="headerlink" href="#module-evennia.contrib.base_systems.ingame_python.utils" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Functions to extend the event system.</p>
|
||||
<p>These functions are to be used by developers to customize events and callbacks.</p>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.ingame_python.utils.get_event_handler">
|
||||
<code class="sig-prename descclassname">evennia.contrib.ingame_python.utils.</code><code class="sig-name descname">get_event_handler</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/utils.html#get_event_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.utils.get_event_handler" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.utils.get_event_handler">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.utils.</code><code class="sig-name descname">get_event_handler</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/utils.html#get_event_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.utils.get_event_handler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the event handler or None.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.ingame_python.utils.register_events">
|
||||
<code class="sig-prename descclassname">evennia.contrib.ingame_python.utils.</code><code class="sig-name descname">register_events</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path_or_typeclass</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/utils.html#register_events"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.utils.register_events" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.utils.register_events">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.utils.</code><code class="sig-name descname">register_events</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path_or_typeclass</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/utils.html#register_events"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.utils.register_events" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Register the events in this typeclass.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -71,8 +71,8 @@ temporary storage, waiting for the script to be initialized.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.ingame_python.utils.get_next_wait">
|
||||
<code class="sig-prename descclassname">evennia.contrib.ingame_python.utils.</code><code class="sig-name descname">get_next_wait</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">format</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/utils.html#get_next_wait"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.utils.get_next_wait" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.utils.get_next_wait">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.utils.</code><code class="sig-name descname">get_next_wait</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">format</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/utils.html#get_next_wait"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.utils.get_next_wait" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the length of time in seconds before format.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -91,8 +91,8 @@ calculated.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.ingame_python.utils.time_event">
|
||||
<code class="sig-prename descclassname">evennia.contrib.ingame_python.utils.</code><code class="sig-name descname">time_event</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">event_name</span></em>, <em class="sig-param"><span class="n">number</span></em>, <em class="sig-param"><span class="n">parameters</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/utils.html#time_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.utils.time_event" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.utils.time_event">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.utils.</code><code class="sig-name descname">time_event</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">event_name</span></em>, <em class="sig-param"><span class="n">number</span></em>, <em class="sig-param"><span class="n">parameters</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/utils.html#time_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.utils.time_event" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a time-related event.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -107,8 +107,8 @@ calculated.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.ingame_python.utils.keyword_event">
|
||||
<code class="sig-prename descclassname">evennia.contrib.ingame_python.utils.</code><code class="sig-name descname">keyword_event</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callbacks</span></em>, <em class="sig-param"><span class="n">parameters</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/utils.html#keyword_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.utils.keyword_event" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.utils.keyword_event">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.utils.</code><code class="sig-name descname">keyword_event</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callbacks</span></em>, <em class="sig-param"><span class="n">parameters</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/utils.html#keyword_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.utils.keyword_event" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Custom call for events with keywords (like push, or pull, or turn…).</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -130,8 +130,8 @@ be set to trigger when the player ‘push 1’ or ‘push one’.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.ingame_python.utils.phrase_event">
|
||||
<code class="sig-prename descclassname">evennia.contrib.ingame_python.utils.</code><code class="sig-name descname">phrase_event</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callbacks</span></em>, <em class="sig-param"><span class="n">parameters</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/utils.html#phrase_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.utils.phrase_event" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.utils.phrase_event">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.utils.</code><code class="sig-name descname">phrase_event</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callbacks</span></em>, <em class="sig-param"><span class="n">parameters</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/utils.html#phrase_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.utils.phrase_event" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Custom call for events with keywords in sentences (like say or whisper).</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -154,8 +154,8 @@ either “yes” or “okay” (maybe ‘say I don’t like it, but okay’).</p
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.ingame_python.utils.InterruptEvent">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">evennia.contrib.ingame_python.utils.</code><code class="sig-name descname">InterruptEvent</code><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/utils.html#InterruptEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.utils.InterruptEvent" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.utils.InterruptEvent">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.utils.</code><code class="sig-name descname">InterruptEvent</code><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/utils.html#InterruptEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.utils.InterruptEvent" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">RuntimeError</span></code></p>
|
||||
<p>Interrupt the current event.</p>
|
||||
<p>You shouldn’t have to use this exception directly, probably use the
|
||||
|
|
@ -187,7 +187,7 @@ either “yes” or “okay” (maybe ‘say I don’t like it, but okay’).</p
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.ingame_python.utils.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.ingame_python.utils.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -203,8 +203,8 @@ either “yes” or “okay” (maybe ‘say I don’t like it, but okay’).</p
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.ingame_python.utils.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.ingame_python.utils.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.ingame_python.utils.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -221,7 +221,7 @@ either “yes” or “okay” (maybe ‘say I don’t like it, but okay’).</p
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python.utils</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.utils</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.menu_login — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.menu_login.connection_screens — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.menu_login</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.menu_login.connection_screens</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="evennia-contrib-menu-login">
|
||||
<h1>evennia.contrib.menu_login<a class="headerlink" href="#evennia-contrib-menu-login" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="evennia-contrib-base-systems-menu-login-connection-screens">
|
||||
<h1>evennia.contrib.base_systems.menu_login.connection_screens<a class="headerlink" href="#evennia-contrib-base-systems-menu-login-connection-screens" title="Permalink to this headline">¶</a></h1>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -67,7 +67,7 @@
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.menu_login.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.menu_login.connection_screens.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -83,8 +83,8 @@
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.menu_login.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.menu_login.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.menu_login.connection_screens.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -101,7 +101,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.menu_login</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.menu_login.connection_screens</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
120
docs/1.0-dev/api/evennia.contrib.base_systems.menu_login.html
Normal file
120
docs/1.0-dev/api/evennia.contrib.base_systems.menu_login.html
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.menu_login — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.menu_login</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="evennia-contrib-base-systems-menu-login">
|
||||
<h1>evennia.contrib.base_systems.menu_login<a class="headerlink" href="#evennia-contrib-base-systems-menu-login" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.connection_screens.html">evennia.contrib.base_systems.menu_login.connection_screens</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.menu_login.html">evennia.contrib.base_systems.menu_login.menu_login</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.tests.html">evennia.contrib.base_systems.menu_login.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.menu_login.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.menu_login.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.menu_login</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,113 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.menu_login.menu_login — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.menu_login.menu_login</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="evennia-contrib-base-systems-menu-login-menu-login">
|
||||
<h1>evennia.contrib.base_systems.menu_login.menu_login<a class="headerlink" href="#evennia-contrib-base-systems-menu-login-menu-login" title="Permalink to this headline">¶</a></h1>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.menu_login.menu_login.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.menu_login.menu_login.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.menu_login.menu_login</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.mapbuilder — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.menu_login.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.mapbuilder</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.menu_login.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="evennia-contrib-mapbuilder">
|
||||
<h1>evennia.contrib.mapbuilder<a class="headerlink" href="#evennia-contrib-mapbuilder" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="evennia-contrib-base-systems-menu-login-tests">
|
||||
<h1>evennia.contrib.base_systems.menu_login.tests<a class="headerlink" href="#evennia-contrib-base-systems-menu-login-tests" title="Permalink to this headline">¶</a></h1>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -67,7 +67,7 @@
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.mapbuilder.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.menu_login.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -83,8 +83,8 @@
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.mapbuilder.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.mapbuilder.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.menu_login.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -101,7 +101,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.mapbuilder</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.menu_login.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,120 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.mux_comms_cmds — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.mux_comms_cmds</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.mux_comms_cmds">
|
||||
<span id="evennia-contrib-base-systems-mux-comms-cmds"></span><h1>evennia.contrib.base_systems.mux_comms_cmds<a class="headerlink" href="#module-evennia.contrib.base_systems.mux_comms_cmds" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Mux-style comms commands - Griatch 2021</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.mux_comms_cmds.tests.html">evennia.contrib.base_systems.mux_comms_cmds.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.mux_comms_cmds.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.mux_comms_cmds.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.mux_comms_cmds</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,662 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds">
|
||||
<span id="evennia-contrib-base-systems-mux-comms-cmds-mux-comms-cmds"></span><h1>evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds<a class="headerlink" href="#module-evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Legacy Comms-commands</p>
|
||||
<p>Griatch 2021</p>
|
||||
<p>In Evennia 1.0, the old Channel commands (originally inspired by MUX) were
|
||||
replaced by the single <strong>channel</strong> command that performs all these function.
|
||||
That command is still required to talk on channels. This contrib (extracted
|
||||
from Evennia 0.9.5) reuses the channel-management of the base Channel command
|
||||
but breaks out its functionality into separate Commands with MUX-familiar names.</p>
|
||||
<ul class="simple">
|
||||
<li><p><strong>allcom</strong> - <strong>channel/all</strong> and <strong>channel</strong></p></li>
|
||||
<li><p><strong>addcom</strong> - <strong>channel/alias</strong>, <strong>channel/sub</strong> and <strong>channel/unmute</strong></p></li>
|
||||
<li><p><strong>delcom</strong> - <strong>channel/unalias</strong>, <strong>alias/unsub</strong> and <strong>channel/mute</strong></p></li>
|
||||
<li><p><strong>cboot</strong> - <strong>channel/boot</strong> (<strong>channel/ban</strong> and <strong>/unban</strong> not supported)</p></li>
|
||||
<li><p><strong>cwho</strong> - <strong>channel/who</strong></p></li>
|
||||
<li><p><strong>ccreate</strong> - <strong>channel/create</strong></p></li>
|
||||
<li><p><strong>cdestroy</strong> - <strong>channel/destroy</strong></p></li>
|
||||
<li><p><strong>clock</strong> - <strong>channel/lock</strong></p></li>
|
||||
<li><p><strong>cdesc</strong> - <strong>channel/desc</strong></p></li>
|
||||
</ul>
|
||||
<p>Installation:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Import the <strong>CmdSetLegacyComms</strong> cmdset from this module into <strong>mygame/commands/default_cmdsets.py</strong></p></li>
|
||||
<li><p>Add it to the CharacterCmdSet’s <strong>at_cmdset_creation</strong> method.</p></li>
|
||||
<li><p>Reload the server.</p></li>
|
||||
</ul>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># in mygame/commands/default_cmdsets.py</span>
|
||||
|
||||
<span class="c1"># ..</span>
|
||||
<span class="kn">from</span> <span class="nn">evennia.contrib.base_systems.mux_comms_cmds</span> <span class="kn">import</span> <span class="n">CmdSetLegacyComms</span> <span class="c1"># <----</span>
|
||||
|
||||
<span class="k">class</span> <span class="nc">CharacterCmdSet</span><span class="p">(</span><span class="n">default_cmds</span><span class="o">.</span><span class="n">CharacterCmdSet</span><span class="p">):</span>
|
||||
<span class="c1"># ...</span>
|
||||
<span class="k">def</span> <span class="nf">at_cmdset_creation</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="c1"># ...</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">CmdSetLegacyComms</span><span class="p">)</span> <span class="c1"># <----</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.</code><code class="sig-name descname">CmdAddCom</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdAddCom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.comms.html#evennia.commands.default.comms.CmdChannel" title="evennia.commands.default.comms.CmdChannel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.comms.CmdChannel</span></code></a></p>
|
||||
<p>Add a channel alias and/or subscribe to a channel</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>addcom [alias=] <channel></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Joins a given channel. If alias is given, this will allow you to
|
||||
refer to the channel by this alias rather than the full channel
|
||||
name. Subsequent calls of this command can be used to add multiple
|
||||
aliases to an already joined channel.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'addcom'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['aliaschan', 'chanalias']</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.account_caller">
|
||||
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.account_caller" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdAddCom.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Implement the command</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'aliaschan chanalias', 'category': 'comms', 'key': 'addcom', 'no_prefix': ' aliaschan chanalias', 'tags': '', 'text': '\n Add a channel alias and/or subscribe to a channel\n\n Usage:\n addcom [alias=] <channel>\n\n Joins a given channel. If alias is given, this will allow you to\n refer to the channel by this alias rather than the full channel\n name. Subsequent calls of this command can be used to add multiple\n aliases to an already joined channel.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.</code><code class="sig-name descname">CmdDelCom</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdDelCom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.comms.html#evennia.commands.default.comms.CmdChannel" title="evennia.commands.default.comms.CmdChannel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.comms.CmdChannel</span></code></a></p>
|
||||
<p>remove a channel alias and/or unsubscribe from channel</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>delcom <alias or channel>
|
||||
delcom/all <channel></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>If the full channel name is given, unsubscribe from the
|
||||
channel. If an alias is given, remove the alias but don’t
|
||||
unsubscribe. If the ‘all’ switch is used, remove all aliases
|
||||
for that channel.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'delcom'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['delaliaschan', 'delchanalias']</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:not perm(channel_banned)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.account_caller">
|
||||
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.account_caller" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdDelCom.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Implementing the command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:not perm(channel_banned)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'delaliaschan delchanalias', 'category': 'comms', 'key': 'delcom', 'no_prefix': ' delaliaschan delchanalias', 'tags': '', 'text': "\n remove a channel alias and/or unsubscribe from channel\n\n Usage:\n delcom <alias or channel>\n delcom/all <channel>\n\n If the full channel name is given, unsubscribe from the\n channel. If an alias is given, remove the alias but don't\n unsubscribe. If the 'all' switch is used, remove all aliases\n for that channel.\n "}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.</code><code class="sig-name descname">CmdAllCom</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdAllCom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.comms.html#evennia.commands.default.comms.CmdChannel" title="evennia.commands.default.comms.CmdChannel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.comms.CmdChannel</span></code></a></p>
|
||||
<p>perform admin operations on all channels</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>allcom [on | off | who | destroy]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Allows the user to universally turn off or on all channels they are on, as
|
||||
well as perform a ‘who’ for all channels they are on. Destroy deletes all
|
||||
channels that you control.</p>
|
||||
<p>Without argument, works like comlist.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'allcom'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.account_caller">
|
||||
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.account_caller" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdAllCom.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Runs the function</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'allcom', 'no_prefix': ' ', 'tags': '', 'text': "\n perform admin operations on all channels\n\n Usage:\n allcom [on | off | who | destroy]\n\n Allows the user to universally turn off or on all channels they are on, as\n well as perform a 'who' for all channels they are on. Destroy deletes all\n channels that you control.\n\n Without argument, works like comlist.\n "}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAllCom.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.</code><code class="sig-name descname">CmdCdestroy</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdCdestroy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.comms.html#evennia.commands.default.comms.CmdChannel" title="evennia.commands.default.comms.CmdChannel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.comms.CmdChannel</span></code></a></p>
|
||||
<p>destroy a channel you created</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>cdestroy <channel></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Destroys a channel that you control.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'cdestroy'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.account_caller">
|
||||
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.account_caller" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdCdestroy.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Destroy objects cleanly.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'cdestroy', 'no_prefix': ' ', 'tags': '', 'text': '\n destroy a channel you created\n\n Usage:\n cdestroy <channel>\n\n Destroys a channel that you control.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdestroy.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.</code><code class="sig-name descname">CmdCBoot</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdCBoot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.comms.html#evennia.commands.default.comms.CmdChannel" title="evennia.commands.default.comms.CmdChannel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.comms.CmdChannel</span></code></a></p>
|
||||
<p>kick an account from a channel you control</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>cboot[/quiet] <channel> = <account> [:reason]</p>
|
||||
</dd>
|
||||
<dt>Switch:</dt><dd><p>quiet - don’t notify the channel</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Kicks an account or object from a channel you control.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'cboot'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.switch_options">
|
||||
<code class="sig-name descname">switch_options</code><em class="property"> = ('quiet',)</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.switch_options" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.account_caller">
|
||||
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.account_caller" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdCBoot.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>implement the function</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'cboot', 'no_prefix': ' ', 'tags': '', 'text': "\n kick an account from a channel you control\n\n Usage:\n cboot[/quiet] <channel> = <account> [:reason]\n\n Switch:\n quiet - don't notify the channel\n\n Kicks an account or object from a channel you control.\n\n "}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCBoot.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.</code><code class="sig-name descname">CmdCWho</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdCWho"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.comms.html#evennia.commands.default.comms.CmdChannel" title="evennia.commands.default.comms.CmdChannel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.comms.CmdChannel</span></code></a></p>
|
||||
<p>show who is listening to a channel</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>cwho <channel></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>List who is connected to a given channel you have access to.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'cwho'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.account_caller">
|
||||
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.account_caller" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdCWho.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>implement function</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'cwho', 'no_prefix': ' ', 'tags': '', 'text': '\n show who is listening to a channel\n\n Usage:\n cwho <channel>\n\n List who is connected to a given channel you have access to.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCWho.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.</code><code class="sig-name descname">CmdChannelCreate</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdChannelCreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.comms.html#evennia.commands.default.comms.CmdChannel" title="evennia.commands.default.comms.CmdChannel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.comms.CmdChannel</span></code></a></p>
|
||||
<p>create a new channel</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>ccreate <new channel>[;alias;alias…] = description</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Creates a new channel owned by you.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'ccreate'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['channelcreate']</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:not pperm(channel_banned) and pperm(Player)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.account_caller">
|
||||
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.account_caller" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdChannelCreate.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Implement the command</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:not pperm(channel_banned) and pperm(Player)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'channelcreate', 'category': 'comms', 'key': 'ccreate', 'no_prefix': ' channelcreate', 'tags': '', 'text': '\n create a new channel\n\n Usage:\n ccreate <new channel>[;alias;alias...] = description\n\n Creates a new channel owned by you.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdChannelCreate.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.</code><code class="sig-name descname">CmdClock</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdClock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.comms.html#evennia.commands.default.comms.CmdChannel" title="evennia.commands.default.comms.CmdChannel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.comms.CmdChannel</span></code></a></p>
|
||||
<p>change channel locks of a channel you control</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>clock <channel> [= <lockstring>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Changes the lock access restrictions of a channel. If no
|
||||
lockstring was given, view the current lock definitions.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'clock'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:not pperm(channel_banned) and perm(Admin)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.account_caller">
|
||||
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.account_caller" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdClock.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>run the function</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:not pperm(channel_banned) and perm(Admin)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'clock', 'no_prefix': ' ', 'tags': '', 'text': '\n change channel locks of a channel you control\n\n Usage:\n clock <channel> [= <lockstring>]\n\n Changes the lock access restrictions of a channel. If no\n lockstring was given, view the current lock definitions.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdClock.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.</code><code class="sig-name descname">CmdCdesc</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdCdesc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.comms.html#evennia.commands.default.comms.CmdChannel" title="evennia.commands.default.comms.CmdChannel"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.comms.CmdChannel</span></code></a></p>
|
||||
<p>describe a channel you control</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>cdesc <channel> = <description></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Changes the description of the channel as shown in
|
||||
channel lists.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'cdesc'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.account_caller">
|
||||
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.account_caller" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdCdesc.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Implement command</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'cdesc', 'no_prefix': ' ', 'tags': '', 'text': '\n describe a channel you control\n\n Usage:\n cdesc <channel> = <description>\n\n Changes the description of the channel as shown in\n channel lists.\n\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdCdesc.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdSetLegacyComms">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.</code><code class="sig-name descname">CmdSetLegacyComms</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdSetLegacyComms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdSetLegacyComms" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdSetLegacyComms.at_cmdset_createion">
|
||||
<code class="sig-name descname">at_cmdset_createion</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html#CmdSetLegacyComms.at_cmdset_createion"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdSetLegacyComms.at_cmdset_createion" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdSetLegacyComms.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdSetLegacyComms'</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdSetLegacyComms.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,162 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.mux_comms_cmds.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.mux_comms_cmds.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.mux_comms_cmds.tests">
|
||||
<span id="evennia-contrib-base-systems-mux-comms-cmds-tests"></span><h1>evennia.contrib.base_systems.mux_comms_cmds.tests<a class="headerlink" href="#module-evennia.contrib.base_systems.mux_comms_cmds.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Legacy Mux comms tests (extracted from 0.9.5)</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.mux_comms_cmds.tests.</code><code class="sig-name descname">TestLegacyMuxComms</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/tests.html#TestLegacyMuxComms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<p>Test the legacy comms contrib.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/tests.html#TestLegacyMuxComms.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_toggle_com">
|
||||
<code class="sig-name descname">test_toggle_com</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/tests.html#TestLegacyMuxComms.test_toggle_com"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_toggle_com" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_all_com">
|
||||
<code class="sig-name descname">test_all_com</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/tests.html#TestLegacyMuxComms.test_all_com"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_all_com" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_clock">
|
||||
<code class="sig-name descname">test_clock</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/tests.html#TestLegacyMuxComms.test_clock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_clock" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_cdesc">
|
||||
<code class="sig-name descname">test_cdesc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/tests.html#TestLegacyMuxComms.test_cdesc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_cdesc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_cwho">
|
||||
<code class="sig-name descname">test_cwho</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/tests.html#TestLegacyMuxComms.test_cwho"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_cwho" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_cboot">
|
||||
<code class="sig-name descname">test_cboot</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/tests.html#TestLegacyMuxComms.test_cboot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_cboot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_cdestroy">
|
||||
<code class="sig-name descname">test_cdestroy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/mux_comms_cmds/tests.html#TestLegacyMuxComms.test_cdestroy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_cdestroy" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.mux_comms_cmds.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.mux_comms_cmds.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.mux_comms_cmds.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
120
docs/1.0-dev/api/evennia.contrib.base_systems.unixcommand.html
Normal file
120
docs/1.0-dev/api/evennia.contrib.base_systems.unixcommand.html
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.unixcommand — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.unixcommand</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.unixcommand">
|
||||
<span id="evennia-contrib-base-systems-unixcommand"></span><h1>evennia.contrib.base_systems.unixcommand<a class="headerlink" href="#module-evennia.contrib.base_systems.unixcommand" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Unix-like Command style - vlgeoff 2017</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.unixcommand.tests.html">evennia.contrib.base_systems.unixcommand.tests</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.unixcommand.unixcommand.html">evennia.contrib.base_systems.unixcommand.unixcommand</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.unixcommand.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.unixcommand.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.unixcommand</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,176 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.base_systems.unixcommand.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.unixcommand.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.base_systems.unixcommand.tests">
|
||||
<span id="evennia-contrib-base-systems-unixcommand-tests"></span><h1>evennia.contrib.base_systems.unixcommand.tests<a class="headerlink" href="#module-evennia.contrib.base_systems.unixcommand.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Test of the Unixcommand.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.tests.CmdDummy">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.unixcommand.tests.</code><code class="sig-name descname">CmdDummy</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/tests.html#CmdDummy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.tests.CmdDummy" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.base_systems.unixcommand.unixcommand.html#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand" title="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand</span></code></a></p>
|
||||
<p>A dummy UnixCommand.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.tests.CmdDummy.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'dummy'</em><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.tests.CmdDummy.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.tests.CmdDummy.init_parser">
|
||||
<code class="sig-name descname">init_parser</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/tests.html#CmdDummy.init_parser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.tests.CmdDummy.init_parser" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fill out options.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.tests.CmdDummy.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/tests.html#CmdDummy.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.tests.CmdDummy.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Override to handle the command execution.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.tests.CmdDummy.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.tests.CmdDummy.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.tests.CmdDummy.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.tests.CmdDummy.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.tests.CmdDummy.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.tests.CmdDummy.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.tests.CmdDummy.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'dummy', 'no_prefix': ' ', 'tags': '', 'text': 'A dummy UnixCommand.'}</em><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.tests.CmdDummy.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.tests.TestUnixCommand">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.unixcommand.tests.</code><code class="sig-name descname">TestUnixCommand</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/tests.html#TestUnixCommand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.tests.TestUnixCommand" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.tests.TestUnixCommand.test_success">
|
||||
<code class="sig-name descname">test_success</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/tests.html#TestUnixCommand.test_success"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.tests.TestUnixCommand.test_success" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>See the command parsing succeed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.tests.TestUnixCommand.test_failure">
|
||||
<code class="sig-name descname">test_failure</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/tests.html#TestUnixCommand.test_failure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.tests.TestUnixCommand.test_failure" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>If not provided with the right info, should fail.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.unixcommand.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.base_systems.unixcommand.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.unixcommand.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.unixcommand — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.base_systems.unixcommand.unixcommand — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.unixcommand</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.unixcommand.unixcommand</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.unixcommand">
|
||||
<span id="evennia-contrib-unixcommand"></span><h1>evennia.contrib.unixcommand<a class="headerlink" href="#module-evennia.contrib.unixcommand" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.base_systems.unixcommand.unixcommand">
|
||||
<span id="evennia-contrib-base-systems-unixcommand-unixcommand"></span><h1>evennia.contrib.base_systems.unixcommand.unixcommand<a class="headerlink" href="#module-evennia.contrib.base_systems.unixcommand.unixcommand" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Unix-like Command style parent</p>
|
||||
<p>Evennia contribution, Vincent Le Geoff 2017</p>
|
||||
<p>This module contains a command class that allows for unix-style command syntax in-game, using
|
||||
|
|
@ -60,7 +60,10 @@ to override two methods:</p>
|
|||
<li><p>The <strong>func</strong> method, called to execute the command once parsed (like any Command).</p></li>
|
||||
</ul>
|
||||
<p>Here’s a short example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">CmdPlant</span><span class="p">(</span><span class="n">UnixCommand</span><span class="p">):</span>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">evennia.contrib.base_systems.unixcommand</span> <span class="kn">import</span> <span class="n">UnixCommand</span>
|
||||
|
||||
|
||||
<span class="k">class</span> <span class="nc">CmdPlant</span><span class="p">(</span><span class="n">UnixCommand</span><span class="p">):</span>
|
||||
|
||||
<span class="sd">'''</span>
|
||||
<span class="sd"> Plant a tree or plant.</span>
|
||||
|
|
@ -99,15 +102,15 @@ to override two methods:</p>
|
|||
<p>To see the full power of argparse and the types of supported options, visit
|
||||
[the documentation of argparse](<a class="reference external" href="https://docs.python.org/2/library/argparse.html">https://docs.python.org/2/library/argparse.html</a>).</p>
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.unixcommand.ParseError">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">evennia.contrib.unixcommand.</code><code class="sig-name descname">ParseError</code><a class="reference internal" href="../_modules/evennia/contrib/unixcommand.html#ParseError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.unixcommand.ParseError" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.ParseError">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">evennia.contrib.base_systems.unixcommand.unixcommand.</code><code class="sig-name descname">ParseError</code><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/unixcommand.html#ParseError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.ParseError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
|
||||
<p>An error occurred during parsing.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommandParser">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.unixcommand.</code><code class="sig-name descname">UnixCommandParser</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">prog</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">epilog</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">command</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/unixcommand.html#UnixCommandParser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommandParser" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommandParser">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.unixcommand.unixcommand.</code><code class="sig-name descname">UnixCommandParser</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">prog</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">epilog</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">command</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/unixcommand.html#UnixCommandParser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommandParser" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">argparse.ArgumentParser</span></code></p>
|
||||
<p>A modifier command parser for unix commands.</p>
|
||||
<p>This parser is used to replace <strong>argparse.ArgumentParser</strong>. It
|
||||
|
|
@ -117,8 +120,8 @@ parser) are disabled or replaced. This parser is used by UnixCommand
|
|||
and creating one directly isn’t recommended nor necessary. Even
|
||||
adding a sub-command will use this replaced parser automatically.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommandParser.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">prog</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">epilog</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">command</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/unixcommand.html#UnixCommandParser.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommandParser.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommandParser.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">prog</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">epilog</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">command</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/unixcommand.html#UnixCommandParser.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommandParser.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Build a UnixCommandParser with a link to the command using it.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -146,8 +149,8 @@ sub-commands, this class will be used.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommandParser.format_usage">
|
||||
<code class="sig-name descname">format_usage</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/unixcommand.html#UnixCommandParser.format_usage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommandParser.format_usage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommandParser.format_usage">
|
||||
<code class="sig-name descname">format_usage</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/unixcommand.html#UnixCommandParser.format_usage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommandParser.format_usage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the usage line.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
|
|
@ -157,8 +160,8 @@ in order to avoid unintentional color codes.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommandParser.format_help">
|
||||
<code class="sig-name descname">format_help</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/unixcommand.html#UnixCommandParser.format_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommandParser.format_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommandParser.format_help">
|
||||
<code class="sig-name descname">format_help</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/unixcommand.html#UnixCommandParser.format_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommandParser.format_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the parser help, including its epilog.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
|
|
@ -169,8 +172,8 @@ in the epilog (the command docstring) are supported.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommandParser.print_usage">
|
||||
<code class="sig-name descname">print_usage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/unixcommand.html#UnixCommandParser.print_usage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommandParser.print_usage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommandParser.print_usage">
|
||||
<code class="sig-name descname">print_usage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/unixcommand.html#UnixCommandParser.print_usage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommandParser.print_usage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Print the usage to the caller.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -186,8 +189,8 @@ command’s caller.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommandParser.print_help">
|
||||
<code class="sig-name descname">print_help</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/unixcommand.html#UnixCommandParser.print_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommandParser.print_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommandParser.print_help">
|
||||
<code class="sig-name descname">print_help</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/unixcommand.html#UnixCommandParser.print_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommandParser.print_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Print the help to the caller.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -205,8 +208,8 @@ command’s caller.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.unixcommand.HelpAction">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.unixcommand.</code><code class="sig-name descname">HelpAction</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">option_strings</span></em>, <em class="sig-param"><span class="n">dest</span></em>, <em class="sig-param"><span class="n">nargs</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">const</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">default</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">choices</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">required</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">help</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metavar</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/unixcommand.html#HelpAction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.unixcommand.HelpAction" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.HelpAction">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.unixcommand.unixcommand.</code><code class="sig-name descname">HelpAction</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">option_strings</span></em>, <em class="sig-param"><span class="n">dest</span></em>, <em class="sig-param"><span class="n">nargs</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">const</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">default</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">choices</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">required</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">help</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metavar</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/unixcommand.html#HelpAction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.HelpAction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">argparse.Action</span></code></p>
|
||||
<p>Override the -h/–help action in the default parser.</p>
|
||||
<p>Using the default -h/–help will call the exit function in different
|
||||
|
|
@ -215,8 +218,8 @@ this override.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommand">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.unixcommand.</code><code class="sig-name descname">UnixCommand</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/unixcommand.html#UnixCommand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommand" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.unixcommand.unixcommand.</code><code class="sig-name descname">UnixCommand</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/unixcommand.html#UnixCommand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Unix-type commands, supporting short and long options.</p>
|
||||
<p>This command syntax uses the Unix-style commands with short options
|
||||
|
|
@ -247,16 +250,16 @@ accordingly. The <strong>argparse</strong> module provides a default ‘-h’ o
|
|||
display the same as <a href="#id3"><span class="problematic" id="id4">|</span></a>wcommandname -h|n, though this behavior can
|
||||
be changed.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommand.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/unixcommand.html#UnixCommand.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommand.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/unixcommand.html#UnixCommand.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The lockhandler works the same as for objects.
|
||||
optional kwargs will be set as properties on the Command at runtime,
|
||||
overloading evential same-named class properties.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommand.init_parser">
|
||||
<code class="sig-name descname">init_parser</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/unixcommand.html#UnixCommand.init_parser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommand.init_parser" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.init_parser">
|
||||
<code class="sig-name descname">init_parser</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/unixcommand.html#UnixCommand.init_parser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.init_parser" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Configure the argument parser, adding in options.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
|
|
@ -268,14 +271,14 @@ use its <strong>add_argument</strong> method.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommand.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/unixcommand.html#UnixCommand.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommand.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/unixcommand.html#UnixCommand.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Override to handle the command execution.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommand.get_help">
|
||||
<code class="sig-name descname">get_help</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">cmdset</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/unixcommand.html#UnixCommand.get_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommand.get_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.get_help">
|
||||
<code class="sig-name descname">get_help</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">cmdset</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/unixcommand.html#UnixCommand.get_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.get_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the help message for this command and this caller.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -291,8 +294,8 @@ use its <strong>add_argument</strong> method.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommand.parse">
|
||||
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/unixcommand.html#UnixCommand.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommand.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.parse">
|
||||
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/unixcommand/unixcommand.html#UnixCommand.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Process arguments provided in <strong>self.args</strong>.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
|
|
@ -302,28 +305,28 @@ use its <strong>add_argument</strong> method.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommand.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommand.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommand.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommand.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommand.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'command'</em><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommand.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'command'</em><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommand.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommand.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.unixcommand.UnixCommand.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'command', 'no_prefix': ' ', 'tags': '', 'text': '\n Unix-type commands, supporting short and long options.\n\n This command syntax uses the Unix-style commands with short options\n (-X) and long options (--something). The `argparse` module is\n used to parse the command.\n\n In order to use it, you should override two methods:\n - `init_parser`: this method is called when the command is created.\n It can be used to set options in the parser. `self.parser`\n contains the `argparse.ArgumentParser`, so you can add arguments\n here.\n - `func`: this method is called to execute the command, but after\n the parser has checked the arguments given to it are valid.\n You can access the namespace of valid arguments in `self.opts`\n at this point.\n\n The help of UnixCommands is derived from the docstring, in a\n slightly different way than usual: the first line of the docstring\n is used to represent the program description (the very short\n line at the top of the help message). The other lines below are\n used as the program\'s "epilog", displayed below the options. It\n means in your docstring, you don\'t have to write the options.\n They will be automatically provided by the parser and displayed\n accordingly. The `argparse` module provides a default \'-h\' or\n \'--help\' option on the command. Typing |whelp commandname|n will\n display the same as |wcommandname -h|n, though this behavior can\n be changed.\n\n '}</em><a class="headerlink" href="#evennia.contrib.unixcommand.UnixCommand.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'command', 'no_prefix': ' ', 'tags': '', 'text': '\n Unix-type commands, supporting short and long options.\n\n This command syntax uses the Unix-style commands with short options\n (-X) and long options (--something). The `argparse` module is\n used to parse the command.\n\n In order to use it, you should override two methods:\n - `init_parser`: this method is called when the command is created.\n It can be used to set options in the parser. `self.parser`\n contains the `argparse.ArgumentParser`, so you can add arguments\n here.\n - `func`: this method is called to execute the command, but after\n the parser has checked the arguments given to it are valid.\n You can access the namespace of valid arguments in `self.opts`\n at this point.\n\n The help of UnixCommands is derived from the docstring, in a\n slightly different way than usual: the first line of the docstring\n is used to represent the program description (the very short\n line at the top of the help message). The other lines below are\n used as the program\'s "epilog", displayed below the options. It\n means in your docstring, you don\'t have to write the options.\n They will be automatically provided by the parser and displayed\n accordingly. The `argparse` module provides a default \'-h\' or\n \'--help\' option on the command. Typing |whelp commandname|n will\n display the same as |wcommandname -h|n, though this behavior can\n be changed.\n\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -353,7 +356,7 @@ use its <strong>add_argument</strong> method.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.unixcommand.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.base_systems.unixcommand.unixcommand.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -369,8 +372,8 @@ use its <strong>add_argument</strong> method.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.unixcommand.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.unixcommand.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.base_systems.unixcommand.unixcommand.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -387,7 +390,7 @@ use its <strong>add_argument</strong> method.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.unixcommand</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.unixcommand.unixcommand</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -1,256 +0,0 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.chargen — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.chargen</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.chargen">
|
||||
<span id="evennia-contrib-chargen"></span><h1>evennia.contrib.chargen<a class="headerlink" href="#module-evennia.contrib.chargen" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Contribution - Griatch 2011</p>
|
||||
<p>> Note - with the advent of MULTISESSION_MODE=2, this is not really as
|
||||
necessary anymore - the ooclook and @charcreate commands in that mode
|
||||
replaces this module with better functionality. This remains here for
|
||||
inspiration.</p>
|
||||
<p>This is a simple character creation commandset for the Account level.
|
||||
It shows some more info and gives the Account the option to create a
|
||||
character without any more customizations than their name (further
|
||||
options are unique for each game anyway).</p>
|
||||
<p>In MULTISESSION_MODEs 0 and 1, you will automatically log into an
|
||||
existing Character. When using <strong>@ooc</strong> you will then end up in this
|
||||
cmdset.</p>
|
||||
<p>Installation:</p>
|
||||
<p>Import this module to <strong>mygame/commands/default_cmdsets.py</strong> and
|
||||
add <strong>chargen.OOCCMdSetCharGen</strong> to the <strong>AccountCmdSet</strong> class
|
||||
(it says where to add it). Reload.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCLook">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.chargen.</code><code class="sig-name descname">CmdOOCLook</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/chargen.html#CmdOOCLook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.general.html#evennia.commands.default.general.CmdLook" title="evennia.commands.default.general.CmdLook"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.general.CmdLook</span></code></a></p>
|
||||
<p>ooc look</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>look
|
||||
look <character></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>This is an OOC version of the look command. Since an Account doesn’t
|
||||
have an in-game existence, there is no concept of location or
|
||||
“self”.</p>
|
||||
<p>If any characters are available for you to control, you may look
|
||||
at them with this command.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCLook.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'look'</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCLook.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCLook.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCLook.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/chargen.html#CmdOOCLook.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Implements the ooc look command</p>
|
||||
<p>We use an attribute _character_dbrefs on the account in order
|
||||
to figure out which characters are “theirs”. A drawback of this
|
||||
is that only the CmdCharacterCreate command adds this attribute,
|
||||
and thus e.g. account #1 will not be listed (although it will work).
|
||||
Existence in this list does not depend on puppeting rights though,
|
||||
that is checked by the @ic command directly.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCLook.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n ooc look\n\n Usage:\n look\n look <character>\n\n This is an OOC version of the look command. Since an Account doesn\'t\n have an in-game existence, there is no concept of location or\n "self".\n\n If any characters are available for you to control, you may look\n at them with this command.\n '}</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCCharacterCreate">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.chargen.</code><code class="sig-name descname">CmdOOCCharacterCreate</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/chargen.html#CmdOOCCharacterCreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCCharacterCreate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>creates a character</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>create <character name></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>This will create a new character, assuming
|
||||
the given character name does not already exist.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCCharacterCreate.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'create'</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCCharacterCreate.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCCharacterCreate.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCCharacterCreate.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCCharacterCreate.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/chargen.html#CmdOOCCharacterCreate.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCCharacterCreate.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Tries to create the Character object. We also put an
|
||||
attribute on ourselves to remember it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCCharacterCreate.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCCharacterCreate.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCCharacterCreate.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCCharacterCreate.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCCharacterCreate.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCCharacterCreate.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.chargen.CmdOOCCharacterCreate.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'create', 'no_prefix': ' ', 'tags': '', 'text': '\n creates a character\n\n Usage:\n create <character name>\n\n This will create a new character, assuming\n the given character name does not already exist.\n '}</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCCharacterCreate.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.chargen.OOCCmdSetCharGen">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.chargen.</code><code class="sig-name descname">OOCCmdSetCharGen</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/chargen.html#OOCCmdSetCharGen"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.chargen.OOCCmdSetCharGen" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.cmdset_account.html#evennia.commands.default.cmdset_account.AccountCmdSet" title="evennia.commands.default.cmdset_account.AccountCmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.cmdset_account.AccountCmdSet</span></code></a></p>
|
||||
<p>Extends the default OOC cmdset.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.chargen.OOCCmdSetCharGen.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/chargen.html#OOCCmdSetCharGen.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.chargen.OOCCmdSetCharGen.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Install everything from the default set, then overload</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.chargen.OOCCmdSetCharGen.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.chargen.OOCCmdSetCharGen'</em><a class="headerlink" href="#evennia.contrib.chargen.OOCCmdSetCharGen.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.chargen.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.chargen.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.chargen.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.chargen</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,326 +0,0 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.crafting.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.crafting.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.crafting.tests">
|
||||
<span id="evennia-contrib-crafting-tests"></span><h1>evennia.contrib.crafting.tests<a class="headerlink" href="#module-evennia.contrib.crafting.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Unit tests for the crafting system contrib.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftUtils">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.tests.</code><code class="sig-name descname">TestCraftUtils</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftUtils"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftUtils" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.test.testcases.TestCase</span></code></p>
|
||||
<p>Test helper utils for crafting.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftUtils.maxDiff">
|
||||
<code class="sig-name descname">maxDiff</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftUtils.maxDiff" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftUtils.test_load_recipes">
|
||||
<code class="sig-name descname">test_load_recipes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftUtils.test_load_recipes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftUtils.test_load_recipes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This should only load the example module now</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipeBase">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.tests.</code><code class="sig-name descname">TestCraftingRecipeBase</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipeBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipeBase" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.test.testcases.TestCase</span></code></p>
|
||||
<p>Test the parent recipe class.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipeBase.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipeBase.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipeBase.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipeBase.test_msg">
|
||||
<code class="sig-name descname">test_msg</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipeBase.test_msg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipeBase.test_msg" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test messaging to crafter</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipeBase.test_pre_craft">
|
||||
<code class="sig-name descname">test_pre_craft</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipeBase.test_pre_craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipeBase.test_pre_craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test validating hook</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipeBase.test_pre_craft_fail">
|
||||
<code class="sig-name descname">test_pre_craft_fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipeBase.test_pre_craft_fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipeBase.test_pre_craft_fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Should rase error if validation fails</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipeBase.test_craft_hook__succeed">
|
||||
<code class="sig-name descname">test_craft_hook__succeed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipeBase.test_craft_hook__succeed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipeBase.test_craft_hook__succeed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test craft hook, the main access method.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipeBase.test_craft_hook__fail">
|
||||
<code class="sig-name descname">test_craft_hook__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipeBase.test_craft_hook__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipeBase.test_craft_hook__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test failing the call</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.tests.</code><code class="sig-name descname">TestCraftingRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.test.testcases.TestCase</span></code></p>
|
||||
<p>Test the CraftingRecipe class with one recipe</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.maxDiff">
|
||||
<code class="sig-name descname">maxDiff</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.maxDiff" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.test_error_format">
|
||||
<code class="sig-name descname">test_error_format</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.test_error_format"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.test_error_format" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the automatic error formatter</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft__success">
|
||||
<code class="sig-name descname">test_craft__success</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.test_craft__success"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft__success" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test to create a result from the recipe</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.test_seed__success">
|
||||
<code class="sig-name descname">test_seed__success</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.test_seed__success"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.test_seed__success" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test seed helper classmethod</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_missing_tool__fail">
|
||||
<code class="sig-name descname">test_craft_missing_tool__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.test_craft_missing_tool__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_missing_tool__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail craft by missing tool2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_missing_cons__fail">
|
||||
<code class="sig-name descname">test_craft_missing_cons__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.test_craft_missing_cons__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_missing_cons__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail craft by missing cons3</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_missing_cons__always_consume__fail">
|
||||
<code class="sig-name descname">test_craft_missing_cons__always_consume__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.test_craft_missing_cons__always_consume__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_missing_cons__always_consume__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail craft by missing cons3, with always-consume flag</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_wrong_tool__fail">
|
||||
<code class="sig-name descname">test_craft_wrong_tool__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.test_craft_wrong_tool__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_wrong_tool__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail craft by including a wrong tool</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_tool_excess__fail">
|
||||
<code class="sig-name descname">test_craft_tool_excess__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.test_craft_tool_excess__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_tool_excess__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail by too many consumables</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_cons_excess__fail">
|
||||
<code class="sig-name descname">test_craft_cons_excess__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.test_craft_cons_excess__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_cons_excess__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail by too many consumables</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_tool_excess__sucess">
|
||||
<code class="sig-name descname">test_craft_tool_excess__sucess</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.test_craft_tool_excess__sucess"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_tool_excess__sucess" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Allow too many consumables</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_cons_excess__sucess">
|
||||
<code class="sig-name descname">test_craft_cons_excess__sucess</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.test_craft_cons_excess__sucess"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_cons_excess__sucess" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Allow too many consumables</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_tool_order__fail">
|
||||
<code class="sig-name descname">test_craft_tool_order__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.test_craft_tool_order__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_tool_order__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Strict tool-order recipe fail</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_cons_order__fail">
|
||||
<code class="sig-name descname">test_craft_cons_order__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftingRecipe.test_craft_cons_order__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftingRecipe.test_craft_cons_order__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Strict tool-order recipe fail</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftSword">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.tests.</code><code class="sig-name descname">TestCraftSword</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftSword"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftSword" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.test.testcases.TestCase</span></code></p>
|
||||
<p>Test the <strong>craft</strong> function by crafting the example sword.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftSword.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftSword.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftSword.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftSword.test_craft_sword">
|
||||
<code class="sig-name descname">test_craft_sword</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mockrandom</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftSword.test_craft_sword"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftSword.test_craft_sword" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Craft example sword. For the test, every crafting works.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftCommand">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.tests.</code><code class="sig-name descname">TestCraftCommand</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftCommand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftCommand" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<p>Test the crafting command</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftCommand.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftCommand.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftCommand.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftCommand.test_craft__success">
|
||||
<code class="sig-name descname">test_craft__success</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftCommand.test_craft__success"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftCommand.test_craft__success" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Successfully craft using command</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftCommand.test_craft__notools__failure">
|
||||
<code class="sig-name descname">test_craft__notools__failure</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftCommand.test_craft__notools__failure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftCommand.test_craft__notools__failure" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Craft fail no tools</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.tests.TestCraftCommand.test_craft__nocons__failure">
|
||||
<code class="sig-name descname">test_craft__nocons__failure</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/tests.html#TestCraftCommand.test_craft__nocons__failure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.tests.TestCraftCommand.test_craft__nocons__failure" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.crafting.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.crafting.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.crafting.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -1,223 +0,0 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.evscaperoom.menu — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.evscaperoom.menu</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.evscaperoom.menu">
|
||||
<span id="evennia-contrib-evscaperoom-menu"></span><h1>evennia.contrib.evscaperoom.menu<a class="headerlink" href="#module-evennia.contrib.evscaperoom.menu" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Start menu</p>
|
||||
<p>This is started from the <strong>evscaperoom</strong> command.</p>
|
||||
<p>Here player user can set their own description as well as select to create a
|
||||
new room (to start from scratch) or join an existing room (with other players).</p>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.evscaperoom.menu.node_set_desc">
|
||||
<code class="sig-prename descclassname">evennia.contrib.evscaperoom.menu.</code><code class="sig-name descname">node_set_desc</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/menu.html#node_set_desc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.menu.node_set_desc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.evscaperoom.menu.node_create_room">
|
||||
<code class="sig-prename descclassname">evennia.contrib.evscaperoom.menu.</code><code class="sig-name descname">node_create_room</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/menu.html#node_create_room"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.menu.node_create_room" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.evscaperoom.menu.node_join_room">
|
||||
<code class="sig-prename descclassname">evennia.contrib.evscaperoom.menu.</code><code class="sig-name descname">node_join_room</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/menu.html#node_join_room"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.menu.node_join_room" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.evscaperoom.menu.node_quit">
|
||||
<code class="sig-prename descclassname">evennia.contrib.evscaperoom.menu.</code><code class="sig-name descname">node_quit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/menu.html#node_quit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.menu.node_quit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.evscaperoom.menu.EvscaperoomMenu">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.evscaperoom.menu.</code><code class="sig-name descname">EvscaperoomMenu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">menudata</span></em>, <em class="sig-param"><span class="n">startnode</span><span class="o">=</span><span class="default_value">'start'</span></em>, <em class="sig-param"><span class="n">cmdset_mergetype</span><span class="o">=</span><span class="default_value">'Replace'</span></em>, <em class="sig-param"><span class="n">cmdset_priority</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">auto_quit</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">auto_look</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">auto_help</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">cmd_on_exit</span><span class="o">=</span><span class="default_value">'look'</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">startnode_input</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">session</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">debug</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/menu.html#EvscaperoomMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.menu.EvscaperoomMenu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.evmenu.html#evennia.utils.evmenu.EvMenu" title="evennia.utils.evmenu.EvMenu"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.evmenu.EvMenu</span></code></a></p>
|
||||
<p>Custom menu with a different formatting of options.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.menu.EvscaperoomMenu.node_border_char">
|
||||
<code class="sig-name descname">node_border_char</code><em class="property"> = '~'</em><a class="headerlink" href="#evennia.contrib.evscaperoom.menu.EvscaperoomMenu.node_border_char" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.menu.EvscaperoomMenu.nodetext_formatter">
|
||||
<code class="sig-name descname">nodetext_formatter</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">text</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/menu.html#EvscaperoomMenu.nodetext_formatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.menu.EvscaperoomMenu.nodetext_formatter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Format the node text itself.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>nodetext</strong> (<em>str</em>) – The full node text (the text describing the node).</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>nodetext (str)</em> – The formatted node text.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.menu.EvscaperoomMenu.options_formatter">
|
||||
<code class="sig-name descname">options_formatter</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">optionlist</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/menu.html#EvscaperoomMenu.options_formatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.menu.EvscaperoomMenu.options_formatter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Formats the option block.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>optionlist</strong> (<em>list</em>) – List of (key, description) tuples for every
|
||||
option related to this node.</p></li>
|
||||
<li><p><strong>caller</strong> (<em>Object</em><em>, </em><em>Account</em><em> or </em><em>None</em><em>, </em><em>optional</em>) – The caller of the node.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>options (str)</em> – The formatted option display.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.evscaperoom.menu.run_evscaperoom_menu">
|
||||
<code class="sig-prename descclassname">evennia.contrib.evscaperoom.menu.</code><code class="sig-name descname">run_evscaperoom_menu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/menu.html#run_evscaperoom_menu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.menu.run_evscaperoom_menu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Run room selection menu</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.evscaperoom.menu.node_options">
|
||||
<code class="sig-prename descclassname">evennia.contrib.evscaperoom.menu.</code><code class="sig-name descname">node_options</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/menu.html#node_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.menu.node_options" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.evscaperoom.menu.OptionsMenu">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.evscaperoom.menu.</code><code class="sig-name descname">OptionsMenu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">menudata</span></em>, <em class="sig-param"><span class="n">startnode</span><span class="o">=</span><span class="default_value">'start'</span></em>, <em class="sig-param"><span class="n">cmdset_mergetype</span><span class="o">=</span><span class="default_value">'Replace'</span></em>, <em class="sig-param"><span class="n">cmdset_priority</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">auto_quit</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">auto_look</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">auto_help</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">cmd_on_exit</span><span class="o">=</span><span class="default_value">'look'</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">startnode_input</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">session</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">debug</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/menu.html#OptionsMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.menu.OptionsMenu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.evmenu.html#evennia.utils.evmenu.EvMenu" title="evennia.utils.evmenu.EvMenu"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.evmenu.EvMenu</span></code></a></p>
|
||||
<p>Custom display of Option menu</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.menu.OptionsMenu.node_formatter">
|
||||
<code class="sig-name descname">node_formatter</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">nodetext</span></em>, <em class="sig-param"><span class="n">optionstext</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/menu.html#OptionsMenu.node_formatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.menu.OptionsMenu.node_formatter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Formats the entirety of the node.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>nodetext</strong> (<em>str</em>) – The node text as returned by <strong>self.nodetext_formatter</strong>.</p></li>
|
||||
<li><p><strong>optionstext</strong> (<em>str</em>) – The options display as returned by <strong>self.options_formatter</strong>.</p></li>
|
||||
<li><p><strong>caller</strong> (<em>Object</em><em>, </em><em>Account</em><em> or </em><em>None</em><em>, </em><em>optional</em>) – The caller of the node.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>node (str)</em> – The formatted node to display.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.evscaperoom.menu.run_option_menu">
|
||||
<code class="sig-prename descclassname">evennia.contrib.evscaperoom.menu.</code><code class="sig-name descname">run_option_menu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">session</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/menu.html#run_option_menu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.menu.run_option_menu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Run option menu in-game</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.evscaperoom.menu.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.evscaperoom.menu.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.evscaperoom.menu</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -1,239 +0,0 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.evscaperoom.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.evscaperoom.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.evscaperoom.tests">
|
||||
<span id="evennia-contrib-evscaperoom-tests"></span><h1>evennia.contrib.evscaperoom.tests<a class="headerlink" href="#module-evennia.contrib.evscaperoom.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Unit tests for the Evscaperoom</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.evscaperoom.tests.</code><code class="sig-name descname">TestEvscaperoomCommands</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestEvscaperoomCommands"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.CommandTest" title="evennia.commands.default.tests.CommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.CommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestEvscaperoomCommands.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_base_search">
|
||||
<code class="sig-name descname">test_base_search</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestEvscaperoomCommands.test_base_search"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_base_search" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_base_parse">
|
||||
<code class="sig-name descname">test_base_parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestEvscaperoomCommands.test_base_parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_base_parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_set_focus">
|
||||
<code class="sig-name descname">test_set_focus</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestEvscaperoomCommands.test_set_focus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_set_focus" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_focus">
|
||||
<code class="sig-name descname">test_focus</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestEvscaperoomCommands.test_focus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_focus" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_look">
|
||||
<code class="sig-name descname">test_look</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestEvscaperoomCommands.test_look"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_look" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_speech">
|
||||
<code class="sig-name descname">test_speech</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestEvscaperoomCommands.test_speech"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_speech" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_emote">
|
||||
<code class="sig-name descname">test_emote</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestEvscaperoomCommands.test_emote"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_emote" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_focus_interaction">
|
||||
<code class="sig-name descname">test_focus_interaction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestEvscaperoomCommands.test_focus_interaction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestEvscaperoomCommands.test_focus_interaction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestUtils">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.evscaperoom.tests.</code><code class="sig-name descname">TestUtils</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestUtils"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestUtils" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.EvenniaTest" title="evennia.utils.test_resources.EvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.EvenniaTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestUtils.test_overwrite">
|
||||
<code class="sig-name descname">test_overwrite</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestUtils.test_overwrite"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestUtils.test_overwrite" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestUtils.test_parse_for_perspectives">
|
||||
<code class="sig-name descname">test_parse_for_perspectives</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestUtils.test_parse_for_perspectives"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestUtils.test_parse_for_perspectives" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestUtils.test_parse_for_things">
|
||||
<code class="sig-name descname">test_parse_for_things</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestUtils.test_parse_for_things"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestUtils.test_parse_for_things" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestEvScapeRoom">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.evscaperoom.tests.</code><code class="sig-name descname">TestEvScapeRoom</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestEvScapeRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestEvScapeRoom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.EvenniaTest" title="evennia.utils.test_resources.EvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.EvenniaTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestEvScapeRoom.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestEvScapeRoom.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestEvScapeRoom.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestEvScapeRoom.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestEvScapeRoom.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestEvScapeRoom.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestEvScapeRoom.test_room_methods">
|
||||
<code class="sig-name descname">test_room_methods</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestEvScapeRoom.test_room_methods"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestEvScapeRoom.test_room_methods" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestStates">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.evscaperoom.tests.</code><code class="sig-name descname">TestStates</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestStates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestStates" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.EvenniaTest" title="evennia.utils.test_resources.EvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.EvenniaTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestStates.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestStates.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestStates.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestStates.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestStates.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestStates.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestStates.test_base_state">
|
||||
<code class="sig-name descname">test_base_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestStates.test_base_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestStates.test_base_state" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.tests.TestStates.test_all_states">
|
||||
<code class="sig-name descname">test_all_states</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/tests.html#TestStates.test_all_states"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.tests.TestStates.test_all_states" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Tick through all defined states</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.evscaperoom.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.evscaperoom.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.evscaperoom.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load diff
126
docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.html
Normal file
126
docs/1.0-dev/api/evennia.contrib.full_systems.evscaperoom.html
Normal file
|
|
@ -0,0 +1,126 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.full_systems.evscaperoom — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.full_systems.evscaperoom">
|
||||
<span id="evennia-contrib-full-systems-evscaperoom"></span><h1>evennia.contrib.full_systems.evscaperoom<a class="headerlink" href="#module-evennia.contrib.full_systems.evscaperoom" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Evscaperoom - Griatch 2019</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.commands.html">evennia.contrib.full_systems.evscaperoom.commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.menu.html">evennia.contrib.full_systems.evscaperoom.menu</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.objects.html">evennia.contrib.full_systems.evscaperoom.objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.room.html">evennia.contrib.full_systems.evscaperoom.room</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.scripts.html">evennia.contrib.full_systems.evscaperoom.scripts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.state.html">evennia.contrib.full_systems.evscaperoom.state</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.tests.html">evennia.contrib.full_systems.evscaperoom.tests</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.utils.html">evennia.contrib.full_systems.evscaperoom.utils</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.full_systems.evscaperoom.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.full_systems.evscaperoom.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,223 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.full_systems.evscaperoom.menu — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.menu</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.full_systems.evscaperoom.menu">
|
||||
<span id="evennia-contrib-full-systems-evscaperoom-menu"></span><h1>evennia.contrib.full_systems.evscaperoom.menu<a class="headerlink" href="#module-evennia.contrib.full_systems.evscaperoom.menu" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Start menu</p>
|
||||
<p>This is started from the <strong>evscaperoom</strong> command.</p>
|
||||
<p>Here player user can set their own description as well as select to create a
|
||||
new room (to start from scratch) or join an existing room (with other players).</p>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.menu.node_set_desc">
|
||||
<code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><code class="sig-name descname">node_set_desc</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#node_set_desc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.menu.node_set_desc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.menu.node_create_room">
|
||||
<code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><code class="sig-name descname">node_create_room</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#node_create_room"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.menu.node_create_room" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.menu.node_join_room">
|
||||
<code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><code class="sig-name descname">node_join_room</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#node_join_room"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.menu.node_join_room" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.menu.node_quit">
|
||||
<code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><code class="sig-name descname">node_quit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#node_quit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.menu.node_quit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.menu.EvscaperoomMenu">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><code class="sig-name descname">EvscaperoomMenu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">menudata</span></em>, <em class="sig-param"><span class="n">startnode</span><span class="o">=</span><span class="default_value">'start'</span></em>, <em class="sig-param"><span class="n">cmdset_mergetype</span><span class="o">=</span><span class="default_value">'Replace'</span></em>, <em class="sig-param"><span class="n">cmdset_priority</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">auto_quit</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">auto_look</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">auto_help</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">cmd_on_exit</span><span class="o">=</span><span class="default_value">'look'</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">startnode_input</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">session</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">debug</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#EvscaperoomMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.menu.EvscaperoomMenu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.evmenu.html#evennia.utils.evmenu.EvMenu" title="evennia.utils.evmenu.EvMenu"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.evmenu.EvMenu</span></code></a></p>
|
||||
<p>Custom menu with a different formatting of options.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.menu.EvscaperoomMenu.node_border_char">
|
||||
<code class="sig-name descname">node_border_char</code><em class="property"> = '~'</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.menu.EvscaperoomMenu.node_border_char" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.menu.EvscaperoomMenu.nodetext_formatter">
|
||||
<code class="sig-name descname">nodetext_formatter</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">text</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#EvscaperoomMenu.nodetext_formatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.menu.EvscaperoomMenu.nodetext_formatter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Format the node text itself.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>nodetext</strong> (<em>str</em>) – The full node text (the text describing the node).</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>nodetext (str)</em> – The formatted node text.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.menu.EvscaperoomMenu.options_formatter">
|
||||
<code class="sig-name descname">options_formatter</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">optionlist</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#EvscaperoomMenu.options_formatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.menu.EvscaperoomMenu.options_formatter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Formats the option block.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>optionlist</strong> (<em>list</em>) – List of (key, description) tuples for every
|
||||
option related to this node.</p></li>
|
||||
<li><p><strong>caller</strong> (<em>Object</em><em>, </em><em>Account</em><em> or </em><em>None</em><em>, </em><em>optional</em>) – The caller of the node.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>options (str)</em> – The formatted option display.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.menu.run_evscaperoom_menu">
|
||||
<code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><code class="sig-name descname">run_evscaperoom_menu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#run_evscaperoom_menu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.menu.run_evscaperoom_menu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Run room selection menu</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.menu.node_options">
|
||||
<code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><code class="sig-name descname">node_options</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#node_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.menu.node_options" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.menu.OptionsMenu">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><code class="sig-name descname">OptionsMenu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">menudata</span></em>, <em class="sig-param"><span class="n">startnode</span><span class="o">=</span><span class="default_value">'start'</span></em>, <em class="sig-param"><span class="n">cmdset_mergetype</span><span class="o">=</span><span class="default_value">'Replace'</span></em>, <em class="sig-param"><span class="n">cmdset_priority</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">auto_quit</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">auto_look</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">auto_help</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">cmd_on_exit</span><span class="o">=</span><span class="default_value">'look'</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">startnode_input</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">session</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">debug</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#OptionsMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.menu.OptionsMenu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.evmenu.html#evennia.utils.evmenu.EvMenu" title="evennia.utils.evmenu.EvMenu"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.evmenu.EvMenu</span></code></a></p>
|
||||
<p>Custom display of Option menu</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.menu.OptionsMenu.node_formatter">
|
||||
<code class="sig-name descname">node_formatter</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">nodetext</span></em>, <em class="sig-param"><span class="n">optionstext</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#OptionsMenu.node_formatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.menu.OptionsMenu.node_formatter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Formats the entirety of the node.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>nodetext</strong> (<em>str</em>) – The node text as returned by <strong>self.nodetext_formatter</strong>.</p></li>
|
||||
<li><p><strong>optionstext</strong> (<em>str</em>) – The options display as returned by <strong>self.options_formatter</strong>.</p></li>
|
||||
<li><p><strong>caller</strong> (<em>Object</em><em>, </em><em>Account</em><em> or </em><em>None</em><em>, </em><em>optional</em>) – The caller of the node.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>node (str)</em> – The formatted node to display.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.menu.run_option_menu">
|
||||
<code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.menu.</code><code class="sig-name descname">run_option_menu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">session</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/menu.html#run_option_menu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.menu.run_option_menu" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Run option menu in-game</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.full_systems.evscaperoom.menu.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.full_systems.evscaperoom.menu.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.menu</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.evscaperoom.room — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.full_systems.evscaperoom.room — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.evscaperoom.room</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.room</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,55 +40,55 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.evscaperoom.room">
|
||||
<span id="evennia-contrib-evscaperoom-room"></span><h1>evennia.contrib.evscaperoom.room<a class="headerlink" href="#module-evennia.contrib.evscaperoom.room" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.full_systems.evscaperoom.room">
|
||||
<span id="evennia-contrib-full-systems-evscaperoom-room"></span><h1>evennia.contrib.full_systems.evscaperoom.room<a class="headerlink" href="#module-evennia.contrib.full_systems.evscaperoom.room" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Room class and mechanics for the Evscaperoom.</p>
|
||||
<p>This is a special room class that not only depicts the evscaperoom itself, it
|
||||
also acts as a central store for the room state, score etc. When deleting this,
|
||||
that particular escaperoom challenge should be gone.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.evscaperoom.room.</code><code class="sig-name descname">EvscapeRoom</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.evscaperoom.objects.html#evennia.contrib.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.evscaperoom.objects.EvscaperoomObject</span></code></a>, <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultRoom" title="evennia.objects.objects.DefaultRoom"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultRoom</span></code></a></p>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.room.</code><code class="sig-name descname">EvscapeRoom</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.objects.html#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject</span></code></a>, <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultRoom" title="evennia.objects.objects.DefaultRoom"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultRoom</span></code></a></p>
|
||||
<p>The room to escape from.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.at_object_creation">
|
||||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.at_object_creation">
|
||||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called once, when the room is first created.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.statehandler">
|
||||
<code class="sig-name descname">statehandler</code><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.statehandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.statehandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.statehandler">
|
||||
<code class="sig-name descname">statehandler</code><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.statehandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.statehandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.state">
|
||||
<em class="property">property </em><code class="sig-name descname">state</code><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.state" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.state">
|
||||
<em class="property">property </em><code class="sig-name descname">state</code><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.state" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.log">
|
||||
<code class="sig-name descname">log</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.log" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.log">
|
||||
<code class="sig-name descname">log</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="n">caller</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.log" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Log to a file specificially for this room.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.score">
|
||||
<code class="sig-name descname">score</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">new_score</span></em>, <em class="sig-param"><span class="n">reason</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.score"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.score" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.score">
|
||||
<code class="sig-name descname">score</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">new_score</span></em>, <em class="sig-param"><span class="n">reason</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.score"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.score" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>We don’t score individually but for everyone in room together.
|
||||
You can only be scored for a given reason once.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.progress">
|
||||
<code class="sig-name descname">progress</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">new_progress</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.progress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.progress" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.progress">
|
||||
<code class="sig-name descname">progress</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">new_progress</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.progress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.progress" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Progress is what we set it to be (0-100%)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.achievement">
|
||||
<code class="sig-name descname">achievement</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">achievement</span></em>, <em class="sig-param"><span class="n">subtext</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.achievement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.achievement" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.achievement">
|
||||
<code class="sig-name descname">achievement</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">achievement</span></em>, <em class="sig-param"><span class="n">subtext</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.achievement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.achievement" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Give the caller a personal achievment. You will only
|
||||
ever get one of the same type</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -104,8 +104,8 @@ of the achievement.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.get_all_characters">
|
||||
<code class="sig-name descname">get_all_characters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.get_all_characters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.get_all_characters" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.get_all_characters">
|
||||
<code class="sig-name descname">get_all_characters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.get_all_characters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.get_all_characters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the player characters in the room.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -115,31 +115,31 @@ of the achievement.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.set_flag">
|
||||
<code class="sig-name descname">set_flag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flagname</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.set_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.set_flag" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.set_flag">
|
||||
<code class="sig-name descname">set_flag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flagname</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.set_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.set_flag" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set flag on object</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.unset_flag">
|
||||
<code class="sig-name descname">unset_flag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flagname</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.unset_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.unset_flag" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.unset_flag">
|
||||
<code class="sig-name descname">unset_flag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flagname</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.unset_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.unset_flag" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Unset flag on object</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.check_flag">
|
||||
<code class="sig-name descname">check_flag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flagname</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.check_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.check_flag" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.check_flag">
|
||||
<code class="sig-name descname">check_flag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flagname</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.check_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.check_flag" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Check if flag is set on this object</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.check_perm">
|
||||
<code class="sig-name descname">check_perm</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">permission</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.check_perm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.check_perm" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.check_perm">
|
||||
<code class="sig-name descname">check_perm</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">permission</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.check_perm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.check_perm" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.tag_character">
|
||||
<code class="sig-name descname">tag_character</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">tag</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.tag_character"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.tag_character" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.tag_character">
|
||||
<code class="sig-name descname">tag_character</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">tag</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.tag_character"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.tag_character" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Tag a given character in this room.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -154,13 +154,13 @@ tagcategory.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.tag_all_characters">
|
||||
<code class="sig-name descname">tag_all_characters</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">tag</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.tag_all_characters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.tag_all_characters" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.tag_all_characters">
|
||||
<code class="sig-name descname">tag_all_characters</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">tag</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.tag_all_characters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.tag_all_characters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set a given tag on all players in the room.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>room</strong> (<a class="reference internal" href="#evennia.contrib.evscaperoom.room.EvscapeRoom" title="evennia.contrib.evscaperoom.room.EvscapeRoom"><em>EvscapeRoom</em></a>) – The room to escape from.</p></li>
|
||||
<li><p><strong>room</strong> (<a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom" title="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom"><em>EvscapeRoom</em></a>) – The room to escape from.</p></li>
|
||||
<li><p><strong>tag</strong> (<em>str</em>) – The tag to set.</p></li>
|
||||
<li><p><strong>category</strong> (<em>str</em><em>, </em><em>optional</em>) – If unset, will use the room’s tagcategory.</p></li>
|
||||
</ul>
|
||||
|
|
@ -169,64 +169,64 @@ tagcategory.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.character_cleanup">
|
||||
<code class="sig-name descname">character_cleanup</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">char</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.character_cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.character_cleanup" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.character_cleanup">
|
||||
<code class="sig-name descname">character_cleanup</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">char</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.character_cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.character_cleanup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Clean all custom tags/attrs on a character.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.character_exit">
|
||||
<code class="sig-name descname">character_exit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">char</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.character_exit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.character_exit" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.character_exit">
|
||||
<code class="sig-name descname">character_exit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">char</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.character_exit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.character_exit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Have a character exit the room - return them to the room menu.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.at_object_receive">
|
||||
<code class="sig-name descname">at_object_receive</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">moved_obj</span></em>, <em class="sig-param"><span class="n">source_location</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.at_object_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.at_object_receive" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.at_object_receive">
|
||||
<code class="sig-name descname">at_object_receive</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">moved_obj</span></em>, <em class="sig-param"><span class="n">source_location</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.at_object_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.at_object_receive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when an object arrives in the room. This can be used to
|
||||
sum up the situation, set tags etc.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.at_object_leave">
|
||||
<code class="sig-name descname">at_object_leave</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">moved_obj</span></em>, <em class="sig-param"><span class="n">target_location</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.at_object_leave"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.at_object_leave" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.at_object_leave">
|
||||
<code class="sig-name descname">at_object_leave</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">moved_obj</span></em>, <em class="sig-param"><span class="n">target_location</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.at_object_leave"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.at_object_leave" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when an object leaves the room; if this is a Character we need
|
||||
to clean them up and move them to the menu state.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.delete">
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.delete">
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete this room and all items related to it. Only move the players.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.return_appearance">
|
||||
<code class="sig-name descname">return_appearance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/room.html#EvscapeRoom.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.return_appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.return_appearance">
|
||||
<code class="sig-name descname">return_appearance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/room.html#EvscapeRoom.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.return_appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Could be modified per state. We generally don’t worry about the
|
||||
contents of the object by default.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.evscaperoom.objects.html#evennia.contrib.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.evscaperoom.objects.EvscaperoomObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.evscaperoom.objects.EvscaperoomObject.DoesNotExist</span></code></a>, <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultRoom.DoesNotExist" title="evennia.objects.objects.DefaultRoom.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultRoom.DoesNotExist</span></code></a></p>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.objects.html#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.DoesNotExist</span></code></a>, <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultRoom.DoesNotExist" title="evennia.objects.objects.DefaultRoom.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultRoom.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.evscaperoom.objects.html#evennia.contrib.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned</span></code></a>, <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultRoom.MultipleObjectsReturned" title="evennia.objects.objects.DefaultRoom.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultRoom.MultipleObjectsReturned</span></code></a></p>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.objects.html#evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned" title="evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.full_systems.evscaperoom.objects.EvscaperoomObject.MultipleObjectsReturned</span></code></a>, <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultRoom.MultipleObjectsReturned" title="evennia.objects.objects.DefaultRoom.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultRoom.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.evscaperoom.room.EvscapeRoom'</em><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom'</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.room.EvscapeRoom.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvscapeRoom'</em><a class="headerlink" href="#evennia.contrib.evscaperoom.room.EvscapeRoom.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvscapeRoom'</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -256,7 +256,7 @@ contents of the object by default.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.evscaperoom.room.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.full_systems.evscaperoom.room.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -272,7 +272,7 @@ contents of the object by default.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.evscaperoom.room.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="evennia.contrib.full_systems.evscaperoom.room.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -290,7 +290,7 @@ contents of the object by default.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.evscaperoom.room</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.room</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,163 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.full_systems.evscaperoom.scripts — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.scripts</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.full_systems.evscaperoom.scripts">
|
||||
<span id="evennia-contrib-full-systems-evscaperoom-scripts"></span><h1>evennia.contrib.full_systems.evscaperoom.scripts<a class="headerlink" href="#module-evennia.contrib.full_systems.evscaperoom.scripts" title="Permalink to this headline">¶</a></h1>
|
||||
<p>A simple cleanup script to wipe empty rooms</p>
|
||||
<p>(This can happen if users leave ‘uncleanly’, such as by closing their browser
|
||||
window)</p>
|
||||
<p>Just start this global script manually or at server creation.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.scripts.</code><code class="sig-name descname">CleanupScript</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">db_key</span></em>, <em class="sig-param"><span class="n">db_typeclass_path</span></em>, <em class="sig-param"><span class="n">db_date_created</span></em>, <em class="sig-param"><span class="n">db_lock_storage</span></em>, <em class="sig-param"><span class="n">db_desc</span></em>, <em class="sig-param"><span class="n">db_obj</span></em>, <em class="sig-param"><span class="n">db_account</span></em>, <em class="sig-param"><span class="n">db_interval</span></em>, <em class="sig-param"><span class="n">db_start_delay</span></em>, <em class="sig-param"><span class="n">db_repeats</span></em>, <em class="sig-param"><span class="n">db_persistent</span></em>, <em class="sig-param"><span class="n">db_is_active</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/scripts.html#CleanupScript"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript" title="evennia.scripts.scripts.DefaultScript"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/scripts.html#CleanupScript.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Only called once, when script is first created.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.at_repeat">
|
||||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/scripts.html#CleanupScript.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called repeatedly if this Script is set to repeat regularly.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||||
overriding the call (unused by default).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.DoesNotExist" title="evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript'</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'CleanupScript'</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.full_systems.evscaperoom.scripts.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.full_systems.evscaperoom.scripts.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.scripts</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.evscaperoom.state — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.full_systems.evscaperoom.state — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.evscaperoom.state</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.state</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.evscaperoom.state">
|
||||
<span id="evennia-contrib-evscaperoom-state"></span><h1>evennia.contrib.evscaperoom.state<a class="headerlink" href="#module-evennia.contrib.evscaperoom.state" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.full_systems.evscaperoom.state">
|
||||
<span id="evennia-contrib-full-systems-evscaperoom-state"></span><h1>evennia.contrib.full_systems.evscaperoom.state<a class="headerlink" href="#module-evennia.contrib.full_systems.evscaperoom.state" title="Permalink to this headline">¶</a></h1>
|
||||
<p>States represent the sequence of states the room goes through.</p>
|
||||
<p>This module includes the BaseState class and the StateHandler
|
||||
for managing states on the room.</p>
|
||||
|
|
@ -50,31 +50,31 @@ its state from one to another.</p>
|
|||
<p>A given state is given as a module in states/ package. The
|
||||
state is identified by its module name.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.evscaperoom.state.StateHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.evscaperoom.state.</code><code class="sig-name descname">StateHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">room</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#StateHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.StateHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.StateHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.state.</code><code class="sig-name descname">StateHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">room</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#StateHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>This sits on the room and is used to progress through the states.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.StateHandler.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">room</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#StateHandler.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.StateHandler.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.StateHandler.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">room</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#StateHandler.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.StateHandler.load_state">
|
||||
<code class="sig-name descname">load_state</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">statename</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#StateHandler.load_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.StateHandler.load_state" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.StateHandler.load_state">
|
||||
<code class="sig-name descname">load_state</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">statename</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#StateHandler.load_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler.load_state" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Load state without initializing it</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.StateHandler.init_state">
|
||||
<code class="sig-name descname">init_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#StateHandler.init_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.StateHandler.init_state" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.StateHandler.init_state">
|
||||
<code class="sig-name descname">init_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#StateHandler.init_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler.init_state" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize a new state</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.StateHandler.next_state">
|
||||
<code class="sig-name descname">next_state</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">next_state</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#StateHandler.next_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.StateHandler.next_state" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.StateHandler.next_state">
|
||||
<code class="sig-name descname">next_state</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">next_state</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#StateHandler.next_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler.next_state" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Check if the current state is finished. This should be called whenever
|
||||
the players do actions that may affect the state of the room.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -93,30 +93,30 @@ that the check passes).</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.evscaperoom.state.BaseState">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.evscaperoom.state.</code><code class="sig-name descname">BaseState</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">handler</span></em>, <em class="sig-param"><span class="n">room</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#BaseState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.BaseState" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.BaseState">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.state.</code><code class="sig-name descname">BaseState</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">handler</span></em>, <em class="sig-param"><span class="n">room</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Base object holding all callables for a state. This is here to
|
||||
allow easy overriding for child states.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.state.BaseState.next_state">
|
||||
<code class="sig-name descname">next_state</code><em class="property"> = 'unset'</em><a class="headerlink" href="#evennia.contrib.evscaperoom.state.BaseState.next_state" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.BaseState.next_state">
|
||||
<code class="sig-name descname">next_state</code><em class="property"> = 'unset'</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.next_state" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.evscaperoom.state.BaseState.hints">
|
||||
<code class="sig-name descname">hints</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.evscaperoom.state.BaseState.hints" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.BaseState.hints">
|
||||
<code class="sig-name descname">hints</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.hints" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.BaseState.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">handler</span></em>, <em class="sig-param"><span class="n">room</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#BaseState.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.BaseState.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.BaseState.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">handler</span></em>, <em class="sig-param"><span class="n">room</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initializer.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>room</strong> (<a class="reference internal" href="evennia.contrib.evscaperoom.room.html#evennia.contrib.evscaperoom.room.EvscapeRoom" title="evennia.contrib.evscaperoom.room.EvscapeRoom"><em>EvscapeRoom</em></a>) – The room tied to this state.</p></li>
|
||||
<li><p><strong>handler</strong> (<a class="reference internal" href="#evennia.contrib.evscaperoom.state.StateHandler" title="evennia.contrib.evscaperoom.state.StateHandler"><em>StateHandler</em></a>) – Back-reference to the handler
|
||||
<li><p><strong>room</strong> (<a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.room.html#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom" title="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom"><em>EvscapeRoom</em></a>) – The room tied to this state.</p></li>
|
||||
<li><p><strong>handler</strong> (<a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler" title="evennia.contrib.full_systems.evscaperoom.state.StateHandler"><em>StateHandler</em></a>) – Back-reference to the handler
|
||||
storing this state.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
|
@ -124,26 +124,26 @@ storing this state.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.BaseState.get_hint">
|
||||
<code class="sig-name descname">get_hint</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#BaseState.get_hint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.BaseState.get_hint" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.BaseState.get_hint">
|
||||
<code class="sig-name descname">get_hint</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.get_hint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.get_hint" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get a hint for how to solve this state.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.BaseState.msg">
|
||||
<code class="sig-name descname">msg</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">borders</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">cinematic</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#BaseState.msg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.BaseState.msg" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.BaseState.msg">
|
||||
<code class="sig-name descname">msg</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">borders</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">cinematic</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.msg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.msg" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Display messsage to everyone in room, or given target.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.BaseState.cinematic">
|
||||
<code class="sig-name descname">cinematic</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#BaseState.cinematic"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.BaseState.cinematic" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.BaseState.cinematic">
|
||||
<code class="sig-name descname">cinematic</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.cinematic"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.cinematic" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Display a ‘cinematic’ sequence - centered, with borders.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.BaseState.create_object">
|
||||
<code class="sig-name descname">create_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">typeclass</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">'testobj'</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#BaseState.create_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.BaseState.create_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.BaseState.create_object">
|
||||
<code class="sig-name descname">create_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">typeclass</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">'testobj'</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.create_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.create_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is a convenience-wrapper for quickly building EvscapeRoom objects.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Keyword Arguments</dt>
|
||||
|
|
@ -163,8 +163,8 @@ is needed (for custom state objects, just give the class directly).</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.BaseState.get_object">
|
||||
<code class="sig-name descname">get_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#BaseState.get_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.BaseState.get_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.BaseState.get_object">
|
||||
<code class="sig-name descname">get_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.get_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.get_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Find a named <em>non-character</em> object for this state in this room.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -177,20 +177,20 @@ is needed (for custom state objects, just give the class directly).</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.BaseState.init">
|
||||
<code class="sig-name descname">init</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#BaseState.init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.BaseState.init" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.BaseState.init">
|
||||
<code class="sig-name descname">init</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.init" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initializes the state (usually by modifying the room in some way)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.BaseState.clean">
|
||||
<code class="sig-name descname">clean</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#BaseState.clean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.BaseState.clean" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.BaseState.clean">
|
||||
<code class="sig-name descname">clean</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.clean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.clean" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Any cleanup operations after the state ends.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.BaseState.next">
|
||||
<code class="sig-name descname">next</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">next_state</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#BaseState.next"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.BaseState.next" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.BaseState.next">
|
||||
<code class="sig-name descname">next</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">next_state</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.next"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.next" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the next state after this one.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -213,14 +213,14 @@ set on the class)</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.BaseState.character_enters">
|
||||
<code class="sig-name descname">character_enters</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#BaseState.character_enters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.BaseState.character_enters" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.BaseState.character_enters">
|
||||
<code class="sig-name descname">character_enters</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.character_enters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.character_enters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when character enters the room in this state.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.evscaperoom.state.BaseState.character_leaves">
|
||||
<code class="sig-name descname">character_leaves</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/state.html#BaseState.character_leaves"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.state.BaseState.character_leaves" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.state.BaseState.character_leaves">
|
||||
<code class="sig-name descname">character_leaves</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.character_leaves"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.character_leaves" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when character is whisked away (usually because of
|
||||
quitting). This method cannot influence the move itself; it
|
||||
happens just before room.character_cleanup()</p>
|
||||
|
|
@ -253,7 +253,7 @@ happens just before room.character_cleanup()</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.evscaperoom.state.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.full_systems.evscaperoom.state.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -269,7 +269,7 @@ happens just before room.character_cleanup()</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.evscaperoom.state.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="evennia.contrib.full_systems.evscaperoom.state.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -287,7 +287,7 @@ happens just before room.character_cleanup()</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.evscaperoom.state</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.state</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,239 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.full_systems.evscaperoom.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.full_systems.evscaperoom.tests">
|
||||
<span id="evennia-contrib-full-systems-evscaperoom-tests"></span><h1>evennia.contrib.full_systems.evscaperoom.tests<a class="headerlink" href="#module-evennia.contrib.full_systems.evscaperoom.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Unit tests for the Evscaperoom</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.tests.</code><code class="sig-name descname">TestEvscaperoomCommands</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestEvscaperoomCommands"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestEvscaperoomCommands.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_base_search">
|
||||
<code class="sig-name descname">test_base_search</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestEvscaperoomCommands.test_base_search"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_base_search" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_base_parse">
|
||||
<code class="sig-name descname">test_base_parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestEvscaperoomCommands.test_base_parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_base_parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_set_focus">
|
||||
<code class="sig-name descname">test_set_focus</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestEvscaperoomCommands.test_set_focus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_set_focus" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_focus">
|
||||
<code class="sig-name descname">test_focus</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestEvscaperoomCommands.test_focus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_focus" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_look">
|
||||
<code class="sig-name descname">test_look</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestEvscaperoomCommands.test_look"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_look" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_speech">
|
||||
<code class="sig-name descname">test_speech</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestEvscaperoomCommands.test_speech"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_speech" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_emote">
|
||||
<code class="sig-name descname">test_emote</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestEvscaperoomCommands.test_emote"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_emote" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_focus_interaction">
|
||||
<code class="sig-name descname">test_focus_interaction</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestEvscaperoomCommands.test_focus_interaction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_focus_interaction" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestUtils">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.tests.</code><code class="sig-name descname">TestUtils</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestUtils"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestUtils" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestUtils.test_overwrite">
|
||||
<code class="sig-name descname">test_overwrite</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestUtils.test_overwrite"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestUtils.test_overwrite" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestUtils.test_parse_for_perspectives">
|
||||
<code class="sig-name descname">test_parse_for_perspectives</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestUtils.test_parse_for_perspectives"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestUtils.test_parse_for_perspectives" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestUtils.test_parse_for_things">
|
||||
<code class="sig-name descname">test_parse_for_things</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestUtils.test_parse_for_things"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestUtils.test_parse_for_things" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestEvScapeRoom">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.tests.</code><code class="sig-name descname">TestEvScapeRoom</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestEvScapeRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestEvScapeRoom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestEvScapeRoom.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestEvScapeRoom.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestEvScapeRoom.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestEvScapeRoom.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestEvScapeRoom.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestEvScapeRoom.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestEvScapeRoom.test_room_methods">
|
||||
<code class="sig-name descname">test_room_methods</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestEvScapeRoom.test_room_methods"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestEvScapeRoom.test_room_methods" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestStates">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.tests.</code><code class="sig-name descname">TestStates</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestStates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestStates" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestStates.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestStates.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestStates.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestStates.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestStates.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestStates.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestStates.test_base_state">
|
||||
<code class="sig-name descname">test_base_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestStates.test_base_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestStates.test_base_state" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.tests.TestStates.test_all_states">
|
||||
<code class="sig-name descname">test_all_states</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/tests.html#TestStates.test_all_states"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.tests.TestStates.test_all_states" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Tick through all defined states</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.full_systems.evscaperoom.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.full_systems.evscaperoom.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.evscaperoom.utils — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.full_systems.evscaperoom.utils — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.evscaperoom.utils</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.utils</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,14 +40,14 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.evscaperoom.utils">
|
||||
<span id="evennia-contrib-evscaperoom-utils"></span><h1>evennia.contrib.evscaperoom.utils<a class="headerlink" href="#module-evennia.contrib.evscaperoom.utils" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.full_systems.evscaperoom.utils">
|
||||
<span id="evennia-contrib-full-systems-evscaperoom-utils"></span><h1>evennia.contrib.full_systems.evscaperoom.utils<a class="headerlink" href="#module-evennia.contrib.full_systems.evscaperoom.utils" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Helper functions and classes for the evscaperoom contrib.</p>
|
||||
<p>Most of these are available directly from wrappers in state/object/room classes
|
||||
and does not need to be imported from here.</p>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.evscaperoom.utils.create_evscaperoom_object">
|
||||
<code class="sig-prename descclassname">evennia.contrib.evscaperoom.utils.</code><code class="sig-name descname">create_evscaperoom_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">typeclass</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">'testobj'</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">delete_duplicates</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/utils.html#create_evscaperoom_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.utils.create_evscaperoom_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.utils.create_evscaperoom_object">
|
||||
<code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.utils.</code><code class="sig-name descname">create_evscaperoom_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">typeclass</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">'testobj'</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">delete_duplicates</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/utils.html#create_evscaperoom_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.utils.create_evscaperoom_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is a convenience-wrapper for quickly building EvscapeRoom objects. This
|
||||
is called from the helper-method create_object on states, but is also useful
|
||||
for the object-create admin command.</p>
|
||||
|
|
@ -71,8 +71,8 @@ objects.py module. Otherwise, a full path is needed.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.evscaperoom.utils.create_fantasy_word">
|
||||
<code class="sig-prename descclassname">evennia.contrib.evscaperoom.utils.</code><code class="sig-name descname">create_fantasy_word</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">length</span><span class="o">=</span><span class="default_value">5</span></em>, <em class="sig-param"><span class="n">capitalize</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/utils.html#create_fantasy_word"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.utils.create_fantasy_word" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.utils.create_fantasy_word">
|
||||
<code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.utils.</code><code class="sig-name descname">create_fantasy_word</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">length</span><span class="o">=</span><span class="default_value">5</span></em>, <em class="sig-param"><span class="n">capitalize</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/utils.html#create_fantasy_word"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.utils.create_fantasy_word" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a random semi-pronouncable ‘word’.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Keyword Arguments</dt>
|
||||
|
|
@ -88,8 +88,8 @@ objects.py module. Otherwise, a full path is needed.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.evscaperoom.utils.parse_for_perspectives">
|
||||
<code class="sig-prename descclassname">evennia.contrib.evscaperoom.utils.</code><code class="sig-name descname">parse_for_perspectives</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em>, <em class="sig-param"><span class="n">you</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/utils.html#parse_for_perspectives"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.utils.parse_for_perspectives" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.utils.parse_for_perspectives">
|
||||
<code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.utils.</code><code class="sig-name descname">parse_for_perspectives</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em>, <em class="sig-param"><span class="n">you</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/utils.html#parse_for_perspectives"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.utils.parse_for_perspectives" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Parse a string with special markers to produce versions both
|
||||
intended for the person doing the action (‘you’) and for those
|
||||
seeing the person doing that action. Also marks ‘things’
|
||||
|
|
@ -116,8 +116,8 @@ according to style. See example below.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.evscaperoom.utils.parse_for_things">
|
||||
<code class="sig-prename descclassname">evennia.contrib.evscaperoom.utils.</code><code class="sig-name descname">parse_for_things</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em>, <em class="sig-param"><span class="n">things_style</span><span class="o">=</span><span class="default_value">2</span></em>, <em class="sig-param"><span class="n">clr</span><span class="o">=</span><span class="default_value">'|y'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/utils.html#parse_for_things"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.utils.parse_for_things" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.utils.parse_for_things">
|
||||
<code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.utils.</code><code class="sig-name descname">parse_for_things</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em>, <em class="sig-param"><span class="n">things_style</span><span class="o">=</span><span class="default_value">2</span></em>, <em class="sig-param"><span class="n">clr</span><span class="o">=</span><span class="default_value">'|y'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/utils.html#parse_for_things"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.utils.parse_for_things" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Parse string for special <a href="#id1"><span class="problematic" id="id2">*</span></a>thing markers and decorate
|
||||
it.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -137,14 +137,14 @@ it.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.evscaperoom.utils.add_msg_borders">
|
||||
<code class="sig-prename descclassname">evennia.contrib.evscaperoom.utils.</code><code class="sig-name descname">add_msg_borders</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">text</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/utils.html#add_msg_borders"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.utils.add_msg_borders" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.utils.add_msg_borders">
|
||||
<code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.utils.</code><code class="sig-name descname">add_msg_borders</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">text</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/utils.html#add_msg_borders"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.utils.add_msg_borders" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add borders above/below text block</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.evscaperoom.utils.msg_cinematic">
|
||||
<code class="sig-prename descclassname">evennia.contrib.evscaperoom.utils.</code><code class="sig-name descname">msg_cinematic</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">text</span></em>, <em class="sig-param"><span class="n">borders</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/evscaperoom/utils.html#msg_cinematic"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.evscaperoom.utils.msg_cinematic" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.utils.msg_cinematic">
|
||||
<code class="sig-prename descclassname">evennia.contrib.full_systems.evscaperoom.utils.</code><code class="sig-name descname">msg_cinematic</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">text</span></em>, <em class="sig-param"><span class="n">borders</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/utils.html#msg_cinematic"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.utils.msg_cinematic" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Display a text as a ‘cinematic’ - centered and
|
||||
surrounded by borders.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -185,7 +185,7 @@ surrounded by borders.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.evscaperoom.utils.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.full_systems.evscaperoom.utils.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -201,7 +201,7 @@ surrounded by borders.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.evscaperoom.utils.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="evennia.contrib.full_systems.evscaperoom.utils.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -219,7 +219,7 @@ surrounded by borders.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.evscaperoom.utils</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.utils</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
129
docs/1.0-dev/api/evennia.contrib.full_systems.html
Normal file
129
docs/1.0-dev/api/evennia.contrib.full_systems.html
Normal file
|
|
@ -0,0 +1,129 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.full_systems — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.full_systems">
|
||||
<span id="evennia-contrib-full-systems"></span><h1>evennia.contrib.full_systems<a class="headerlink" href="#module-evennia.contrib.full_systems" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Complete game implementations/engines.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.html">evennia.contrib.full_systems.evscaperoom</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.commands.html">evennia.contrib.full_systems.evscaperoom.commands</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.menu.html">evennia.contrib.full_systems.evscaperoom.menu</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.objects.html">evennia.contrib.full_systems.evscaperoom.objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.room.html">evennia.contrib.full_systems.evscaperoom.room</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.scripts.html">evennia.contrib.full_systems.evscaperoom.scripts</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.state.html">evennia.contrib.full_systems.evscaperoom.state</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.tests.html">evennia.contrib.full_systems.evscaperoom.tests</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.utils.html">evennia.contrib.full_systems.evscaperoom.utils</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.full_systems.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.full_systems.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.barter — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.game_systems.barter.barter — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.barter</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.barter.barter</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.barter">
|
||||
<span id="evennia-contrib-barter"></span><h1>evennia.contrib.barter<a class="headerlink" href="#module-evennia.contrib.barter" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.game_systems.barter.barter">
|
||||
<span id="evennia-contrib-game-systems-barter-barter"></span><h1>evennia.contrib.game_systems.barter.barter<a class="headerlink" href="#module-evennia.contrib.game_systems.barter.barter" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Barter system</p>
|
||||
<p>Evennia contribution - Griatch 2012</p>
|
||||
<p>This implements a full barter system - a way for players to safely
|
||||
|
|
@ -142,61 +142,61 @@ moderately more interesting than just plain ‘buy’.</p>
|
|||
cmdset. This will make the trade (or barter) command available
|
||||
in-game.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.barter.TradeTimeout">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.barter.</code><code class="sig-name descname">TradeTimeout</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeTimeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeTimeout" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeTimeout">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.barter.barter.</code><code class="sig-name descname">TradeTimeout</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeTimeout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeTimeout" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript" title="evennia.scripts.scripts.DefaultScript"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript</span></code></a></p>
|
||||
<p>This times out the trade request, in case player B did not reply in time.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.TradeTimeout.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeTimeout.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeTimeout.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeTimeout.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeTimeout.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeTimeout.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when script is first created</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.TradeTimeout.at_repeat">
|
||||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeTimeout.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeTimeout.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeTimeout.at_repeat">
|
||||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeTimeout.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeTimeout.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>called once</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.TradeTimeout.is_valid">
|
||||
<code class="sig-name descname">is_valid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeTimeout.is_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeTimeout.is_valid" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeTimeout.is_valid">
|
||||
<code class="sig-name descname">is_valid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeTimeout.is_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeTimeout.is_valid" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Only valid if the trade has not yet started</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.barter.TradeTimeout.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.barter.TradeTimeout.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeTimeout.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeTimeout.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.DoesNotExist" title="evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.barter.TradeTimeout.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.barter.TradeTimeout.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeTimeout.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeTimeout.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.TradeTimeout.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.barter.TradeTimeout'</em><a class="headerlink" href="#evennia.contrib.barter.TradeTimeout.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeTimeout.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.barter.barter.TradeTimeout'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeTimeout.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.TradeTimeout.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TradeTimeout'</em><a class="headerlink" href="#evennia.contrib.barter.TradeTimeout.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeTimeout.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TradeTimeout'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeTimeout.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.barter.TradeHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.barter.</code><code class="sig-name descname">TradeHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">part_a</span></em>, <em class="sig-param"><span class="n">part_b</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.barter.barter.</code><code class="sig-name descname">TradeHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">part_a</span></em>, <em class="sig-param"><span class="n">part_b</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Objects of this class handles the ongoing trade, notably storing the current
|
||||
offers from each side and wether both have accepted or not.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.TradeHandler.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">part_a</span></em>, <em class="sig-param"><span class="n">part_b</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeHandler.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeHandler.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeHandler.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">part_a</span></em>, <em class="sig-param"><span class="n">part_b</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeHandler.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeHandler.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initializes the trade. This is called when part A tries to
|
||||
initiate a trade with part B. The trade will not start until
|
||||
part B repeats this command (B will then call the self.join()
|
||||
|
|
@ -215,8 +215,8 @@ to this object.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.TradeHandler.msg_other">
|
||||
<code class="sig-name descname">msg_other</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sender</span></em>, <em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeHandler.msg_other"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeHandler.msg_other" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeHandler.msg_other">
|
||||
<code class="sig-name descname">msg_other</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sender</span></em>, <em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeHandler.msg_other"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeHandler.msg_other" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Relay a message to the <em>other</em> party without needing to know
|
||||
which party that is. This allows the calling command to not
|
||||
have to worry about which party they are in the handler.</p>
|
||||
|
|
@ -232,8 +232,8 @@ out the <em>other</em> party to send to.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.TradeHandler.get_other">
|
||||
<code class="sig-name descname">get_other</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">party</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeHandler.get_other"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeHandler.get_other" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeHandler.get_other">
|
||||
<code class="sig-name descname">get_other</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">party</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeHandler.get_other"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeHandler.get_other" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the other party of the trade</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -246,8 +246,8 @@ out the <em>other</em> party to send to.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.TradeHandler.join">
|
||||
<code class="sig-name descname">join</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">part_b</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeHandler.join"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeHandler.join" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeHandler.join">
|
||||
<code class="sig-name descname">join</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">part_b</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeHandler.join"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeHandler.join" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is used once B decides to join the trade</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -257,8 +257,8 @@ out the <em>other</em> party to send to.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.TradeHandler.unjoin">
|
||||
<code class="sig-name descname">unjoin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">part_b</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeHandler.unjoin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeHandler.unjoin" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeHandler.unjoin">
|
||||
<code class="sig-name descname">unjoin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">part_b</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeHandler.unjoin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeHandler.unjoin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is used if B decides not to join the trade.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -268,8 +268,8 @@ out the <em>other</em> party to send to.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.TradeHandler.offer">
|
||||
<code class="sig-name descname">offer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">party</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeHandler.offer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeHandler.offer" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeHandler.offer">
|
||||
<code class="sig-name descname">offer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">party</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeHandler.offer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeHandler.offer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Change the current standing offer. We leave it up to the
|
||||
command to do the actual checks that the offer consists
|
||||
of real, valid, objects.</p>
|
||||
|
|
@ -284,8 +284,8 @@ of real, valid, objects.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.TradeHandler.list">
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeHandler.list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeHandler.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeHandler.list">
|
||||
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeHandler.list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeHandler.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>List current offers.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -295,8 +295,8 @@ of real, valid, objects.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.TradeHandler.search">
|
||||
<code class="sig-name descname">search</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">offername</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeHandler.search"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeHandler.search" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeHandler.search">
|
||||
<code class="sig-name descname">search</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">offername</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeHandler.search"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeHandler.search" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Search current offers.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -310,8 +310,8 @@ the list of offered items.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.TradeHandler.accept">
|
||||
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">party</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeHandler.accept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeHandler.accept" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeHandler.accept">
|
||||
<code class="sig-name descname">accept</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">party</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeHandler.accept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeHandler.accept" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accept the current offer.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -333,8 +333,8 @@ accepted independently. This is done by calling the
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.TradeHandler.decline">
|
||||
<code class="sig-name descname">decline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">party</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeHandler.decline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeHandler.decline" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeHandler.decline">
|
||||
<code class="sig-name descname">decline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">party</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeHandler.decline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeHandler.decline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Decline the offer (or change one’s mind).</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -356,8 +356,8 @@ yet accepted.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.TradeHandler.finish">
|
||||
<code class="sig-name descname">finish</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">force</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#TradeHandler.finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.TradeHandler.finish" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.TradeHandler.finish">
|
||||
<code class="sig-name descname">finish</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">force</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#TradeHandler.finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.TradeHandler.finish" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Conclude trade - move all offers and clean up</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -374,49 +374,49 @@ hands but trading will stop anyway)</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.barter.CmdTradeBase">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.barter.</code><code class="sig-name descname">CmdTradeBase</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdTradeBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdTradeBase" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeBase">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.barter.barter.</code><code class="sig-name descname">CmdTradeBase</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdTradeBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeBase" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Base command for Trade commands to inherit from. Implements the
|
||||
custom parsing.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.CmdTradeBase.parse">
|
||||
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdTradeBase.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdTradeBase.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeBase.parse">
|
||||
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdTradeBase.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeBase.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Parse the relevant parts and make it easily
|
||||
available to the command</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTradeBase.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.barter.CmdTradeBase.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeBase.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeBase.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTradeBase.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.barter.CmdTradeBase.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeBase.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeBase.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTradeBase.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'command'</em><a class="headerlink" href="#evennia.contrib.barter.CmdTradeBase.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeBase.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'command'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeBase.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTradeBase.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.barter.CmdTradeBase.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeBase.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeBase.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTradeBase.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'command', 'no_prefix': ' ', 'tags': '', 'text': '\n Base command for Trade commands to inherit from. Implements the\n custom parsing.\n '}</em><a class="headerlink" href="#evennia.contrib.barter.CmdTradeBase.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeBase.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'command', 'no_prefix': ' ', 'tags': '', 'text': '\n Base command for Trade commands to inherit from. Implements the\n custom parsing.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeBase.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.barter.CmdTradeHelp">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.barter.</code><code class="sig-name descname">CmdTradeHelp</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdTradeHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdTradeHelp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.barter.CmdTradeBase" title="evennia.contrib.barter.CmdTradeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.barter.CmdTradeBase</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeHelp">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.barter.barter.</code><code class="sig-name descname">CmdTradeHelp</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdTradeHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeHelp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.game_systems.barter.barter.CmdTradeBase" title="evennia.contrib.game_systems.barter.barter.CmdTradeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.barter.barter.CmdTradeBase</span></code></a></p>
|
||||
<p>help command for the trade system.</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>trade help</p>
|
||||
|
|
@ -424,47 +424,47 @@ available to the command</p>
|
|||
</dl>
|
||||
<p>Displays help for the trade commands.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTradeHelp.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'trade help'</em><a class="headerlink" href="#evennia.contrib.barter.CmdTradeHelp.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeHelp.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'trade help'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeHelp.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTradeHelp.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdTradeHelp.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeHelp.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeHelp.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTradeHelp.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'trade'</em><a class="headerlink" href="#evennia.contrib.barter.CmdTradeHelp.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeHelp.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'trade'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeHelp.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.CmdTradeHelp.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdTradeHelp.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdTradeHelp.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeHelp.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdTradeHelp.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeHelp.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Show the help</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTradeHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.barter.CmdTradeHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTradeHelp.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdTradeHelp.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeHelp.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeHelp.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTradeHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'trade', 'key': 'trade help', 'no_prefix': ' ', 'tags': '', 'text': '\n help command for the trade system.\n\n Usage:\n trade help\n\n Displays help for the trade commands.\n '}</em><a class="headerlink" href="#evennia.contrib.barter.CmdTradeHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTradeHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'trade', 'key': 'trade help', 'no_prefix': ' ', 'tags': '', 'text': '\n help command for the trade system.\n\n Usage:\n trade help\n\n Displays help for the trade commands.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTradeHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.barter.CmdOffer">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.barter.</code><code class="sig-name descname">CmdOffer</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdOffer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdOffer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.barter.CmdTradeBase" title="evennia.contrib.barter.CmdTradeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.barter.CmdTradeBase</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdOffer">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.barter.barter.</code><code class="sig-name descname">CmdOffer</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdOffer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdOffer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.game_systems.barter.barter.CmdTradeBase" title="evennia.contrib.game_systems.barter.barter.CmdTradeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.barter.barter.CmdTradeBase</span></code></a></p>
|
||||
<p>offer one or more items in trade.</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>offer <object> [, object2, …][:emote]</p>
|
||||
|
|
@ -473,47 +473,47 @@ available to the command</p>
|
|||
<p>Offer objects in trade. This will replace the currently
|
||||
standing offer.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdOffer.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'offer'</em><a class="headerlink" href="#evennia.contrib.barter.CmdOffer.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdOffer.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'offer'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdOffer.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdOffer.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdOffer.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdOffer.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdOffer.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdOffer.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'trading'</em><a class="headerlink" href="#evennia.contrib.barter.CmdOffer.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdOffer.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'trading'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdOffer.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.CmdOffer.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdOffer.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdOffer.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdOffer.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdOffer.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdOffer.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>implement the offer</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdOffer.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.barter.CmdOffer.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdOffer.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdOffer.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdOffer.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdOffer.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdOffer.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdOffer.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdOffer.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'trading', 'key': 'offer', 'no_prefix': ' ', 'tags': '', 'text': '\n offer one or more items in trade.\n\n Usage:\n offer <object> [, object2, ...][:emote]\n\n Offer objects in trade. This will replace the currently\n standing offer.\n '}</em><a class="headerlink" href="#evennia.contrib.barter.CmdOffer.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdOffer.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'trading', 'key': 'offer', 'no_prefix': ' ', 'tags': '', 'text': '\n offer one or more items in trade.\n\n Usage:\n offer <object> [, object2, ...][:emote]\n\n Offer objects in trade. This will replace the currently\n standing offer.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdOffer.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.barter.CmdAccept">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.barter.</code><code class="sig-name descname">CmdAccept</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdAccept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdAccept" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.barter.CmdTradeBase" title="evennia.contrib.barter.CmdTradeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.barter.CmdTradeBase</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdAccept">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.barter.barter.</code><code class="sig-name descname">CmdAccept</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdAccept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdAccept" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.game_systems.barter.barter.CmdTradeBase" title="evennia.contrib.game_systems.barter.barter.CmdTradeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.barter.barter.CmdTradeBase</span></code></a></p>
|
||||
<p>accept the standing offer</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>accept [:emote]
|
||||
|
|
@ -525,47 +525,47 @@ for the deal to go through. You can use the ‘decline’ command to change
|
|||
your mind as long as the other party has not yet accepted. You can inspect
|
||||
the current offer using the ‘offers’ command.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdAccept.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'accept'</em><a class="headerlink" href="#evennia.contrib.barter.CmdAccept.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdAccept.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'accept'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdAccept.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdAccept.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['agree']</em><a class="headerlink" href="#evennia.contrib.barter.CmdAccept.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdAccept.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['agree']</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdAccept.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdAccept.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdAccept.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdAccept.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdAccept.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdAccept.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'trading'</em><a class="headerlink" href="#evennia.contrib.barter.CmdAccept.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdAccept.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'trading'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdAccept.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.CmdAccept.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdAccept.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdAccept.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdAccept.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdAccept.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdAccept.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>accept the offer</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdAccept.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdAccept.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdAccept.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdAccept.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdAccept.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'agree', 'category': 'trading', 'key': 'accept', 'no_prefix': ' agree', 'tags': '', 'text': "\n accept the standing offer\n\n Usage:\n accept [:emote]\n agreee [:emote]\n\n This will accept the current offer. The other party must also accept\n for the deal to go through. You can use the 'decline' command to change\n your mind as long as the other party has not yet accepted. You can inspect\n the current offer using the 'offers' command.\n "}</em><a class="headerlink" href="#evennia.contrib.barter.CmdAccept.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdAccept.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'agree', 'category': 'trading', 'key': 'accept', 'no_prefix': ' agree', 'tags': '', 'text': "\n accept the standing offer\n\n Usage:\n accept [:emote]\n agreee [:emote]\n\n This will accept the current offer. The other party must also accept\n for the deal to go through. You can use the 'decline' command to change\n your mind as long as the other party has not yet accepted. You can inspect\n the current offer using the 'offers' command.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdAccept.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.barter.CmdDecline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.barter.</code><code class="sig-name descname">CmdDecline</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdDecline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdDecline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.barter.CmdTradeBase" title="evennia.contrib.barter.CmdTradeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.barter.CmdTradeBase</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdDecline">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.barter.barter.</code><code class="sig-name descname">CmdDecline</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdDecline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdDecline" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.game_systems.barter.barter.CmdTradeBase" title="evennia.contrib.game_systems.barter.barter.CmdTradeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.barter.barter.CmdTradeBase</span></code></a></p>
|
||||
<p>decline the standing offer</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>decline [:emote]</p>
|
||||
|
|
@ -576,47 +576,47 @@ change your mind). You can only use this as long as the other party
|
|||
has not yet accepted the deal. Also, changing the offer will automatically
|
||||
decline the old offer.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdDecline.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'decline'</em><a class="headerlink" href="#evennia.contrib.barter.CmdDecline.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdDecline.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'decline'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdDecline.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdDecline.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdDecline.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdDecline.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdDecline.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdDecline.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'trading'</em><a class="headerlink" href="#evennia.contrib.barter.CmdDecline.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdDecline.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'trading'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdDecline.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.CmdDecline.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdDecline.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdDecline.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdDecline.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdDecline.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdDecline.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>decline the offer</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdDecline.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.barter.CmdDecline.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdDecline.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdDecline.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdDecline.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdDecline.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdDecline.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdDecline.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdDecline.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'trading', 'key': 'decline', 'no_prefix': ' ', 'tags': '', 'text': "\n decline the standing offer\n\n Usage:\n decline [:emote]\n\n This will decline a previously 'accept'ed offer (so this allows you to\n change your mind). You can only use this as long as the other party\n has not yet accepted the deal. Also, changing the offer will automatically\n decline the old offer.\n "}</em><a class="headerlink" href="#evennia.contrib.barter.CmdDecline.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdDecline.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'trading', 'key': 'decline', 'no_prefix': ' ', 'tags': '', 'text': "\n decline the standing offer\n\n Usage:\n decline [:emote]\n\n This will decline a previously 'accept'ed offer (so this allows you to\n change your mind). You can only use this as long as the other party\n has not yet accepted the deal. Also, changing the offer will automatically\n decline the old offer.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdDecline.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.barter.CmdEvaluate">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.barter.</code><code class="sig-name descname">CmdEvaluate</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdEvaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdEvaluate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.barter.CmdTradeBase" title="evennia.contrib.barter.CmdTradeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.barter.CmdTradeBase</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdEvaluate">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.barter.barter.</code><code class="sig-name descname">CmdEvaluate</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdEvaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdEvaluate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.game_systems.barter.barter.CmdTradeBase" title="evennia.contrib.game_systems.barter.barter.CmdTradeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.barter.barter.CmdTradeBase</span></code></a></p>
|
||||
<p>evaluate objects on offer</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>evaluate <offered object></p>
|
||||
|
|
@ -625,47 +625,47 @@ decline the old offer.</p>
|
|||
<p>This allows you to examine any object currently on offer, to
|
||||
determine if it’s worth your while.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdEvaluate.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'evaluate'</em><a class="headerlink" href="#evennia.contrib.barter.CmdEvaluate.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdEvaluate.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'evaluate'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdEvaluate.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdEvaluate.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['eval']</em><a class="headerlink" href="#evennia.contrib.barter.CmdEvaluate.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdEvaluate.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['eval']</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdEvaluate.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdEvaluate.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdEvaluate.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdEvaluate.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdEvaluate.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdEvaluate.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'trading'</em><a class="headerlink" href="#evennia.contrib.barter.CmdEvaluate.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdEvaluate.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'trading'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdEvaluate.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.CmdEvaluate.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdEvaluate.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdEvaluate.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdEvaluate.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdEvaluate.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdEvaluate.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>evaluate an object</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdEvaluate.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdEvaluate.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdEvaluate.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdEvaluate.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdEvaluate.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'eval', 'category': 'trading', 'key': 'evaluate', 'no_prefix': ' eval', 'tags': '', 'text': "\n evaluate objects on offer\n\n Usage:\n evaluate <offered object>\n\n This allows you to examine any object currently on offer, to\n determine if it's worth your while.\n "}</em><a class="headerlink" href="#evennia.contrib.barter.CmdEvaluate.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdEvaluate.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'eval', 'category': 'trading', 'key': 'evaluate', 'no_prefix': ' eval', 'tags': '', 'text': "\n evaluate objects on offer\n\n Usage:\n evaluate <offered object>\n\n This allows you to examine any object currently on offer, to\n determine if it's worth your while.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdEvaluate.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.barter.CmdStatus">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.barter.</code><code class="sig-name descname">CmdStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.barter.CmdTradeBase" title="evennia.contrib.barter.CmdTradeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.barter.CmdTradeBase</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdStatus">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.barter.barter.</code><code class="sig-name descname">CmdStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.game_systems.barter.barter.CmdTradeBase" title="evennia.contrib.game_systems.barter.barter.CmdTradeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.barter.barter.CmdTradeBase</span></code></a></p>
|
||||
<p>show a list of the current deal</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>status
|
||||
|
|
@ -678,47 +678,47 @@ accept the current deal, use the ‘accept’ command. Use ‘offer’ to
|
|||
change your deal. You might also want to use ‘say’, ‘emote’ etc to
|
||||
try to influence the other part in the deal.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdStatus.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'status'</em><a class="headerlink" href="#evennia.contrib.barter.CmdStatus.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdStatus.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'status'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdStatus.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['deal', 'offers']</em><a class="headerlink" href="#evennia.contrib.barter.CmdStatus.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdStatus.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['offers', 'deal']</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdStatus.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdStatus.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdStatus.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdStatus.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'trading'</em><a class="headerlink" href="#evennia.contrib.barter.CmdStatus.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdStatus.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'trading'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.CmdStatus.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdStatus.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdStatus.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdStatus.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdStatus.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Show the current deal</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdStatus.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdStatus.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdStatus.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdStatus.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'deal offers', 'category': 'trading', 'key': 'status', 'no_prefix': ' deal offers', 'tags': '', 'text': "\n show a list of the current deal\n\n Usage:\n status\n deal\n offers\n\n Shows the currently suggested offers on each sides of the deal. To\n accept the current deal, use the 'accept' command. Use 'offer' to\n change your deal. You might also want to use 'say', 'emote' etc to\n try to influence the other part in the deal.\n "}</em><a class="headerlink" href="#evennia.contrib.barter.CmdStatus.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdStatus.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'offers deal', 'category': 'trading', 'key': 'status', 'no_prefix': ' offers deal', 'tags': '', 'text': "\n show a list of the current deal\n\n Usage:\n status\n deal\n offers\n\n Shows the currently suggested offers on each sides of the deal. To\n accept the current deal, use the 'accept' command. Use 'offer' to\n change your deal. You might also want to use 'say', 'emote' etc to\n try to influence the other part in the deal.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.barter.CmdFinish">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.barter.</code><code class="sig-name descname">CmdFinish</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdFinish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdFinish" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.barter.CmdTradeBase" title="evennia.contrib.barter.CmdTradeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.barter.CmdTradeBase</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdFinish">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.barter.barter.</code><code class="sig-name descname">CmdFinish</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdFinish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdFinish" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.game_systems.barter.barter.CmdTradeBase" title="evennia.contrib.game_systems.barter.barter.CmdTradeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.barter.barter.CmdTradeBase</span></code></a></p>
|
||||
<p>end the trade prematurely</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>end trade [:say]
|
||||
|
|
@ -727,70 +727,70 @@ finish trade [:say]</p>
|
|||
</dl>
|
||||
<p>This ends the trade prematurely. No trade will take place.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdFinish.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'end trade'</em><a class="headerlink" href="#evennia.contrib.barter.CmdFinish.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdFinish.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'end trade'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdFinish.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdFinish.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['finish trade']</em><a class="headerlink" href="#evennia.contrib.barter.CmdFinish.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdFinish.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['finish trade']</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdFinish.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdFinish.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdFinish.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdFinish.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdFinish.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdFinish.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'trading'</em><a class="headerlink" href="#evennia.contrib.barter.CmdFinish.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdFinish.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'trading'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdFinish.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.CmdFinish.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdFinish.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdFinish.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdFinish.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdFinish.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdFinish.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>end trade</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdFinish.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdFinish.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdFinish.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdFinish.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdFinish.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'finish trade', 'category': 'trading', 'key': 'end trade', 'no_prefix': ' finish trade', 'tags': '', 'text': '\n end the trade prematurely\n\n Usage:\n end trade [:say]\n finish trade [:say]\n\n This ends the trade prematurely. No trade will take place.\n\n '}</em><a class="headerlink" href="#evennia.contrib.barter.CmdFinish.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdFinish.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'finish trade', 'category': 'trading', 'key': 'end trade', 'no_prefix': ' finish trade', 'tags': '', 'text': '\n end the trade prematurely\n\n Usage:\n end trade [:say]\n finish trade [:say]\n\n This ends the trade prematurely. No trade will take place.\n\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdFinish.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.barter.CmdsetTrade">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.barter.</code><code class="sig-name descname">CmdsetTrade</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdsetTrade"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdsetTrade" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdsetTrade">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.barter.barter.</code><code class="sig-name descname">CmdsetTrade</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdsetTrade"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdsetTrade" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
|
||||
<p>This cmdset is added when trade is initated. It is handled by the
|
||||
trade event handler.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdsetTrade.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'cmdset_trade'</em><a class="headerlink" href="#evennia.contrib.barter.CmdsetTrade.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdsetTrade.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'cmdset_trade'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdsetTrade.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.CmdsetTrade.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdsetTrade.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdsetTrade.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdsetTrade.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdsetTrade.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdsetTrade.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when cmdset is created</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdsetTrade.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.barter.CmdsetTrade'</em><a class="headerlink" href="#evennia.contrib.barter.CmdsetTrade.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdsetTrade.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.barter.barter.CmdsetTrade'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdsetTrade.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.barter.CmdTrade">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.barter.</code><code class="sig-name descname">CmdTrade</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdTrade"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdTrade" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTrade">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.barter.barter.</code><code class="sig-name descname">CmdTrade</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdTrade"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTrade" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Initiate trade with another party</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -806,39 +806,39 @@ yourself if you want to retract an already suggested trade. The
|
|||
optional say part works like the say command and allows you to add
|
||||
info to your choice.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTrade.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'trade'</em><a class="headerlink" href="#evennia.contrib.barter.CmdTrade.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTrade.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'trade'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTrade.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTrade.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['barter']</em><a class="headerlink" href="#evennia.contrib.barter.CmdTrade.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTrade.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['barter']</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTrade.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTrade.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdTrade.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTrade.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTrade.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTrade.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.barter.CmdTrade.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTrade.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTrade.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.barter.CmdTrade.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/barter.html#CmdTrade.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.barter.CmdTrade.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTrade.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/barter.html#CmdTrade.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTrade.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initiate trade</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTrade.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.barter.CmdTrade.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTrade.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTrade.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.barter.CmdTrade.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'barter', 'category': 'general', 'key': 'trade', 'no_prefix': ' barter', 'tags': '', 'text': '\n Initiate trade with another party\n\n Usage:\n trade <other party> [:say]\n trade <other party> accept [:say]\n trade <other party> decline [:say]\n\n Initiate trade with another party. The other party needs to repeat\n this command with trade accept/decline within a minute in order to\n properly initiate the trade action. You can use the decline option\n yourself if you want to retract an already suggested trade. The\n optional say part works like the say command and allows you to add\n info to your choice.\n '}</em><a class="headerlink" href="#evennia.contrib.barter.CmdTrade.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdTrade.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'barter', 'category': 'general', 'key': 'trade', 'no_prefix': ' barter', 'tags': '', 'text': '\n Initiate trade with another party\n\n Usage:\n trade <other party> [:say]\n trade <other party> accept [:say]\n trade <other party> decline [:say]\n\n Initiate trade with another party. The other party needs to repeat\n this command with trade accept/decline within a minute in order to\n properly initiate the trade action. You can use the decline option\n yourself if you want to retract an already suggested trade. The\n optional say part works like the say command and allows you to add\n info to your choice.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdTrade.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -868,7 +868,7 @@ info to your choice.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.barter.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.barter.barter.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -884,8 +884,8 @@ info to your choice.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.barter.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.barter.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.game_systems.barter.barter.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -902,7 +902,7 @@ info to your choice.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.barter</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.barter.barter</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
120
docs/1.0-dev/api/evennia.contrib.game_systems.barter.html
Normal file
120
docs/1.0-dev/api/evennia.contrib.game_systems.barter.html
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.barter — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.barter</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.barter">
|
||||
<span id="evennia-contrib-game-systems-barter"></span><h1>evennia.contrib.game_systems.barter<a class="headerlink" href="#module-evennia.contrib.game_systems.barter" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Barter contrib - Griatch 2012</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.barter.barter.html">evennia.contrib.game_systems.barter.barter</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.barter.tests.html">evennia.contrib.game_systems.barter.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.barter.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.barter.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.barter</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
151
docs/1.0-dev/api/evennia.contrib.game_systems.barter.tests.html
Normal file
151
docs/1.0-dev/api/evennia.contrib.game_systems.barter.tests.html
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.barter.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.barter.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.barter.tests">
|
||||
<span id="evennia-contrib-game-systems-barter-tests"></span><h1>evennia.contrib.game_systems.barter.tests<a class="headerlink" href="#module-evennia.contrib.game_systems.barter.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Test the contrib barter system</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.barter.tests.TestBarter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.barter.tests.</code><code class="sig-name descname">TestBarter</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/tests.html#TestBarter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.tests.TestBarter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.barter.tests.TestBarter.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/tests.html#TestBarter.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.tests.TestBarter.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.barter.tests.TestBarter.test_tradehandler_base">
|
||||
<code class="sig-name descname">test_tradehandler_base</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/tests.html#TestBarter.test_tradehandler_base"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.tests.TestBarter.test_tradehandler_base" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.barter.tests.TestBarter.test_tradehandler_joins">
|
||||
<code class="sig-name descname">test_tradehandler_joins</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/tests.html#TestBarter.test_tradehandler_joins"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.tests.TestBarter.test_tradehandler_joins" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.barter.tests.TestBarter.test_tradehandler_offers">
|
||||
<code class="sig-name descname">test_tradehandler_offers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/tests.html#TestBarter.test_tradehandler_offers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.tests.TestBarter.test_tradehandler_offers" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.barter.tests.TestBarter.test_cmdtrade">
|
||||
<code class="sig-name descname">test_cmdtrade</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/tests.html#TestBarter.test_cmdtrade"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.tests.TestBarter.test_cmdtrade" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.barter.tests.TestBarter.test_cmdtradehelp">
|
||||
<code class="sig-name descname">test_cmdtradehelp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/barter/tests.html#TestBarter.test_cmdtradehelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.barter.tests.TestBarter.test_cmdtradehelp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.barter.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.barter.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.barter.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.clothing — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.game_systems.clothing.clothing — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.clothing</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.clothing.clothing</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.clothing">
|
||||
<span id="evennia-contrib-clothing"></span><h1>evennia.contrib.clothing<a class="headerlink" href="#module-evennia.contrib.clothing" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.game_systems.clothing.clothing">
|
||||
<span id="evennia-contrib-game-systems-clothing-clothing"></span><h1>evennia.contrib.game_systems.clothing.clothing<a class="headerlink" href="#module-evennia.contrib.game_systems.clothing.clothing" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Clothing - Provides a typeclass and commands for wearable clothing,
|
||||
which is appended to a character’s description when worn.</p>
|
||||
<p>Evennia contribution - Tim Ashley Jenkins 2017</p>
|
||||
|
|
@ -85,13 +85,13 @@ system for armor or other equipment.</p>
|
|||
<p>To install, import this module and have your default character
|
||||
inherit from ClothedCharacter in your game’s characters.py file:</p>
|
||||
<blockquote>
|
||||
<div><p>from evennia.contrib.clothing import ClothedCharacter</p>
|
||||
<div><p>from evennia.contrib.game_systems.clothing import ClothedCharacter</p>
|
||||
<p>class Character(ClothedCharacter):</p>
|
||||
</div></blockquote>
|
||||
<p>And then add ClothedCharacterCmdSet in your character set in your
|
||||
game’s commands/default_cmdsets.py:</p>
|
||||
<blockquote>
|
||||
<div><p>from evennia.contrib.clothing import ClothedCharacterCmdSet</p>
|
||||
<div><p>from evennia.contrib.game_systems.clothing import ClothedCharacterCmdSet</p>
|
||||
<dl>
|
||||
<dt>class CharacterCmdSet(default_cmds.CharacterCmdSet):</dt><dd><p>…
|
||||
at_cmdset_creation(self):</p>
|
||||
|
|
@ -106,13 +106,13 @@ self.add(ClothedCharacterCmdSet) # <– add this</p>
|
|||
<p>From here, you can use the default builder commands to create clothes
|
||||
with which to test the system:</p>
|
||||
<blockquote>
|
||||
<div><p>@create a pretty shirt : evennia.contrib.clothing.Clothing
|
||||
<div><p>@create a pretty shirt : evennia.contrib.game_systems.clothing.ContribClothing
|
||||
@set shirt/clothing_type = ‘top’
|
||||
wear shirt</p>
|
||||
</div></blockquote>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.clothing.order_clothes_list">
|
||||
<code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">order_clothes_list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">clothes_list</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#order_clothes_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.order_clothes_list" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.order_clothes_list">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.clothing.</code><code class="sig-name descname">order_clothes_list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">clothes_list</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#order_clothes_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.order_clothes_list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Orders a given clothes list by the order specified in CLOTHING_TYPE_ORDER.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -131,8 +131,8 @@ specified in CLOTHING_TYPE_ORDER.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.clothing.get_worn_clothes">
|
||||
<code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">get_worn_clothes</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">exclude_covered</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#get_worn_clothes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.get_worn_clothes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.get_worn_clothes">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.clothing.</code><code class="sig-name descname">get_worn_clothes</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">exclude_covered</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#get_worn_clothes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.get_worn_clothes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get a list of clothes worn by a given character.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -156,8 +156,8 @@ in this module.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.clothing.clothing_type_count">
|
||||
<code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">clothing_type_count</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">clothes_list</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#clothing_type_count"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.clothing_type_count" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.clothing_type_count">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.clothing.</code><code class="sig-name descname">clothing_type_count</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">clothes_list</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#clothing_type_count"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.clothing_type_count" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a dictionary of the number of each clothing type
|
||||
in a given list of clothing objects.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -179,8 +179,8 @@ clothing type represented.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.clothing.single_type_count">
|
||||
<code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">single_type_count</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">clothes_list</span></em>, <em class="sig-param"><span class="n">type</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#single_type_count"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.single_type_count" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.single_type_count">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.clothing.</code><code class="sig-name descname">single_type_count</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">clothes_list</span></em>, <em class="sig-param"><span class="n">type</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#single_type_count"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.single_type_count" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns an integer value of the number of a given type of clothing in a list.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -201,12 +201,12 @@ clothing type represented.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.clothing.Clothing">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">Clothing</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">db_key</span></em>, <em class="sig-param"><span class="n">db_typeclass_path</span></em>, <em class="sig-param"><span class="n">db_date_created</span></em>, <em class="sig-param"><span class="n">db_lock_storage</span></em>, <em class="sig-param"><span class="n">db_account</span></em>, <em class="sig-param"><span class="n">db_sessid</span></em>, <em class="sig-param"><span class="n">db_location</span></em>, <em class="sig-param"><span class="n">db_home</span></em>, <em class="sig-param"><span class="n">db_destination</span></em>, <em class="sig-param"><span class="n">db_cmdset_storage</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#Clothing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.Clothing" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ContribClothing">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.clothing.</code><code class="sig-name descname">ContribClothing</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">db_key</span></em>, <em class="sig-param"><span class="n">db_typeclass_path</span></em>, <em class="sig-param"><span class="n">db_date_created</span></em>, <em class="sig-param"><span class="n">db_lock_storage</span></em>, <em class="sig-param"><span class="n">db_account</span></em>, <em class="sig-param"><span class="n">db_sessid</span></em>, <em class="sig-param"><span class="n">db_location</span></em>, <em class="sig-param"><span class="n">db_home</span></em>, <em class="sig-param"><span class="n">db_destination</span></em>, <em class="sig-param"><span class="n">db_cmdset_storage</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#ContribClothing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ContribClothing" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.clothing.Clothing.wear">
|
||||
<code class="sig-name descname">wear</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wearer</span></em>, <em class="sig-param"><span class="n">wearstyle</span></em>, <em class="sig-param"><span class="n">quiet</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#Clothing.wear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.Clothing.wear" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ContribClothing.wear">
|
||||
<code class="sig-name descname">wear</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wearer</span></em>, <em class="sig-param"><span class="n">wearstyle</span></em>, <em class="sig-param"><span class="n">quiet</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#ContribClothing.wear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ContribClothing.wear" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets clothes to ‘worn’ and optionally echoes to the room.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -227,8 +227,8 @@ her waist’. If db.worn is set to ‘True’ then just the name will be shown.<
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.clothing.Clothing.remove">
|
||||
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wearer</span></em>, <em class="sig-param"><span class="n">quiet</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#Clothing.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.Clothing.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ContribClothing.remove">
|
||||
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wearer</span></em>, <em class="sig-param"><span class="n">quiet</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#ContribClothing.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ContribClothing.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Removes worn clothes and optionally echoes to the room.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -241,47 +241,47 @@ her waist’. If db.worn is set to ‘True’ then just the name will be shown.<
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.clothing.Clothing.at_get">
|
||||
<code class="sig-name descname">at_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">getter</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#Clothing.at_get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.Clothing.at_get" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ContribClothing.at_get">
|
||||
<code class="sig-name descname">at_get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">getter</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#ContribClothing.at_get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ContribClothing.at_get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Makes absolutely sure clothes aren’t already set as ‘worn’
|
||||
when they’re picked up, in case they’ve somehow had their
|
||||
location changed without getting removed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.clothing.Clothing.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.clothing.Clothing.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ContribClothing.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ContribClothing.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject.DoesNotExist" title="evennia.objects.objects.DefaultObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.clothing.Clothing.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.clothing.Clothing.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ContribClothing.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ContribClothing.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject.MultipleObjectsReturned" title="evennia.objects.objects.DefaultObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.Clothing.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.clothing.Clothing'</em><a class="headerlink" href="#evennia.contrib.clothing.Clothing.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ContribClothing.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.clothing.clothing.ContribClothing'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ContribClothing.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.Clothing.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'Clothing'</em><a class="headerlink" href="#evennia.contrib.clothing.Clothing.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ContribClothing.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'ContribClothing'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ContribClothing.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.clothing.ClothedCharacter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">ClothedCharacter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#ClothedCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacter" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ClothedCharacter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.clothing.</code><code class="sig-name descname">ClothedCharacter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#ClothedCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ClothedCharacter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter" title="evennia.objects.objects.DefaultCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter</span></code></a></p>
|
||||
<p>Character that displays worn clothing when looked at. You can also
|
||||
just copy the return_appearance hook defined below to your own game’s
|
||||
character typeclass.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.clothing.ClothedCharacter.return_appearance">
|
||||
<code class="sig-name descname">return_appearance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#ClothedCharacter.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacter.return_appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ClothedCharacter.return_appearance">
|
||||
<code class="sig-name descname">return_appearance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#ClothedCharacter.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ClothedCharacter.return_appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This formats a description. It is the hook a ‘look’ command
|
||||
should call.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -298,32 +298,32 @@ characters to specify how clothing is worn.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.clothing.ClothedCharacter.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacter.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ClothedCharacter.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ClothedCharacter.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.DoesNotExist" title="evennia.objects.objects.DefaultCharacter.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.clothing.ClothedCharacter.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacter.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ClothedCharacter.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ClothedCharacter.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned" title="evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.ClothedCharacter.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.clothing.ClothedCharacter'</em><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacter.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ClothedCharacter.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.clothing.clothing.ClothedCharacter'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ClothedCharacter.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.ClothedCharacter.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'ClothedCharacter'</em><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacter.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ClothedCharacter.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'ClothedCharacter'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ClothedCharacter.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.clothing.CmdWear">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">CmdWear</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdWear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdWear" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdWear">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.clothing.</code><code class="sig-name descname">CmdWear</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#CmdWear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdWear" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Puts on an item of clothing you are holding.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -337,41 +337,41 @@ wear scarf wrapped loosely about the shoulders</p>
|
|||
If you provide a ‘wear style’ after the command, the message you
|
||||
provide will be displayed after the clothing’s name.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdWear.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'wear'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdWear.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdWear.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'wear'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdWear.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdWear.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'clothing'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdWear.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdWear.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'clothing'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdWear.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.clothing.CmdWear.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdWear.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdWear.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdWear.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#CmdWear.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdWear.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdWear.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.clothing.CmdWear.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdWear.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdWear.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdWear.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdWear.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdWear.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdWear.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdWear.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'clothing', 'key': 'wear', 'no_prefix': ' ', 'tags': '', 'text': "\n Puts on an item of clothing you are holding.\n\n Usage:\n wear <obj> [wear style]\n\n Examples:\n wear shirt\n wear scarf wrapped loosely about the shoulders\n\n All the clothes you are wearing are appended to your description.\n If you provide a 'wear style' after the command, the message you\n provide will be displayed after the clothing's name.\n "}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdWear.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdWear.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'clothing', 'key': 'wear', 'no_prefix': ' ', 'tags': '', 'text': "\n Puts on an item of clothing you are holding.\n\n Usage:\n wear <obj> [wear style]\n\n Examples:\n wear shirt\n wear scarf wrapped loosely about the shoulders\n\n All the clothes you are wearing are appended to your description.\n If you provide a 'wear style' after the command, the message you\n provide will be displayed after the clothing's name.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdWear.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.clothing.CmdRemove">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">CmdRemove</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdRemove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdRemove" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdRemove">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.clothing.</code><code class="sig-name descname">CmdRemove</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#CmdRemove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdRemove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Takes off an item of clothing.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -382,41 +382,41 @@ provide will be displayed after the clothing’s name.</p>
|
|||
clothes that are covered up by something else - you must take
|
||||
off the covering item first.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdRemove.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'remove'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdRemove.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdRemove.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'remove'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdRemove.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdRemove.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'clothing'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdRemove.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdRemove.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'clothing'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdRemove.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.clothing.CmdRemove.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdRemove.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdRemove.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdRemove.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#CmdRemove.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdRemove.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdRemove.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.clothing.CmdRemove.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdRemove.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdRemove.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdRemove.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdRemove.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdRemove.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdRemove.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdRemove.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'clothing', 'key': 'remove', 'no_prefix': ' ', 'tags': '', 'text': "\n Takes off an item of clothing.\n\n Usage:\n remove <obj>\n\n Removes an item of clothing you are wearing. You can't remove\n clothes that are covered up by something else - you must take\n off the covering item first.\n "}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdRemove.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdRemove.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'clothing', 'key': 'remove', 'no_prefix': ' ', 'tags': '', 'text': "\n Takes off an item of clothing.\n\n Usage:\n remove <obj>\n\n Removes an item of clothing you are wearing. You can't remove\n clothes that are covered up by something else - you must take\n off the covering item first.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdRemove.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.clothing.CmdCover">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">CmdCover</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdCover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdCover" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdCover">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.clothing.</code><code class="sig-name descname">CmdCover</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#CmdCover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdCover" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Covers a worn item of clothing with another you’re holding or wearing.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -427,41 +427,41 @@ off the covering item first.</p>
|
|||
your description until it’s uncovered or the item covering it is removed.
|
||||
You can’t remove an item of clothing if it’s covered.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdCover.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'cover'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdCover.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdCover.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'cover'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdCover.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdCover.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'clothing'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdCover.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdCover.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'clothing'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdCover.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.clothing.CmdCover.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdCover.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdCover.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdCover.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#CmdCover.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdCover.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdCover.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.clothing.CmdCover.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdCover.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdCover.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdCover.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdCover.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdCover.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdCover.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdCover.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'clothing', 'key': 'cover', 'no_prefix': ' ', 'tags': '', 'text': "\n Covers a worn item of clothing with another you're holding or wearing.\n\n Usage:\n cover <obj> [with] <obj>\n\n When you cover a clothing item, it is hidden and no longer appears in\n your description until it's uncovered or the item covering it is removed.\n You can't remove an item of clothing if it's covered.\n "}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdCover.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdCover.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'clothing', 'key': 'cover', 'no_prefix': ' ', 'tags': '', 'text': "\n Covers a worn item of clothing with another you're holding or wearing.\n\n Usage:\n cover <obj> [with] <obj>\n\n When you cover a clothing item, it is hidden and no longer appears in\n your description until it's uncovered or the item covering it is removed.\n You can't remove an item of clothing if it's covered.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdCover.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.clothing.CmdUncover">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">CmdUncover</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdUncover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdUncover" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdUncover">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.clothing.</code><code class="sig-name descname">CmdUncover</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#CmdUncover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdUncover" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Reveals a worn item of clothing that’s currently covered up.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -473,41 +473,41 @@ description without having to take off the garment that’s currently
|
|||
covering it. You can’t uncover an item of clothing if the item covering
|
||||
it is also covered by something else.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdUncover.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'uncover'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdUncover.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdUncover.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'uncover'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdUncover.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdUncover.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'clothing'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdUncover.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdUncover.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'clothing'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdUncover.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.clothing.CmdUncover.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdUncover.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdUncover.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdUncover.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#CmdUncover.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdUncover.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdUncover.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.clothing.CmdUncover.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdUncover.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdUncover.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdUncover.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdUncover.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdUncover.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdUncover.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdUncover.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'clothing', 'key': 'uncover', 'no_prefix': ' ', 'tags': '', 'text': "\n Reveals a worn item of clothing that's currently covered up.\n\n Usage:\n uncover <obj>\n\n When you uncover an item of clothing, you allow it to appear in your\n description without having to take off the garment that's currently\n covering it. You can't uncover an item of clothing if the item covering\n it is also covered by something else.\n "}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdUncover.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdUncover.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'clothing', 'key': 'uncover', 'no_prefix': ' ', 'tags': '', 'text': "\n Reveals a worn item of clothing that's currently covered up.\n\n Usage:\n uncover <obj>\n\n When you uncover an item of clothing, you allow it to appear in your\n description without having to take off the garment that's currently\n covering it. You can't uncover an item of clothing if the item covering\n it is also covered by something else.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdUncover.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.clothing.CmdDrop">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">CmdDrop</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdDrop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdDrop">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.clothing.</code><code class="sig-name descname">CmdDrop</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#CmdDrop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdDrop" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>drop something</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -517,51 +517,51 @@ it is also covered by something else.</p>
|
|||
<p>Lets you drop an object from your inventory into the
|
||||
location you are currently in.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdDrop.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'drop'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdDrop.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'drop'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdDrop.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdDrop.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdDrop.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdDrop.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdDrop.arg_regex">
|
||||
<code class="sig-name descname">arg_regex</code><em class="property"> = re.compile('\\s|$', re.IGNORECASE)</em><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.arg_regex" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdDrop.arg_regex">
|
||||
<code class="sig-name descname">arg_regex</code><em class="property"> = re.compile('\\s|$', re.IGNORECASE)</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdDrop.arg_regex" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.clothing.CmdDrop.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdDrop.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdDrop.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#CmdDrop.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdDrop.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Implement command</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdDrop.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdDrop.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdDrop.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdDrop.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdDrop.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdDrop.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdDrop.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdDrop.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdDrop.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdDrop.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'drop', 'no_prefix': ' ', 'tags': '', 'text': '\n drop something\n\n Usage:\n drop <obj>\n\n Lets you drop an object from your inventory into the\n location you are currently in.\n '}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdDrop.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdDrop.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'drop', 'no_prefix': ' ', 'tags': '', 'text': '\n drop something\n\n Usage:\n drop <obj>\n\n Lets you drop an object from your inventory into the\n location you are currently in.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdDrop.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.clothing.CmdGive">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">CmdGive</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdGive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdGive" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdGive">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.clothing.</code><code class="sig-name descname">CmdGive</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#CmdGive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdGive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>give away something to someone</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -571,51 +571,51 @@ location you are currently in.</p>
|
|||
<p>Gives an items from your inventory to another character,
|
||||
placing it in their inventory.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdGive.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'give'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdGive.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'give'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdGive.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdGive.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdGive.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdGive.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdGive.arg_regex">
|
||||
<code class="sig-name descname">arg_regex</code><em class="property"> = re.compile('\\s|$', re.IGNORECASE)</em><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.arg_regex" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdGive.arg_regex">
|
||||
<code class="sig-name descname">arg_regex</code><em class="property"> = re.compile('\\s|$', re.IGNORECASE)</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdGive.arg_regex" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.clothing.CmdGive.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdGive.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdGive.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#CmdGive.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdGive.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Implement give</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdGive.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdGive.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdGive.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdGive.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdGive.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdGive.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdGive.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdGive.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdGive.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdGive.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'give', 'no_prefix': ' ', 'tags': '', 'text': '\n give away something to someone\n\n Usage:\n give <inventory obj> = <target>\n\n Gives an items from your inventory to another character,\n placing it in their inventory.\n '}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdGive.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdGive.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'give', 'no_prefix': ' ', 'tags': '', 'text': '\n give away something to someone\n\n Usage:\n give <inventory obj> = <target>\n\n Gives an items from your inventory to another character,\n placing it in their inventory.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdGive.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.clothing.CmdInventory">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">CmdInventory</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdInventory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdInventory">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.clothing.</code><code class="sig-name descname">CmdInventory</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#CmdInventory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdInventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>view inventory</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -625,70 +625,70 @@ inv</p>
|
|||
</dl>
|
||||
<p>Shows your inventory.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdInventory.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'inventory'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdInventory.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'inventory'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdInventory.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdInventory.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['i', 'inv']</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdInventory.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['i', 'inv']</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdInventory.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdInventory.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdInventory.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdInventory.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdInventory.arg_regex">
|
||||
<code class="sig-name descname">arg_regex</code><em class="property"> = re.compile('$', re.IGNORECASE)</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.arg_regex" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdInventory.arg_regex">
|
||||
<code class="sig-name descname">arg_regex</code><em class="property"> = re.compile('$', re.IGNORECASE)</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdInventory.arg_regex" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.clothing.CmdInventory.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#CmdInventory.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdInventory.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#CmdInventory.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdInventory.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>check inventory</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdInventory.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdInventory.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdInventory.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdInventory.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdInventory.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdInventory.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.CmdInventory.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'no_prefix': ' i inv', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.CmdInventory.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'no_prefix': ' i inv', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdInventory.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.clothing.ClothedCharacterCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.clothing.</code><code class="sig-name descname">ClothedCharacterCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#ClothedCharacterCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacterCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ClothedCharacterCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.clothing.</code><code class="sig-name descname">ClothedCharacterCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#ClothedCharacterCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ClothedCharacterCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.cmdset_character.html#evennia.commands.default.cmdset_character.CharacterCmdSet" title="evennia.commands.default.cmdset_character.CharacterCmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.cmdset_character.CharacterCmdSet</span></code></a></p>
|
||||
<p>Command set for clothing, including new versions of ‘give’ and ‘drop’
|
||||
that take worn and covered clothing into account, as well as a new
|
||||
version of ‘inventory’ that differentiates between carried and worn
|
||||
items.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.ClothedCharacterCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'DefaultCharacter'</em><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacterCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ClothedCharacterCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'DefaultCharacter'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ClothedCharacterCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.clothing.ClothedCharacterCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/clothing.html#ClothedCharacterCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacterCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ClothedCharacterCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/clothing.html#ClothedCharacterCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ClothedCharacterCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Populates the cmdset</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.clothing.ClothedCharacterCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.clothing.ClothedCharacterCmdSet'</em><a class="headerlink" href="#evennia.contrib.clothing.ClothedCharacterCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.clothing.clothing.ClothedCharacterCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.clothing.clothing.ClothedCharacterCmdSet'</em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.ClothedCharacterCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -718,7 +718,7 @@ items.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.clothing.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.clothing.clothing.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -734,8 +734,8 @@ items.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.clothing.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.clothing.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.game_systems.clothing.clothing.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -752,7 +752,7 @@ items.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.clothing</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.clothing.clothing</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
120
docs/1.0-dev/api/evennia.contrib.game_systems.clothing.html
Normal file
120
docs/1.0-dev/api/evennia.contrib.game_systems.clothing.html
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.clothing — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.clothing</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.clothing">
|
||||
<span id="evennia-contrib-game-systems-clothing"></span><h1>evennia.contrib.game_systems.clothing<a class="headerlink" href="#module-evennia.contrib.game_systems.clothing" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Clothing contrib - Tim Ashley Jenkins 2017</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.clothing.clothing.html">evennia.contrib.game_systems.clothing.clothing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.clothing.tests.html">evennia.contrib.game_systems.clothing.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.clothing.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.clothing.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.clothing</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,136 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.clothing.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.clothing.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.clothing.tests">
|
||||
<span id="evennia-contrib-game-systems-clothing-tests"></span><h1>evennia.contrib.game_systems.clothing.tests<a class="headerlink" href="#module-evennia.contrib.game_systems.clothing.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Testing clothing contrib</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.clothing.tests.TestClothingCmd">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.tests.</code><code class="sig-name descname">TestClothingCmd</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/tests.html#TestClothingCmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.tests.TestClothingCmd" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.clothing.tests.TestClothingCmd.test_clothingcommands">
|
||||
<code class="sig-name descname">test_clothingcommands</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/tests.html#TestClothingCmd.test_clothingcommands"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.tests.TestClothingCmd.test_clothingcommands" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.clothing.tests.TestClothingFunc">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.clothing.tests.</code><code class="sig-name descname">TestClothingFunc</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/tests.html#TestClothingFunc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.tests.TestClothingFunc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.clothing.tests.TestClothingFunc.test_clothingfunctions">
|
||||
<code class="sig-name descname">test_clothingfunctions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/clothing/tests.html#TestClothingFunc.test_clothingfunctions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.clothing.tests.TestClothingFunc.test_clothingfunctions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.clothing.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.clothing.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.clothing.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,347 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.cooldowns.cooldowns — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.cooldowns.cooldowns</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.cooldowns.cooldowns">
|
||||
<span id="evennia-contrib-game-systems-cooldowns-cooldowns"></span><h1>evennia.contrib.game_systems.cooldowns.cooldowns<a class="headerlink" href="#module-evennia.contrib.game_systems.cooldowns.cooldowns" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Cooldown contrib module.</p>
|
||||
<p>Evennia contrib - owllex, 2021</p>
|
||||
<p>This contrib provides a simple cooldown handler that can be attached to any
|
||||
typeclassed Object or Account. A cooldown is a lightweight persistent
|
||||
asynchronous timer that you can query to see if it is ready.</p>
|
||||
<p>Cooldowns are good for modelling rate-limited actions, like how often a
|
||||
character can perform a given command.</p>
|
||||
<p>Cooldowns are completely asynchronous and must be queried to know their
|
||||
state. They do not fire callbacks, so are not a good fit for use cases
|
||||
where something needs to happen on a specific schedule (use delay or
|
||||
a TickerHandler for that instead).</p>
|
||||
<p>See also the evennia documentation for command cooldowns
|
||||
(<a class="reference external" href="https://github.com/evennia/evennia/wiki/Command-Cooldown">https://github.com/evennia/evennia/wiki/Command-Cooldown</a>) for more information
|
||||
about the concept.</p>
|
||||
<p>Installation:</p>
|
||||
<p>To use, simply add the following property to the typeclass definition of any
|
||||
object type that you want to support cooldowns. It will expose a new <strong>cooldowns</strong>
|
||||
property that persists data to the object’s attribute storage. You can set this
|
||||
on your base <strong>Object</strong> typeclass to enable cooldown tracking on every kind of
|
||||
object, or just put it on your <strong>Character</strong> typeclass.</p>
|
||||
<p>By default the CooldownHandler will use the <strong>cooldowns</strong> property, but you can
|
||||
customize this if desired by passing a different value for the db_attribute
|
||||
parameter.</p>
|
||||
<blockquote>
|
||||
<div><p>from evennia.game_systems.contrib.cooldowns import Cooldownhandler
|
||||
from evennia.utils.utils import lazy_property</p>
|
||||
<p>@lazy_property
|
||||
def cooldowns(self):</p>
|
||||
<blockquote>
|
||||
<div><p>return CooldownHandler(self, db_attribute=”cooldowns”)</p>
|
||||
</div></blockquote>
|
||||
</div></blockquote>
|
||||
<p>Example:</p>
|
||||
<p>Assuming you’ve installed cooldowns on your Character typeclasses, you can use a
|
||||
cooldown to limit how often you can perform a command. The following code
|
||||
snippet will limit the use of a Power Attack command to once every 10 seconds
|
||||
per character.</p>
|
||||
<dl class="simple">
|
||||
<dt>class PowerAttack(Command):</dt><dd><dl class="simple">
|
||||
<dt>def func(self):</dt><dd><dl class="simple">
|
||||
<dt>if self.caller.cooldowns.ready(“power attack”):</dt><dd><p>self.do_power_attack()
|
||||
self.caller.cooldowns.add(“power attack”, 10)</p>
|
||||
</dd>
|
||||
<dt>else:</dt><dd><p>self.caller.msg(“That’s not ready yet!”)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.cooldowns.cooldowns.</code><code class="sig-name descname">CooldownHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">db_attribute</span><span class="o">=</span><span class="default_value">'cooldowns'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/cooldowns.html#CooldownHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>Handler for cooldowns. This can be attached to any object that supports DB
|
||||
attributes (like a Character or Account).</p>
|
||||
<p>A cooldown is a timer that is usually used to limit how often some action
|
||||
can be performed or some effect can trigger. When a cooldown is first added,
|
||||
it counts down from the amount of time provided back to zero, at which point
|
||||
it is considered ready again.</p>
|
||||
<p>Cooldowns are named with an arbitrary string, and that string is used to
|
||||
check on the progression of the cooldown. Each cooldown is tracked
|
||||
separately and independently from other cooldowns on that same object. A
|
||||
cooldown is unique per-object.</p>
|
||||
<p>Cooldowns are saved persistently, so they survive reboots. This module does
|
||||
not register or provide callback functionality for when a cooldown becomes
|
||||
ready again. Users of cooldowns are expected to query the state of any
|
||||
cooldowns they are interested in.</p>
|
||||
<p>Methods:
|
||||
- ready(name): Checks whether a given cooldown name is ready.
|
||||
- time_left(name): Returns how much time is left on a cooldown.
|
||||
- add(name, seconds): Sets a given cooldown to last for a certain</p>
|
||||
<blockquote>
|
||||
<div><p>amount of time. Until then, ready() will return False for that
|
||||
cooldown name. set() is an alias.</p>
|
||||
</div></blockquote>
|
||||
<ul class="simple">
|
||||
<li><dl class="simple">
|
||||
<dt>extend(name, seconds): Like add(), but adds more time to the given</dt><dd><p>cooldown if it already exists. If it doesn’t exist yet, calling
|
||||
this is equivalent to calling add().</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
<li><dl class="simple">
|
||||
<dt>reset(cooldown): Resets a given cooldown, causing ready() to return</dt><dd><p>True for that cooldown immediately.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
<li><p>clear(): Resets all cooldowns.</p></li>
|
||||
</ul>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">db_attribute</span><span class="o">=</span><span class="default_value">'cooldowns'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/cooldowns.html#CooldownHandler.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.data">
|
||||
<code class="sig-name descname">data</code><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.obj">
|
||||
<code class="sig-name descname">obj</code><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.obj" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.db_attribute">
|
||||
<code class="sig-name descname">db_attribute</code><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.db_attribute" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.all">
|
||||
<em class="property">property </em><code class="sig-name descname">all</code><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.all" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a list of all keys in this object.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.ready">
|
||||
<code class="sig-name descname">ready</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/cooldowns.html#CooldownHandler.ready"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.ready" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checks whether all of the provided cooldowns are ready (expired). If a
|
||||
requested cooldown does not exist, it is considered ready.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>*args</strong> (<em>str</em>) – One or more cooldown names to check.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>bool</em> – True if each cooldown has expired or does not exist.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.time_left">
|
||||
<code class="sig-name descname">time_left</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="n">use_int</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/cooldowns.html#CooldownHandler.time_left"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.time_left" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the maximum amount of time left on one or more given cooldowns.
|
||||
If a requested cooldown does not exist, it is considered to have 0 time
|
||||
left.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>*args</strong> (<em>str</em>) – One or more cooldown names to check.</p></li>
|
||||
<li><p><strong>use_int</strong> (<em>bool</em>) – True to round the return value up to an int,
|
||||
False (default) to return a more precise float.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>float or int</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>Number of seconds until all provided cooldowns are</dt><dd><p>ready. Returns 0 if all cooldowns are ready (or don’t exist.)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.add">
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cooldown</span></em>, <em class="sig-param"><span class="n">seconds</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/cooldowns.html#CooldownHandler.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds/sets a given cooldown to last for a specific amount of time.</p>
|
||||
<p>If this cooldown already exits, this call replaces it.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cooldown</strong> (<em>str</em>) – The name of the cooldown.</p></li>
|
||||
<li><p><strong>seconds</strong> (<em>float</em><em> or </em><em>int</em>) – The number of seconds before this cooldown
|
||||
is ready again.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.set">
|
||||
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cooldown</span></em>, <em class="sig-param"><span class="n">seconds</span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.set" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds/sets a given cooldown to last for a specific amount of time.</p>
|
||||
<p>If this cooldown already exits, this call replaces it.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cooldown</strong> (<em>str</em>) – The name of the cooldown.</p></li>
|
||||
<li><p><strong>seconds</strong> (<em>float</em><em> or </em><em>int</em>) – The number of seconds before this cooldown
|
||||
is ready again.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.extend">
|
||||
<code class="sig-name descname">extend</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cooldown</span></em>, <em class="sig-param"><span class="n">seconds</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/cooldowns.html#CooldownHandler.extend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.extend" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a specific amount of time to an existing cooldown.</p>
|
||||
<p>If this cooldown is already ready, this is equivalent to calling set. If
|
||||
the cooldown is not ready, it will be extended by the provided duration.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>cooldown</strong> (<em>str</em>) – The name of the cooldown.</p></li>
|
||||
<li><p><strong>seconds</strong> (<em>float</em><em> or </em><em>int</em>) – The number of seconds to extend this cooldown.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>float</em> – The number of seconds until the cooldown will be ready again.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.reset">
|
||||
<code class="sig-name descname">reset</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cooldown</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/cooldowns.html#CooldownHandler.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.reset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resets a given cooldown.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>cooldown</strong> (<em>str</em>) – The name of the cooldown.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.clear">
|
||||
<code class="sig-name descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/cooldowns.html#CooldownHandler.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.clear" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resets all cooldowns.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.cleanup">
|
||||
<code class="sig-name descname">cleanup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/cooldowns.html#CooldownHandler.cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.cooldowns.CooldownHandler.cleanup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Deletes all expired cooldowns. This helps keep attribute storage
|
||||
requirements small.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.cooldowns.cooldowns.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.cooldowns.cooldowns.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.cooldowns.cooldowns</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
120
docs/1.0-dev/api/evennia.contrib.game_systems.cooldowns.html
Normal file
120
docs/1.0-dev/api/evennia.contrib.game_systems.cooldowns.html
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.cooldowns — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.cooldowns</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.cooldowns">
|
||||
<span id="evennia-contrib-game-systems-cooldowns"></span><h1>evennia.contrib.game_systems.cooldowns<a class="headerlink" href="#module-evennia.contrib.game_systems.cooldowns" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Cooldown contrib - owllex 2021</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.cooldowns.cooldowns.html">evennia.contrib.game_systems.cooldowns.cooldowns</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.cooldowns.tests.html">evennia.contrib.game_systems.cooldowns.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.cooldowns.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.cooldowns.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.cooldowns</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,206 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.cooldowns.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.cooldowns.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.cooldowns.tests">
|
||||
<span id="evennia-contrib-game-systems-cooldowns-tests"></span><h1>evennia.contrib.game_systems.cooldowns.tests<a class="headerlink" href="#module-evennia.contrib.game_systems.cooldowns.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Cooldowns tests.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.cooldowns.tests.</code><code class="sig-name descname">TestCooldowns</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_empty">
|
||||
<code class="sig-name descname">test_empty</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_empty"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_empty" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_add">
|
||||
<code class="sig-name descname">test_add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_add_float">
|
||||
<code class="sig-name descname">test_add_float</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_add_float"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_add_float" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_add_multi">
|
||||
<code class="sig-name descname">test_add_multi</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_add_multi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_add_multi" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_add_none">
|
||||
<code class="sig-name descname">test_add_none</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_add_none"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_add_none" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_add_negative">
|
||||
<code class="sig-name descname">test_add_negative</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_add_negative"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_add_negative" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_add_overwrite">
|
||||
<code class="sig-name descname">test_add_overwrite</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_add_overwrite"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_add_overwrite" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_extend">
|
||||
<code class="sig-name descname">test_extend</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_extend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_extend" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_extend_none">
|
||||
<code class="sig-name descname">test_extend_none</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_extend_none"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_extend_none" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_extend_negative">
|
||||
<code class="sig-name descname">test_extend_negative</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_extend_negative"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_extend_negative" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_extend_float">
|
||||
<code class="sig-name descname">test_extend_float</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_extend_float"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_extend_float" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_reset_non_existent">
|
||||
<code class="sig-name descname">test_reset_non_existent</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_reset_non_existent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_reset_non_existent" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_reset">
|
||||
<code class="sig-name descname">test_reset</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_reset" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_clear">
|
||||
<code class="sig-name descname">test_clear</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_clear" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_cleanup">
|
||||
<code class="sig-name descname">test_cleanup</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_cleanup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_cleanup_doesnt_delete_anything">
|
||||
<code class="sig-name descname">test_cleanup_doesnt_delete_anything</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/cooldowns/tests.html#TestCooldowns.test_cleanup_doesnt_delete_anything"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.cooldowns.tests.TestCooldowns.test_cleanup_doesnt_delete_anything" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.cooldowns.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.cooldowns.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.cooldowns.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.crafting.crafting — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.game_systems.crafting.crafting — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -18,9 +18,7 @@
|
|||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="evennia.contrib.crafting.example_recipes" href="evennia.contrib.crafting.example_recipes.html" />
|
||||
<link rel="prev" title="Crafting system contrib" href="../Contribs/Crafting.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
|
|
@ -31,15 +29,8 @@
|
|||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.crafting.example_recipes.html" title="evennia.contrib.crafting.example_recipes"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../Contribs/Crafting.html" title="Crafting system contrib"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../Contribs/Contrib-Overview.html" accesskey="U">Contrib modules</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.crafting.crafting</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.crafting.crafting</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -49,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.crafting.crafting">
|
||||
<span id="evennia-contrib-crafting-crafting"></span><h1>evennia.contrib.crafting.crafting<a class="headerlink" href="#module-evennia.contrib.crafting.crafting" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.game_systems.crafting.crafting">
|
||||
<span id="evennia-contrib-game-systems-crafting-crafting"></span><h1>evennia.contrib.game_systems.crafting.crafting<a class="headerlink" href="#module-evennia.contrib.game_systems.crafting.crafting" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Crafting - Griatch 2020</p>
|
||||
<p>This is a general crafting engine. The basic functionality of crafting is to
|
||||
combine any number of of items or tools in a ‘recipe’ to produce a new result.</p>
|
||||
|
|
@ -98,7 +89,7 @@ during the crafting process.</p>
|
|||
specifies the name of the recipe to use and expects all suitable
|
||||
ingredients/tools as arguments (consumables and tools should be added together,
|
||||
tools will be identified before consumables).</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">evennia.contrib.crafting</span> <span class="kn">import</span> <span class="n">crafting</span>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">evennia.contrib.game_systems.crafting</span> <span class="kn">import</span> <span class="n">crafting</span>
|
||||
|
||||
<span class="n">spiked_club</span> <span class="o">=</span> <span class="n">crafting</span><span class="o">.</span><span class="n">craft</span><span class="p">(</span><span class="n">crafter</span><span class="p">,</span> <span class="s2">"spiked club"</span><span class="p">,</span> <span class="n">club</span><span class="p">,</span> <span class="n">nails</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
|
|
@ -124,7 +115,7 @@ crafting (<strong>CraftingRecipe</strong>) using objects and prototypes.</p>
|
|||
hood. See the <strong>CraftingRecipe</strong> class for details of which properties and
|
||||
methods are available to override - the craft behavior can be modified
|
||||
substantially this way.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">evennia.contrib.crafting.crafting</span> <span class="kn">import</span> <span class="n">CraftingRecipe</span>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">evennia.contrib.game_systems.crafting.crafting</span> <span class="kn">import</span> <span class="n">CraftingRecipe</span>
|
||||
|
||||
<span class="k">class</span> <span class="nc">PigIronRecipe</span><span class="p">(</span><span class="n">CraftingRecipe</span><span class="p">):</span>
|
||||
<span class="c1"># Pig iron is a high-carbon result of melting iron in a blast furnace.</span>
|
||||
|
|
@ -147,26 +138,26 @@ substantially this way.</p>
|
|||
</div>
|
||||
<p>If the above class was added to a module in <strong>CRAFT_RECIPE_MODULES</strong>, it could be
|
||||
called using its <strong>.name</strong> property, as “pig iron”.</p>
|
||||
<p>The [example_recipies](api:evennia.contrib.crafting.example_recipes) module has
|
||||
<p>The [example_recipies](api:evennia.contrib.game_systems.crafting.example_recipes) module has
|
||||
a full example of the components for creating a sword from base components.</p>
|
||||
<hr class="docutils" />
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingError">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">evennia.contrib.crafting.crafting.</code><code class="sig-name descname">CraftingError</code><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingError" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingError">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.crafting.</code><code class="sig-name descname">CraftingError</code><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">RuntimeError</span></code></p>
|
||||
<p>Crafting error.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingValidationError">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">evennia.contrib.crafting.crafting.</code><code class="sig-name descname">CraftingValidationError</code><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingValidationError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingValidationError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.crafting.crafting.CraftingError" title="evennia.contrib.crafting.crafting.CraftingError"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.crafting.crafting.CraftingError</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingValidationError">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.crafting.</code><code class="sig-name descname">CraftingValidationError</code><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingValidationError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingValidationError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.game_systems.crafting.crafting.CraftingError" title="evennia.contrib.game_systems.crafting.crafting.CraftingError"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.crafting.crafting.CraftingError</span></code></a></p>
|
||||
<p>Error if crafting validation failed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipeBase">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.crafting.</code><code class="sig-name descname">CraftingRecipeBase</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingRecipeBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipeBase" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.crafting.</code><code class="sig-name descname">CraftingRecipeBase</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingRecipeBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>The recipe handles all aspects of performing a ‘craft’ operation. This is
|
||||
the base of the crafting system, intended to be replace if you want to
|
||||
|
|
@ -196,18 +187,18 @@ raised a <strong>CraftingError</strong> or <strong>CraftingValidationError</stro
|
|||
Should return <strong>crafted_result</strong> (modified or not).</p></li>
|
||||
</ol>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipeBase.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'recipe base'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipeBase.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'recipe base'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipeBase.allow_reuse">
|
||||
<code class="sig-name descname">allow_reuse</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipeBase.allow_reuse" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.allow_reuse">
|
||||
<code class="sig-name descname">allow_reuse</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.allow_reuse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipeBase.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingRecipeBase.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipeBase.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingRecipeBase.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize the recipe.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -222,8 +213,8 @@ this recipe.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipeBase.msg">
|
||||
<code class="sig-name descname">msg</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingRecipeBase.msg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipeBase.msg" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.msg">
|
||||
<code class="sig-name descname">msg</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingRecipeBase.msg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.msg" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Send message to crafter. This is a central point to override if wanting
|
||||
to change crafting return style in some way.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -237,8 +228,8 @@ to change crafting return style in some way.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipeBase.pre_craft">
|
||||
<code class="sig-name descname">pre_craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingRecipeBase.pre_craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipeBase.pre_craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.pre_craft">
|
||||
<code class="sig-name descname">pre_craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingRecipeBase.pre_craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.pre_craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook to override.</p>
|
||||
<p>This is called just before crafting operation and is normally
|
||||
responsible for validating the inputs, storing data on
|
||||
|
|
@ -251,14 +242,14 @@ responsible for validating the inputs, storing data on
|
|||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Raises</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#evennia.contrib.crafting.crafting.CraftingValidationError" title="evennia.contrib.crafting.crafting.CraftingValidationError"><strong>CraftingValidationError</strong></a> – If validation fails.</p>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#evennia.contrib.game_systems.crafting.crafting.CraftingValidationError" title="evennia.contrib.game_systems.crafting.crafting.CraftingValidationError"><strong>CraftingValidationError</strong></a> – If validation fails.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipeBase.do_craft">
|
||||
<code class="sig-name descname">do_craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingRecipeBase.do_craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipeBase.do_craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.do_craft">
|
||||
<code class="sig-name descname">do_craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingRecipeBase.do_craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.do_craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook to override.</p>
|
||||
<p>This performs the actual crafting. At this point the inputs are
|
||||
expected to have been verified already. If needed, the validated
|
||||
|
|
@ -274,8 +265,8 @@ inputs are available on this recipe instance.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipeBase.post_craft">
|
||||
<code class="sig-name descname">post_craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafting_result</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingRecipeBase.post_craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipeBase.post_craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.post_craft">
|
||||
<code class="sig-name descname">post_craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafting_result</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingRecipeBase.post_craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.post_craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook to override.</p>
|
||||
<p>This is called just after crafting has finished. A common use of this
|
||||
method is to delete the inputs.</p>
|
||||
|
|
@ -293,8 +284,8 @@ method is to delete the inputs.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipeBase.craft">
|
||||
<code class="sig-name descname">craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">raise_exception</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingRecipeBase.craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipeBase.craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.craft">
|
||||
<code class="sig-name descname">craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">raise_exception</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingRecipeBase.craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase.craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Main crafting call method. Call this to produce a result and make
|
||||
sure all hooks run correctly.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -313,9 +304,9 @@ and be passed into all of the crafting hooks.</p></li>
|
|||
</dd>
|
||||
<dt class="field-odd">Raises</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><a class="reference internal" href="#evennia.contrib.crafting.crafting.CraftingValidationError" title="evennia.contrib.crafting.crafting.CraftingValidationError"><strong>CraftingValidationError</strong></a> – If recipe validation failed and
|
||||
<li><p><a class="reference internal" href="#evennia.contrib.game_systems.crafting.crafting.CraftingValidationError" title="evennia.contrib.game_systems.crafting.crafting.CraftingValidationError"><strong>CraftingValidationError</strong></a> – If recipe validation failed and
|
||||
<strong>raise_exception</strong> is True.</p></li>
|
||||
<li><p><a class="reference internal" href="#evennia.contrib.crafting.crafting.CraftingError" title="evennia.contrib.crafting.crafting.CraftingError"><strong>CraftingError</strong></a> – On If trying to rerun a no-rerun recipe, or if crafting
|
||||
<li><p><a class="reference internal" href="#evennia.contrib.game_systems.crafting.crafting.CraftingError" title="evennia.contrib.game_systems.crafting.crafting.CraftingError"><strong>CraftingError</strong></a> – On If trying to rerun a no-rerun recipe, or if crafting
|
||||
would return <strong>None</strong> and raise_exception** is set.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
|
@ -325,9 +316,9 @@ would return <strong>None</strong> and raise_exception** is set.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.crafting.</code><code class="sig-name descname">CraftingRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.crafting.crafting.CraftingRecipeBase" title="evennia.contrib.crafting.crafting.CraftingRecipeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.crafting.crafting.CraftingRecipeBase</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.crafting.</code><code class="sig-name descname">CraftingRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase" title="evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.crafting.crafting.CraftingRecipeBase</span></code></a></p>
|
||||
<p>The CraftRecipe implements the most common form of crafting: Combining (and
|
||||
consuming) inputs to produce a new result. This type of recipe only works
|
||||
with typeclassed entities as inputs and outputs, since it’s based on Tags
|
||||
|
|
@ -439,107 +430,107 @@ failed (<strong>crafting_result</strong> will then be falsy). It does any cleanu
|
|||
this deletes consumables.</p></li>
|
||||
</ol>
|
||||
<p>Use <strong>.msg</strong> to conveniently send messages to the crafter. Raise
|
||||
<strong>evennia.contrib.crafting.crafting.CraftingError</strong> exception to abort
|
||||
<strong>evennia.contrib.game_systems.crafting.crafting.CraftingError</strong> exception to abort
|
||||
crafting at any time in the sequence. If raising with a text, this will be
|
||||
shown to the crafter automatically</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'crafting recipe'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'crafting recipe'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.consumable_tag_category">
|
||||
<code class="sig-name descname">consumable_tag_category</code><em class="property"> = 'crafting_material'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.consumable_tag_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.consumable_tag_category">
|
||||
<code class="sig-name descname">consumable_tag_category</code><em class="property"> = 'crafting_material'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.consumable_tag_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.tool_tag_category">
|
||||
<code class="sig-name descname">tool_tag_category</code><em class="property"> = 'crafting_tool'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.tool_tag_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.tool_tag_category">
|
||||
<code class="sig-name descname">tool_tag_category</code><em class="property"> = 'crafting_tool'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.tool_tag_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.exact_tools">
|
||||
<code class="sig-name descname">exact_tools</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.exact_tools" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.exact_tools">
|
||||
<code class="sig-name descname">exact_tools</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.exact_tools" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.exact_tool_order">
|
||||
<code class="sig-name descname">exact_tool_order</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.exact_tool_order" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.exact_tool_order">
|
||||
<code class="sig-name descname">exact_tool_order</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.exact_tool_order" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.error_tool_missing_message">
|
||||
<code class="sig-name descname">error_tool_missing_message</code><em class="property"> = 'Could not craft {outputs} without {missing}.'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.error_tool_missing_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.error_tool_missing_message">
|
||||
<code class="sig-name descname">error_tool_missing_message</code><em class="property"> = 'Could not craft {outputs} without {missing}.'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.error_tool_missing_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.error_tool_order_message">
|
||||
<code class="sig-name descname">error_tool_order_message</code><em class="property"> = 'Could not craft {outputs} since {missing} was added in the wrong order.'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.error_tool_order_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.error_tool_order_message">
|
||||
<code class="sig-name descname">error_tool_order_message</code><em class="property"> = 'Could not craft {outputs} since {missing} was added in the wrong order.'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.error_tool_order_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.error_tool_excess_message">
|
||||
<code class="sig-name descname">error_tool_excess_message</code><em class="property"> = 'Could not craft {outputs} without the exact tools (extra {excess}).'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.error_tool_excess_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.error_tool_excess_message">
|
||||
<code class="sig-name descname">error_tool_excess_message</code><em class="property"> = 'Could not craft {outputs} without the exact tools (extra {excess}).'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.error_tool_excess_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.consume_on_fail">
|
||||
<code class="sig-name descname">consume_on_fail</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.consume_on_fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.consume_on_fail">
|
||||
<code class="sig-name descname">consume_on_fail</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.consume_on_fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.exact_consumables">
|
||||
<code class="sig-name descname">exact_consumables</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.exact_consumables" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.exact_consumables">
|
||||
<code class="sig-name descname">exact_consumables</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.exact_consumables" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.exact_consumable_order">
|
||||
<code class="sig-name descname">exact_consumable_order</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.exact_consumable_order" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.exact_consumable_order">
|
||||
<code class="sig-name descname">exact_consumable_order</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.exact_consumable_order" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.error_consumable_missing_message">
|
||||
<code class="sig-name descname">error_consumable_missing_message</code><em class="property"> = 'Could not craft {outputs} without {missing}.'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.error_consumable_missing_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.error_consumable_missing_message">
|
||||
<code class="sig-name descname">error_consumable_missing_message</code><em class="property"> = 'Could not craft {outputs} without {missing}.'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.error_consumable_missing_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.error_consumable_order_message">
|
||||
<code class="sig-name descname">error_consumable_order_message</code><em class="property"> = 'Could not craft {outputs} since {missing} was added in the wrong order.'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.error_consumable_order_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.error_consumable_order_message">
|
||||
<code class="sig-name descname">error_consumable_order_message</code><em class="property"> = 'Could not craft {outputs} since {missing} was added in the wrong order.'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.error_consumable_order_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.error_consumable_excess_message">
|
||||
<code class="sig-name descname">error_consumable_excess_message</code><em class="property"> = 'Could not craft {outputs} without the exact ingredients (extra {excess}).'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.error_consumable_excess_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.error_consumable_excess_message">
|
||||
<code class="sig-name descname">error_consumable_excess_message</code><em class="property"> = 'Could not craft {outputs} without the exact ingredients (extra {excess}).'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.error_consumable_excess_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.failure_message">
|
||||
<code class="sig-name descname">failure_message</code><em class="property"> = ''</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.failure_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.failure_message">
|
||||
<code class="sig-name descname">failure_message</code><em class="property"> = ''</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.failure_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.success_message">
|
||||
<code class="sig-name descname">success_message</code><em class="property"> = 'You successfully craft {outputs}!'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.success_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.success_message">
|
||||
<code class="sig-name descname">success_message</code><em class="property"> = 'You successfully craft {outputs}!'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.success_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingRecipe.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingRecipe.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
|
|
@ -560,23 +551,23 @@ types in the order inserted to the class constructor.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.consumable_names">
|
||||
<code class="sig-name descname">consumable_names</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.consumable_names" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.consumable_names">
|
||||
<code class="sig-name descname">consumable_names</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.consumable_names" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.tool_names">
|
||||
<code class="sig-name descname">tool_names</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.tool_names" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.tool_names">
|
||||
<code class="sig-name descname">tool_names</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.tool_names" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.output_names">
|
||||
<code class="sig-name descname">output_names</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.output_names" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.output_names">
|
||||
<code class="sig-name descname">output_names</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.output_names" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.seed">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">seed</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">tool_kwargs</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">consumable_kwargs</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingRecipe.seed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.seed" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.seed">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">seed</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">tool_kwargs</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">consumable_kwargs</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingRecipe.seed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.seed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is a helper class-method for easy testing and application of this
|
||||
recipe. When called, it will create simple dummy ingredients with names
|
||||
and tags needed by this recipe.</p>
|
||||
|
|
@ -612,8 +603,8 @@ of each type will have the same key.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.pre_craft">
|
||||
<code class="sig-name descname">pre_craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingRecipe.pre_craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.pre_craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.pre_craft">
|
||||
<code class="sig-name descname">pre_craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingRecipe.pre_craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.pre_craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do pre-craft checks, including input validation.</p>
|
||||
<p>Check so the given inputs are what is needed. This operates on
|
||||
<strong>self.inputs</strong> which is set to the inputs added to the class
|
||||
|
|
@ -625,15 +616,15 @@ and <strong>.validated_consumables</strong> respectively.</p>
|
|||
the recipe class.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raises</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#evennia.contrib.crafting.crafting.CraftingValidationError" title="evennia.contrib.crafting.crafting.CraftingValidationError"><strong>CraftingValidationError</strong></a> – If validation fails. At this point the crafter
|
||||
<dd class="field-even"><p><a class="reference internal" href="#evennia.contrib.game_systems.crafting.crafting.CraftingValidationError" title="evennia.contrib.game_systems.crafting.crafting.CraftingValidationError"><strong>CraftingValidationError</strong></a> – If validation fails. At this point the crafter
|
||||
is expected to have been informed of the problem already.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.do_craft">
|
||||
<code class="sig-name descname">do_craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingRecipe.do_craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.do_craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.do_craft">
|
||||
<code class="sig-name descname">do_craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingRecipe.do_craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.do_craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook to override. This will not be called if validation in <strong>pre_craft</strong>
|
||||
fails.</p>
|
||||
<p>This performs the actual crafting. At this point the inputs are
|
||||
|
|
@ -656,8 +647,8 @@ crafting process.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingRecipe.post_craft">
|
||||
<code class="sig-name descname">post_craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">craft_result</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingRecipe.post_craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingRecipe.post_craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.post_craft">
|
||||
<code class="sig-name descname">post_craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">craft_result</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingRecipe.post_craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe.post_craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook to override.
|
||||
This is called just after crafting has finished. A common use of
|
||||
this method is to delete the inputs.</p>
|
||||
|
|
@ -680,8 +671,8 @@ this method is to delete the inputs.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.crafting.crafting.craft">
|
||||
<code class="sig-prename descclassname">evennia.contrib.crafting.crafting.</code><code class="sig-name descname">craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="n">recipe_name</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="n">raise_exception</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.craft">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.crafting.</code><code class="sig-name descname">craft</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="n">recipe_name</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="n">raise_exception</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Access function. Craft a given recipe from a source recipe module. A
|
||||
recipe module is a Python module containing recipe classes. Note that this
|
||||
requires <strong>settings.CRAFT_RECIPE_MODULES</strong> to be added to a list of one or
|
||||
|
|
@ -705,7 +696,7 @@ recipe.craft).</p></li>
|
|||
</dd>
|
||||
<dt class="field-odd">Raises</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><a class="reference internal" href="#evennia.contrib.crafting.crafting.CraftingError" title="evennia.contrib.crafting.crafting.CraftingError"><strong>CraftingError</strong></a> – If <strong>raise_exception</strong> is True and crafting failed to</p></li>
|
||||
<li><p><a class="reference internal" href="#evennia.contrib.game_systems.crafting.crafting.CraftingError" title="evennia.contrib.game_systems.crafting.crafting.CraftingError"><strong>CraftingError</strong></a> – If <strong>raise_exception</strong> is True and crafting failed to</p></li>
|
||||
<li><p><strong>produce an output. KeyError</strong> – If <strong>recipe_name</strong> failed to find a</p></li>
|
||||
<li><p><strong>matching recipe class</strong><strong> (or </strong><strong>the hit was not precise enough.</strong><strong>)</strong> – </p></li>
|
||||
</ul>
|
||||
|
|
@ -713,37 +704,38 @@ recipe.craft).</p></li>
|
|||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>If no recipe_module is given, will look for a list <strong>settings.CRAFT_RECIPE_MODULES</strong> and
|
||||
lastly fall back to the example module <strong>“evennia.contrib.”</strong></p>
|
||||
lastly fall back to the example module
|
||||
<strong>“evennia.contrib.game_systems.crafting.example_recipes”</strong></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.crafting.</code><code class="sig-name descname">CraftingCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.crafting.</code><code class="sig-name descname">CraftingCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
|
||||
<p>Store crafting command.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'Crafting cmdset'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'Crafting cmdset'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CraftingCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CraftingCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method - this should be overloaded in the inheriting
|
||||
class, and should take care of populating the cmdset by use of
|
||||
self.add().</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CraftingCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.crafting.crafting.CraftingCmdSet'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CraftingCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CraftingCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.crafting.crafting.CraftingCmdSet'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CraftingCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.crafting.CmdCraft">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.crafting.</code><code class="sig-name descname">CmdCraft</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CmdCraft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CmdCraft" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CmdCraft">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.crafting.</code><code class="sig-name descname">CmdCraft</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CmdCraft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CmdCraft" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Craft an item using ingredients and tools</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -759,43 +751,43 @@ craft fireball using wand, spellbook</p>
|
|||
<p>Ingredients must be in the crafter’s inventory. Tools can also be
|
||||
things in the current location, like a furnace, windmill or anvil.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CmdCraft.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'craft'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CmdCraft.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CmdCraft.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'craft'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CmdCraft.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CmdCraft.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CmdCraft.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CmdCraft.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CmdCraft.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CmdCraft.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CmdCraft.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CmdCraft.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CmdCraft.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CmdCraft.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CmdCraft.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CmdCraft.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CmdCraft.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CmdCraft.arg_regex">
|
||||
<code class="sig-name descname">arg_regex</code><em class="property"> = re.compile('\\s|$', re.IGNORECASE)</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CmdCraft.arg_regex" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CmdCraft.arg_regex">
|
||||
<code class="sig-name descname">arg_regex</code><em class="property"> = re.compile('\\s|$', re.IGNORECASE)</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CmdCraft.arg_regex" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CmdCraft.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CmdCraft.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CmdCraft.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CmdCraft.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.crafting.CmdCraft.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'craft', 'no_prefix': ' ', 'tags': '', 'text': "\n Craft an item using ingredients and tools\n\n Usage:\n craft <recipe> [from <ingredient>,...] [using <tool>, ...]\n\n Examples:\n craft snowball from snow\n craft puppet from piece of wood using knife\n craft bread from flour, butter, water, yeast using owen, bowl, roller\n craft fireball using wand, spellbook\n\n Notes:\n Ingredients must be in the crafter's inventory. Tools can also be\n things in the current location, like a furnace, windmill or anvil.\n\n "}</em><a class="headerlink" href="#evennia.contrib.crafting.crafting.CmdCraft.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CmdCraft.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'craft', 'no_prefix': ' ', 'tags': '', 'text': "\n Craft an item using ingredients and tools\n\n Usage:\n craft <recipe> [from <ingredient>,...] [using <tool>, ...]\n\n Examples:\n craft snowball from snow\n craft puppet from piece of wood using knife\n craft bread from flour, butter, water, yeast using owen, bowl, roller\n craft fireball using wand, spellbook\n\n Notes:\n Ingredients must be in the crafter's inventory. Tools can also be\n things in the current location, like a furnace, windmill or anvil.\n\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CmdCraft.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.crafting.CmdCraft.parse">
|
||||
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CmdCraft.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CmdCraft.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CmdCraft.parse">
|
||||
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CmdCraft.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CmdCraft.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Handle parsing of:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">recipe</span><span class="o">></span> <span class="p">[</span><span class="n">FROM</span> <span class="o"><</span><span class="n">ingredients</span><span class="o">></span><span class="p">]</span> <span class="p">[</span><span class="n">USING</span> <span class="o"><</span><span class="n">tools</span><span class="o">></span><span class="p">]</span>
|
||||
</pre></div>
|
||||
|
|
@ -810,8 +802,8 @@ things in the current location, like a furnace, windmill or anvil.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.crafting.CmdCraft.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/crafting.html#CmdCraft.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.crafting.CmdCraft.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.crafting.CmdCraft.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/crafting.html#CmdCraft.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.crafting.CmdCraft.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Perform crafting.</p>
|
||||
<p>Will check the <strong>craft</strong> locktype. If a consumable/ingredient does not pass
|
||||
this check, we will check for the ‘crafting_consumable_err_msg’
|
||||
|
|
@ -846,7 +838,7 @@ the <strong>crafting_tool_err_msg</strong> if available.</p>
|
|||
<script>$('#searchbox').show(0);</script>
|
||||
<p><h3><a href="../index.html">Table of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">evennia.contrib.crafting.crafting</a><ul>
|
||||
<li><a class="reference internal" href="#">evennia.contrib.game_systems.crafting.crafting</a><ul>
|
||||
<li><a class="reference internal" href="#installation">Installation</a></li>
|
||||
<li><a class="reference internal" href="#crafting-in-game">Crafting in game</a></li>
|
||||
<li><a class="reference internal" href="#crafting-in-code">Crafting in code</a></li>
|
||||
|
|
@ -855,16 +847,10 @@ the <strong>crafting_tool_err_msg</strong> if available.</p>
|
|||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="../Contribs/Crafting.html"
|
||||
title="previous chapter">Crafting system contrib</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.crafting.example_recipes.html"
|
||||
title="next chapter">evennia.contrib.crafting.example_recipes</a></p>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.crafting.crafting.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.crafting.crafting.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -880,7 +866,7 @@ the <strong>crafting_tool_err_msg</strong> if available.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.crafting.crafting.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="evennia.contrib.game_systems.crafting.crafting.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -897,15 +883,8 @@ the <strong>crafting_tool_err_msg</strong> if available.</p>
|
|||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.crafting.example_recipes.html" title="evennia.contrib.crafting.example_recipes"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../Contribs/Crafting.html" title="Crafting system contrib"
|
||||
>previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../Contribs/Contrib-Overview.html" >Contrib modules</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.crafting.crafting</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.crafting.crafting</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.crafting.example_recipes — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.game_systems.crafting.example_recipes — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -18,9 +18,7 @@
|
|||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="A voice operated elevator using events" href="../Contribs/A-voice-operated-elevator-using-events.html" />
|
||||
<link rel="prev" title="evennia.contrib.crafting.crafting" href="evennia.contrib.crafting.crafting.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
|
|
@ -31,15 +29,8 @@
|
|||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../Contribs/A-voice-operated-elevator-using-events.html" title="A voice operated elevator using events"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.crafting.crafting.html" title="evennia.contrib.crafting.crafting"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../Contribs/Contrib-Overview.html" accesskey="U">Contrib modules</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.crafting.example_recipes</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.crafting.example_recipes</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -49,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.crafting.example_recipes">
|
||||
<span id="evennia-contrib-crafting-example-recipes"></span><h1>evennia.contrib.crafting.example_recipes<a class="headerlink" href="#module-evennia.contrib.crafting.example_recipes" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.game_systems.crafting.example_recipes">
|
||||
<span id="evennia-contrib-game-systems-crafting-example-recipes"></span><h1>evennia.contrib.game_systems.crafting.example_recipes<a class="headerlink" href="#module-evennia.contrib.game_systems.crafting.example_recipes" title="Permalink to this headline">¶</a></h1>
|
||||
<p>How to make a sword - example crafting tree for the crafting system.</p>
|
||||
<p>See the <strong>SwordSmithingBaseRecipe</strong> in this module for an example of extendng the
|
||||
recipe with a mocked ‘skill’ system (just random chance in our case). The skill
|
||||
|
|
@ -109,268 +100,268 @@ just mocked for the example.</p>
|
|||
</dl>
|
||||
<hr class="docutils" />
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.random">
|
||||
<code class="sig-prename descclassname">evennia.contrib.crafting.example_recipes.</code><code class="sig-name descname">random</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → x in the interval [0, 1).<a class="headerlink" href="#evennia.contrib.crafting.example_recipes.random" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.random">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.example_recipes.</code><code class="sig-name descname">random</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → x in the interval [0, 1).<a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.random" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.PigIronRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.example_recipes.</code><code class="sig-name descname">PigIronRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#PigIronRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.PigIronRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.crafting.crafting.html#evennia.contrib.crafting.crafting.CraftingRecipe" title="evennia.contrib.crafting.crafting.CraftingRecipe"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.crafting.crafting.CraftingRecipe</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.PigIronRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.example_recipes.</code><code class="sig-name descname">PigIronRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#PigIronRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.PigIronRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe" title="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.crafting.crafting.CraftingRecipe</span></code></a></p>
|
||||
<p>Pig iron is a high-carbon result of melting iron in a blast furnace.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.PigIronRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'pig iron'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.PigIronRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.PigIronRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'pig iron'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.PigIronRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.PigIronRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['blast furnace']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.PigIronRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.PigIronRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['blast furnace']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.PigIronRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.PigIronRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['iron ore', 'coal', 'coal']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.PigIronRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.PigIronRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['iron ore', 'coal', 'coal']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.PigIronRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.PigIronRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Pig Iron ingot', 'desc': 'An ingot of crude pig iron.', 'tags': [('pig iron', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.PigIronRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.PigIronRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Pig Iron ingot', 'desc': 'An ingot of crude pig iron.', 'tags': [('pig iron', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.PigIronRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.CrucibleSteelRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.example_recipes.</code><code class="sig-name descname">CrucibleSteelRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#CrucibleSteelRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.CrucibleSteelRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.crafting.crafting.html#evennia.contrib.crafting.crafting.CraftingRecipe" title="evennia.contrib.crafting.crafting.CraftingRecipe"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.crafting.crafting.CraftingRecipe</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.CrucibleSteelRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.example_recipes.</code><code class="sig-name descname">CrucibleSteelRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#CrucibleSteelRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.CrucibleSteelRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe" title="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.crafting.crafting.CraftingRecipe</span></code></a></p>
|
||||
<p>Mixing pig iron with impurities like ash and sand and melting it in a
|
||||
crucible produces a medieval level of steel (like damascus steel).</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.CrucibleSteelRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'crucible steel'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.CrucibleSteelRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.CrucibleSteelRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'crucible steel'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.CrucibleSteelRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.CrucibleSteelRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['crucible']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.CrucibleSteelRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.CrucibleSteelRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['crucible']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.CrucibleSteelRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.CrucibleSteelRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['pig iron', 'ash', 'sand', 'coal', 'coal']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.CrucibleSteelRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.CrucibleSteelRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['pig iron', 'ash', 'sand', 'coal', 'coal']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.CrucibleSteelRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.CrucibleSteelRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Crucible steel ingot', 'desc': 'An ingot of multi-colored crucible steel.', 'tags': [('crucible steel', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.CrucibleSteelRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.CrucibleSteelRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Crucible steel ingot', 'desc': 'An ingot of multi-colored crucible steel.', 'tags': [('crucible steel', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.CrucibleSteelRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordBladeRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.example_recipes.</code><code class="sig-name descname">SwordBladeRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#SwordBladeRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordBladeRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.crafting.example_recipes._SwordSmithingBaseRecipe</span></code></p>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordBladeRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.example_recipes.</code><code class="sig-name descname">SwordBladeRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#SwordBladeRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordBladeRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.crafting.example_recipes._SwordSmithingBaseRecipe</span></code></p>
|
||||
<p>A [sword]blade requires hammering the steel out into shape using heat and
|
||||
force. This also includes the tang, which is the base for the hilt (the
|
||||
part of the sword you hold on to).</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordBladeRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'sword blade'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordBladeRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordBladeRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'sword blade'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordBladeRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordBladeRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['hammer', 'anvil', 'furnace']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordBladeRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordBladeRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['hammer', 'anvil', 'furnace']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordBladeRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordBladeRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['crucible steel']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordBladeRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordBladeRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['crucible steel']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordBladeRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordBladeRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Sword blade', 'desc': 'A long blade that may one day become a sword.', 'tags': [('sword blade', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordBladeRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordBladeRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Sword blade', 'desc': 'A long blade that may one day become a sword.', 'tags': [('sword blade', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordBladeRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordPommelRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.example_recipes.</code><code class="sig-name descname">SwordPommelRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#SwordPommelRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordPommelRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.crafting.example_recipes._SwordSmithingBaseRecipe</span></code></p>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordPommelRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.example_recipes.</code><code class="sig-name descname">SwordPommelRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#SwordPommelRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordPommelRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.crafting.example_recipes._SwordSmithingBaseRecipe</span></code></p>
|
||||
<p>The pommel is the ‘button’ or ‘ball’ etc the end of the sword hilt, holding
|
||||
it together.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordPommelRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'sword pommel'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordPommelRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordPommelRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'sword pommel'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordPommelRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordPommelRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['hammer', 'anvil', 'furnace']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordPommelRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordPommelRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['hammer', 'anvil', 'furnace']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordPommelRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordPommelRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['crucible steel']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordPommelRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordPommelRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['crucible steel']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordPommelRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordPommelRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Sword pommel', 'desc': 'The pommel for a future sword.', 'tags': [('sword pommel', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordPommelRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordPommelRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Sword pommel', 'desc': 'The pommel for a future sword.', 'tags': [('sword pommel', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordPommelRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordGuardRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.example_recipes.</code><code class="sig-name descname">SwordGuardRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#SwordGuardRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordGuardRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.crafting.example_recipes._SwordSmithingBaseRecipe</span></code></p>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordGuardRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.example_recipes.</code><code class="sig-name descname">SwordGuardRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#SwordGuardRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordGuardRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.crafting.example_recipes._SwordSmithingBaseRecipe</span></code></p>
|
||||
<p>The guard stops the hand from accidentally sliding off the hilt onto the
|
||||
sword’s blade and also protects the hand when parrying.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordGuardRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'sword guard'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordGuardRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordGuardRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'sword guard'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordGuardRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordGuardRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['hammer', 'anvil', 'furnace']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordGuardRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordGuardRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['hammer', 'anvil', 'furnace']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordGuardRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordGuardRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['crucible steel']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordGuardRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordGuardRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['crucible steel']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordGuardRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordGuardRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Sword guard', 'desc': 'The cross-guard for a future sword.', 'tags': [('sword guard', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordGuardRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordGuardRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Sword guard', 'desc': 'The cross-guard for a future sword.', 'tags': [('sword guard', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordGuardRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.RawhideRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.example_recipes.</code><code class="sig-name descname">RawhideRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#RawhideRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.RawhideRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.crafting.crafting.html#evennia.contrib.crafting.crafting.CraftingRecipe" title="evennia.contrib.crafting.crafting.CraftingRecipe"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.crafting.crafting.CraftingRecipe</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.RawhideRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.example_recipes.</code><code class="sig-name descname">RawhideRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#RawhideRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.RawhideRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe" title="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.crafting.crafting.CraftingRecipe</span></code></a></p>
|
||||
<p>Rawhide is animal skin cleaned and stripped of hair.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.RawhideRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'rawhide'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.RawhideRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.RawhideRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'rawhide'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.RawhideRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.RawhideRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['knife']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.RawhideRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.RawhideRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['knife']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.RawhideRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.RawhideRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['fur']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.RawhideRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.RawhideRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['fur']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.RawhideRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.RawhideRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Rawhide', 'desc': 'Animal skin, cleaned and with hair removed.', 'tags': [('rawhide', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.RawhideRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.RawhideRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Rawhide', 'desc': 'Animal skin, cleaned and with hair removed.', 'tags': [('rawhide', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.RawhideRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.OakBarkRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.example_recipes.</code><code class="sig-name descname">OakBarkRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#OakBarkRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.OakBarkRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.crafting.crafting.html#evennia.contrib.crafting.crafting.CraftingRecipe" title="evennia.contrib.crafting.crafting.CraftingRecipe"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.crafting.crafting.CraftingRecipe</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.OakBarkRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.example_recipes.</code><code class="sig-name descname">OakBarkRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#OakBarkRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.OakBarkRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe" title="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.crafting.crafting.CraftingRecipe</span></code></a></p>
|
||||
<p>The actual thing needed for tanning leather is Tannin, but we skip
|
||||
the step of refining tannin from the bark and use the bark as-is.</p>
|
||||
<p>This produces two outputs - the bark and the cleaned wood.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.OakBarkRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'oak bark'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.OakBarkRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.OakBarkRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'oak bark'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.OakBarkRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.OakBarkRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['knife']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.OakBarkRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.OakBarkRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['knife']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.OakBarkRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.OakBarkRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['oak wood']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.OakBarkRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.OakBarkRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['oak wood']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.OakBarkRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.OakBarkRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Oak bark', 'desc': 'Bark of oak, stripped from the core wood.', 'tags': [('oak bark', 'crafting_material')]}, {'key': 'Oak Wood (cleaned)', 'desc': 'Oakwood core, stripped of bark.', 'tags': [('cleaned oak wood', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.OakBarkRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.OakBarkRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Oak bark', 'desc': 'Bark of oak, stripped from the core wood.', 'tags': [('oak bark', 'crafting_material')]}, {'key': 'Oak Wood (cleaned)', 'desc': 'Oakwood core, stripped of bark.', 'tags': [('cleaned oak wood', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.OakBarkRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.LeatherRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.example_recipes.</code><code class="sig-name descname">LeatherRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#LeatherRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.LeatherRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.crafting.crafting.html#evennia.contrib.crafting.crafting.CraftingRecipe" title="evennia.contrib.crafting.crafting.CraftingRecipe"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.crafting.crafting.CraftingRecipe</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.LeatherRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.example_recipes.</code><code class="sig-name descname">LeatherRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#LeatherRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.LeatherRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe" title="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.crafting.crafting.CraftingRecipe</span></code></a></p>
|
||||
<p>Leather is produced by tanning rawhide in a process traditionally involving
|
||||
the chemical Tannin. Here we abbreviate this process a bit. Maybe a
|
||||
‘tanning rack’ tool should be required too …</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.LeatherRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'leather'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.LeatherRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.LeatherRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'leather'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.LeatherRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.LeatherRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['cauldron']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.LeatherRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.LeatherRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['cauldron']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.LeatherRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.LeatherRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['rawhide', 'oak bark', 'water']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.LeatherRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.LeatherRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['rawhide', 'oak bark', 'water']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.LeatherRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.LeatherRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Piece of Leather', 'desc': 'A piece of leather.', 'tags': [('leather', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.LeatherRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.LeatherRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Piece of Leather', 'desc': 'A piece of leather.', 'tags': [('leather', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.LeatherRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordHandleRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.example_recipes.</code><code class="sig-name descname">SwordHandleRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#SwordHandleRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordHandleRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.crafting.crafting.html#evennia.contrib.crafting.crafting.CraftingRecipe" title="evennia.contrib.crafting.crafting.CraftingRecipe"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.crafting.crafting.CraftingRecipe</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordHandleRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.example_recipes.</code><code class="sig-name descname">SwordHandleRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#SwordHandleRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordHandleRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#evennia.contrib.game_systems.crafting.crafting.CraftingRecipe" title="evennia.contrib.game_systems.crafting.crafting.CraftingRecipe"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.crafting.crafting.CraftingRecipe</span></code></a></p>
|
||||
<p>The handle is the part of the hilt between the guard and the pommel where
|
||||
you hold the sword. It consists of wooden pieces around the steel tang. It
|
||||
is wrapped in leather, but that will be added at the end.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordHandleRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'sword handle'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordHandleRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordHandleRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'sword handle'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordHandleRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordHandleRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['knife']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordHandleRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordHandleRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['knife']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordHandleRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordHandleRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['cleaned oak wood']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordHandleRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordHandleRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['cleaned oak wood']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordHandleRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordHandleRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Sword handle', 'desc': "Two pieces of wood to be be fitted onto a sword's tang as its handle.", 'tags': [('sword handle', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordHandleRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordHandleRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Sword handle', 'desc': "Two pieces of wood to be be fitted onto a sword's tang as its handle.", 'tags': [('sword handle', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordHandleRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.example_recipes.</code><code class="sig-name descname">SwordRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#SwordRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.crafting.example_recipes._SwordSmithingBaseRecipe</span></code></p>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.example_recipes.</code><code class="sig-name descname">SwordRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#SwordRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.crafting.example_recipes._SwordSmithingBaseRecipe</span></code></p>
|
||||
<p>A finished sword consists of a Blade ending in a non-sharp part called the
|
||||
Tang. The cross Guard is put over the tang against the edge of the blade.
|
||||
The Handle is put over the tang to give something easier to hold. The
|
||||
|
|
@ -378,113 +369,113 @@ Pommel locks everything in place. The handle is wrapped in leather
|
|||
strips for better grip.</p>
|
||||
<p>This covers only a single ‘sword’ type.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'sword'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'sword'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['hammer', 'furnace', 'knife']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordRecipe.tool_tags">
|
||||
<code class="sig-name descname">tool_tags</code><em class="property"> = ['hammer', 'furnace', 'knife']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordRecipe.tool_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['sword blade', 'sword guard', 'sword pommel', 'sword handle', 'leather']</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordRecipe.consumable_tags">
|
||||
<code class="sig-name descname">consumable_tags</code><em class="property"> = ['sword blade', 'sword guard', 'sword pommel', 'sword handle', 'leather']</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordRecipe.consumable_tags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Sword', 'desc': 'A bladed weapon.', 'tags': [('sword', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordRecipe.output_prototypes">
|
||||
<code class="sig-name descname">output_prototypes</code><em class="property"> = [{'key': 'Sword', 'desc': 'A bladed weapon.', 'tags': [('sword', 'crafting_material')]}]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordRecipe.output_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.SwordRecipe.exact_consumable_order">
|
||||
<code class="sig-name descname">exact_consumable_order</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.SwordRecipe.exact_consumable_order" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.SwordRecipe.exact_consumable_order">
|
||||
<code class="sig-name descname">exact_consumable_order</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.SwordRecipe.exact_consumable_order" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.FireballRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.example_recipes.</code><code class="sig-name descname">FireballRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#FireballRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.FireballRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.crafting.example_recipes._MagicRecipe</span></code></p>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.example_recipes.</code><code class="sig-name descname">FireballRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#FireballRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.crafting.example_recipes._MagicRecipe</span></code></p>
|
||||
<p>A Fireball is a magical effect that can be thrown at a target to cause damage.</p>
|
||||
<p>Note that the magic-effects are just examples, an actual rule system would
|
||||
need to be created to understand what they mean when used.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.FireballRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'fireball'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.FireballRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'fireball'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.FireballRecipe.skill_requirements">
|
||||
<code class="sig-name descname">skill_requirements</code><em class="property"> = [('firemagic', 10)]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.FireballRecipe.skill_requirements" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe.skill_requirements">
|
||||
<code class="sig-name descname">skill_requirements</code><em class="property"> = [('firemagic', 10)]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe.skill_requirements" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.FireballRecipe.skill_roll">
|
||||
<code class="sig-name descname">skill_roll</code><em class="property"> = 'firemagic'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.FireballRecipe.skill_roll" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe.skill_roll">
|
||||
<code class="sig-name descname">skill_roll</code><em class="property"> = 'firemagic'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe.skill_roll" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.FireballRecipe.success_message">
|
||||
<code class="sig-name descname">success_message</code><em class="property"> = 'A ball of flame appears!'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.FireballRecipe.success_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe.success_message">
|
||||
<code class="sig-name descname">success_message</code><em class="property"> = 'A ball of flame appears!'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe.success_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.FireballRecipe.desired_effects">
|
||||
<code class="sig-name descname">desired_effects</code><em class="property"> = [('target_fire_damage', 25), ('ranged_attack', -2), ('mana_cost', 12)]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.FireballRecipe.desired_effects" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe.desired_effects">
|
||||
<code class="sig-name descname">desired_effects</code><em class="property"> = [('target_fire_damage', 25), ('ranged_attack', -2), ('mana_cost', 12)]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe.desired_effects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.FireballRecipe.failure_effects">
|
||||
<code class="sig-name descname">failure_effects</code><em class="property"> = [('self_fire_damage', 5), ('mana_cost', 5)]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.FireballRecipe.failure_effects" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe.failure_effects">
|
||||
<code class="sig-name descname">failure_effects</code><em class="property"> = [('self_fire_damage', 5), ('mana_cost', 5)]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe.failure_effects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.HealingRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.example_recipes.</code><code class="sig-name descname">HealingRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#HealingRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.HealingRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.crafting.example_recipes._MagicRecipe</span></code></p>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.example_recipes.</code><code class="sig-name descname">HealingRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">crafter</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">inputs</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#HealingRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.crafting.example_recipes._MagicRecipe</span></code></p>
|
||||
<p>Healing magic will restore a certain amount of health to the target over time.</p>
|
||||
<p>Note that the magic-effects are just examples, an actual rule system would
|
||||
need to be created to understand what they mean.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.HealingRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'heal'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.HealingRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'heal'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.HealingRecipe.skill_requirements">
|
||||
<code class="sig-name descname">skill_requirements</code><em class="property"> = [('bodymagic', 5), ('empathy', 10)]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.HealingRecipe.skill_requirements" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe.skill_requirements">
|
||||
<code class="sig-name descname">skill_requirements</code><em class="property"> = [('bodymagic', 5), ('empathy', 10)]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe.skill_requirements" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.HealingRecipe.skill_roll">
|
||||
<code class="sig-name descname">skill_roll</code><em class="property"> = 'bodymagic'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.HealingRecipe.skill_roll" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe.skill_roll">
|
||||
<code class="sig-name descname">skill_roll</code><em class="property"> = 'bodymagic'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe.skill_roll" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.HealingRecipe.success_message">
|
||||
<code class="sig-name descname">success_message</code><em class="property"> = 'You successfully extend your healing aura.'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.HealingRecipe.success_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe.success_message">
|
||||
<code class="sig-name descname">success_message</code><em class="property"> = 'You successfully extend your healing aura.'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe.success_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.HealingRecipe.desired_effects">
|
||||
<code class="sig-name descname">desired_effects</code><em class="property"> = [('healing', 15), ('mana_cost', 5)]</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.HealingRecipe.desired_effects" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe.desired_effects">
|
||||
<code class="sig-name descname">desired_effects</code><em class="property"> = [('healing', 15), ('mana_cost', 5)]</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe.desired_effects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.HealingRecipe.failure_effects">
|
||||
<code class="sig-name descname">failure_effects</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.HealingRecipe.failure_effects" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe.failure_effects">
|
||||
<code class="sig-name descname">failure_effects</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe.failure_effects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.CmdCast">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.crafting.example_recipes.</code><code class="sig-name descname">CmdCast</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#CmdCast"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.CmdCast" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.CmdCast">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.example_recipes.</code><code class="sig-name descname">CmdCast</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#CmdCast"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.CmdCast" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Cast a magical spell.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -492,20 +483,20 @@ need to be created to understand what they mean.</p>
|
|||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.CmdCast.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'cast'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.CmdCast.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.CmdCast.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'cast'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.CmdCast.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.CmdCast.parse">
|
||||
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#CmdCast.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.CmdCast.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.CmdCast.parse">
|
||||
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#CmdCast.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.CmdCast.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Simple parser, assuming spellname doesn’t have spaces.
|
||||
Stores result in self.target and self.spellname.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.CmdCast.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/crafting/example_recipes.html#CmdCast.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.CmdCast.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.CmdCast.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/example_recipes.html#CmdCast.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.CmdCast.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is the actual executing part of the command. It is
|
||||
called directly after self.parse(). See the docstring of this
|
||||
module for which object properties are available (beyond those
|
||||
|
|
@ -513,23 +504,23 @@ set in self.parse())</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.CmdCast.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.CmdCast.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.CmdCast.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.CmdCast.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.CmdCast.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.CmdCast.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.CmdCast.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.CmdCast.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.CmdCast.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.CmdCast.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.CmdCast.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.CmdCast.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.crafting.example_recipes.CmdCast.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'cast', 'no_prefix': ' ', 'tags': '', 'text': '\n Cast a magical spell.\n\n Usage:\n cast <spell> <target>\n\n '}</em><a class="headerlink" href="#evennia.contrib.crafting.example_recipes.CmdCast.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.crafting.example_recipes.CmdCast.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'cast', 'no_prefix': ' ', 'tags': '', 'text': '\n Cast a magical spell.\n\n Usage:\n cast <spell> <target>\n\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.example_recipes.CmdCast.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -559,23 +550,17 @@ set in self.parse())</p>
|
|||
<script>$('#searchbox').show(0);</script>
|
||||
<p><h3><a href="../index.html">Table of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">evennia.contrib.crafting.example_recipes</a><ul>
|
||||
<li><a class="reference internal" href="#">evennia.contrib.game_systems.crafting.example_recipes</a><ul>
|
||||
<li><a class="reference internal" href="#sword-crafting-tree">Sword crafting tree</a></li>
|
||||
<li><a class="reference internal" href="#recipes-used-for-spell-casting">Recipes used for spell casting</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.crafting.crafting.html"
|
||||
title="previous chapter">evennia.contrib.crafting.crafting</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="../Contribs/A-voice-operated-elevator-using-events.html"
|
||||
title="next chapter">A voice operated elevator using events</a></p>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.crafting.example_recipes.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.crafting.example_recipes.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -591,7 +576,7 @@ set in self.parse())</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.crafting.example_recipes.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="evennia.contrib.game_systems.crafting.example_recipes.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -608,15 +593,8 @@ set in self.parse())</p>
|
|||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../Contribs/A-voice-operated-elevator-using-events.html" title="A voice operated elevator using events"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.crafting.crafting.html" title="evennia.contrib.crafting.crafting"
|
||||
>previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../Contribs/Contrib-Overview.html" >Contrib modules</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.crafting.example_recipes</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.crafting.example_recipes</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
131
docs/1.0-dev/api/evennia.contrib.game_systems.crafting.html
Normal file
131
docs/1.0-dev/api/evennia.contrib.game_systems.crafting.html
Normal file
|
|
@ -0,0 +1,131 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.crafting — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.crafting</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.crafting">
|
||||
<span id="evennia-contrib-game-systems-crafting"></span><h1>evennia.contrib.game_systems.crafting<a class="headerlink" href="#module-evennia.contrib.game_systems.crafting" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Crafting - Griatch 2020</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html">evennia.contrib.game_systems.crafting.crafting</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#installation">Installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#crafting-in-game">Crafting in game</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#crafting-in-code">Crafting in code</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#recipes">Recipes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.crafting.example_recipes.html">evennia.contrib.game_systems.crafting.example_recipes</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.crafting.example_recipes.html#sword-crafting-tree">Sword crafting tree</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.crafting.example_recipes.html#recipes-used-for-spell-casting">Recipes used for spell casting</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.crafting.tests.html">evennia.contrib.game_systems.crafting.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.crafting.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.crafting.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.crafting</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,326 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.crafting.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.crafting.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.crafting.tests">
|
||||
<span id="evennia-contrib-game-systems-crafting-tests"></span><h1>evennia.contrib.game_systems.crafting.tests<a class="headerlink" href="#module-evennia.contrib.game_systems.crafting.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Unit tests for the crafting system contrib.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftUtils">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.tests.</code><code class="sig-name descname">TestCraftUtils</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftUtils"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftUtils" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTestCase" title="evennia.utils.test_resources.BaseEvenniaTestCase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTestCase</span></code></a></p>
|
||||
<p>Test helper utils for crafting.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftUtils.maxDiff">
|
||||
<code class="sig-name descname">maxDiff</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftUtils.maxDiff" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftUtils.test_load_recipes">
|
||||
<code class="sig-name descname">test_load_recipes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftUtils.test_load_recipes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftUtils.test_load_recipes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This should only load the example module now</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.tests.</code><code class="sig-name descname">TestCraftingRecipeBase</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipeBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTestCase" title="evennia.utils.test_resources.BaseEvenniaTestCase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTestCase</span></code></a></p>
|
||||
<p>Test the parent recipe class.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipeBase.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase.test_msg">
|
||||
<code class="sig-name descname">test_msg</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipeBase.test_msg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase.test_msg" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test messaging to crafter</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase.test_pre_craft">
|
||||
<code class="sig-name descname">test_pre_craft</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipeBase.test_pre_craft"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase.test_pre_craft" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test validating hook</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase.test_pre_craft_fail">
|
||||
<code class="sig-name descname">test_pre_craft_fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipeBase.test_pre_craft_fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase.test_pre_craft_fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Should rase error if validation fails</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase.test_craft_hook__succeed">
|
||||
<code class="sig-name descname">test_craft_hook__succeed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipeBase.test_craft_hook__succeed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase.test_craft_hook__succeed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test craft hook, the main access method.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase.test_craft_hook__fail">
|
||||
<code class="sig-name descname">test_craft_hook__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipeBase.test_craft_hook__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipeBase.test_craft_hook__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test failing the call</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.tests.</code><code class="sig-name descname">TestCraftingRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTestCase" title="evennia.utils.test_resources.BaseEvenniaTestCase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTestCase</span></code></a></p>
|
||||
<p>Test the CraftingRecipe class with one recipe</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.maxDiff">
|
||||
<code class="sig-name descname">maxDiff</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.maxDiff" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_error_format">
|
||||
<code class="sig-name descname">test_error_format</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.test_error_format"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_error_format" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test the automatic error formatter</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft__success">
|
||||
<code class="sig-name descname">test_craft__success</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.test_craft__success"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft__success" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test to create a result from the recipe</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_seed__success">
|
||||
<code class="sig-name descname">test_seed__success</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.test_seed__success"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_seed__success" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test seed helper classmethod</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_missing_tool__fail">
|
||||
<code class="sig-name descname">test_craft_missing_tool__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.test_craft_missing_tool__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_missing_tool__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail craft by missing tool2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_missing_cons__fail">
|
||||
<code class="sig-name descname">test_craft_missing_cons__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.test_craft_missing_cons__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_missing_cons__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail craft by missing cons3</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_missing_cons__always_consume__fail">
|
||||
<code class="sig-name descname">test_craft_missing_cons__always_consume__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.test_craft_missing_cons__always_consume__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_missing_cons__always_consume__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail craft by missing cons3, with always-consume flag</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_wrong_tool__fail">
|
||||
<code class="sig-name descname">test_craft_wrong_tool__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.test_craft_wrong_tool__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_wrong_tool__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail craft by including a wrong tool</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_tool_excess__fail">
|
||||
<code class="sig-name descname">test_craft_tool_excess__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.test_craft_tool_excess__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_tool_excess__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail by too many consumables</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_cons_excess__fail">
|
||||
<code class="sig-name descname">test_craft_cons_excess__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.test_craft_cons_excess__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_cons_excess__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fail by too many consumables</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_tool_excess__sucess">
|
||||
<code class="sig-name descname">test_craft_tool_excess__sucess</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.test_craft_tool_excess__sucess"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_tool_excess__sucess" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Allow too many consumables</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_cons_excess__sucess">
|
||||
<code class="sig-name descname">test_craft_cons_excess__sucess</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.test_craft_cons_excess__sucess"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_cons_excess__sucess" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Allow too many consumables</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_tool_order__fail">
|
||||
<code class="sig-name descname">test_craft_tool_order__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.test_craft_tool_order__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_tool_order__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Strict tool-order recipe fail</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_cons_order__fail">
|
||||
<code class="sig-name descname">test_craft_cons_order__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftingRecipe.test_craft_cons_order__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftingRecipe.test_craft_cons_order__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Strict tool-order recipe fail</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftSword">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.tests.</code><code class="sig-name descname">TestCraftSword</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftSword"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftSword" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTestCase" title="evennia.utils.test_resources.BaseEvenniaTestCase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTestCase</span></code></a></p>
|
||||
<p>Test the <strong>craft</strong> function by crafting the example sword.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftSword.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftSword.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftSword.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftSword.test_craft_sword">
|
||||
<code class="sig-name descname">test_craft_sword</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mockrandom</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftSword.test_craft_sword"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftSword.test_craft_sword" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Craft example sword. For the test, every crafting works.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftCommand">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.crafting.tests.</code><code class="sig-name descname">TestCraftCommand</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftCommand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftCommand" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<p>Test the crafting command</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftCommand.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftCommand.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftCommand.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftCommand.test_craft__success">
|
||||
<code class="sig-name descname">test_craft__success</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftCommand.test_craft__success"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftCommand.test_craft__success" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Successfully craft using command</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftCommand.test_craft__notools__failure">
|
||||
<code class="sig-name descname">test_craft__notools__failure</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftCommand.test_craft__notools__failure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftCommand.test_craft__notools__failure" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Craft fail no tools</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.crafting.tests.TestCraftCommand.test_craft__nocons__failure">
|
||||
<code class="sig-name descname">test_craft__nocons__failure</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/crafting/tests.html#TestCraftCommand.test_craft__nocons__failure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.crafting.tests.TestCraftCommand.test_craft__nocons__failure" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.crafting.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.crafting.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.crafting.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.gendersub — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.game_systems.gendersub.gendersub — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.gendersub</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.gendersub.gendersub</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.gendersub">
|
||||
<span id="evennia-contrib-gendersub"></span><h1>evennia.contrib.gendersub<a class="headerlink" href="#module-evennia.contrib.gendersub" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.game_systems.gendersub.gendersub">
|
||||
<span id="evennia-contrib-game-systems-gendersub-gendersub"></span><h1>evennia.contrib.game_systems.gendersub.gendersub<a class="headerlink" href="#module-evennia.contrib.game_systems.gendersub.gendersub" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Gendersub</p>
|
||||
<p>Griatch 2015</p>
|
||||
<p>This is a simple gender-aware Character class for allowing users to
|
||||
|
|
@ -57,6 +57,7 @@ inspiration and starting point to how to do stuff like this.</p>
|
|||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Usage</p>
|
||||
<p>When in use, messages can contain special tags to indicate pronouns gendered
|
||||
based on the one being addressed. Capitalization will be retained.</p>
|
||||
<ul class="simple">
|
||||
|
|
@ -71,11 +72,11 @@ based on the one being addressed. Capitalization will be retained.</p>
|
|||
<p>The default gender is “ambiguous” (they/them/their/theirs).</p>
|
||||
<p>To use, have DefaultCharacter inherit from this, or change
|
||||
setting.DEFAULT_CHARACTER to point to this class.</p>
|
||||
<p>The <strong>@gender</strong> command is used to set the gender. It needs to be added to the
|
||||
<p>The <strong>gender</strong> command is used to set the gender. It needs to be added to the
|
||||
default cmdset before it becomes available.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.gendersub.SetGender">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.gendersub.</code><code class="sig-name descname">SetGender</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/gendersub.html#SetGender"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.gendersub.SetGender" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.SetGender">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.gendersub.gendersub.</code><code class="sig-name descname">SetGender</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/gendersub/gendersub.html#SetGender"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.SetGender" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Sets gender on yourself</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -83,57 +84,57 @@ default cmdset before it becomes available.</p>
|
|||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.gendersub.SetGender.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@gender'</em><a class="headerlink" href="#evennia.contrib.gendersub.SetGender.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.SetGender.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'gender'</em><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.SetGender.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.gendersub.SetGender.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@sex']</em><a class="headerlink" href="#evennia.contrib.gendersub.SetGender.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.SetGender.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['sex']</em><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.SetGender.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.gendersub.SetGender.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all();call:all()'</em><a class="headerlink" href="#evennia.contrib.gendersub.SetGender.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.SetGender.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all();call:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.SetGender.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.gendersub.SetGender.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/gendersub.html#SetGender.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.gendersub.SetGender.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.SetGender.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/gendersub/gendersub.html#SetGender.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.SetGender.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Implements the command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.gendersub.SetGender.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.gendersub.SetGender.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.SetGender.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.SetGender.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.gendersub.SetGender.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();call:all()'</em><a class="headerlink" href="#evennia.contrib.gendersub.SetGender.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.SetGender.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();call:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.SetGender.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.gendersub.SetGender.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@sex', 'category': 'general', 'key': '@gender', 'no_prefix': 'gender sex', 'tags': '', 'text': '\n Sets gender on yourself\n\n Usage:\n @gender male||female||neutral||ambiguous\n\n '}</em><a class="headerlink" href="#evennia.contrib.gendersub.SetGender.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.SetGender.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'sex', 'category': 'general', 'key': 'gender', 'no_prefix': ' sex', 'tags': '', 'text': '\n Sets gender on yourself\n\n Usage:\n @gender male||female||neutral||ambiguous\n\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.SetGender.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.gendersub.GenderCharacter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.gendersub.</code><code class="sig-name descname">GenderCharacter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/gendersub.html#GenderCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.gendersub.GenderCharacter" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.gendersub.gendersub.</code><code class="sig-name descname">GenderCharacter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/gendersub/gendersub.html#GenderCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter" title="evennia.objects.objects.DefaultCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter</span></code></a></p>
|
||||
<p>This is a Character class aware of gender.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.gendersub.GenderCharacter.at_object_creation">
|
||||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/gendersub.html#GenderCharacter.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.gendersub.GenderCharacter.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter.at_object_creation">
|
||||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/gendersub/gendersub.html#GenderCharacter.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called once when the object is created.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.gendersub.GenderCharacter.msg">
|
||||
<code class="sig-name descname">msg</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">text</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">from_obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">session</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/gendersub.html#GenderCharacter.msg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.gendersub.GenderCharacter.msg" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter.msg">
|
||||
<code class="sig-name descname">msg</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">text</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">from_obj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">session</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/gendersub/gendersub.html#GenderCharacter.msg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter.msg" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Emits something to a session attached to the object.
|
||||
Overloads the default msg() implementation to include
|
||||
gender-aware markers in output.</p>
|
||||
|
|
@ -158,25 +159,25 @@ All extra kwargs will be passed on to the protocol.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.gendersub.GenderCharacter.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.gendersub.GenderCharacter.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.DoesNotExist" title="evennia.objects.objects.DefaultCharacter.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.gendersub.GenderCharacter.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.gendersub.GenderCharacter.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned" title="evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.gendersub.GenderCharacter.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.gendersub.GenderCharacter'</em><a class="headerlink" href="#evennia.contrib.gendersub.GenderCharacter.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter'</em><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.gendersub.GenderCharacter.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'GenderCharacter'</em><a class="headerlink" href="#evennia.contrib.gendersub.GenderCharacter.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'GenderCharacter'</em><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.gendersub.GenderCharacter.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -206,7 +207,7 @@ All extra kwargs will be passed on to the protocol.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.gendersub.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.gendersub.gendersub.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -222,8 +223,8 @@ All extra kwargs will be passed on to the protocol.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.gendersub.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.gendersub.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.game_systems.gendersub.gendersub.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -240,7 +241,7 @@ All extra kwargs will be passed on to the protocol.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.gendersub</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.gendersub.gendersub</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
120
docs/1.0-dev/api/evennia.contrib.game_systems.gendersub.html
Normal file
120
docs/1.0-dev/api/evennia.contrib.game_systems.gendersub.html
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.gendersub — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.gendersub</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.gendersub">
|
||||
<span id="evennia-contrib-game-systems-gendersub"></span><h1>evennia.contrib.game_systems.gendersub<a class="headerlink" href="#module-evennia.contrib.game_systems.gendersub" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Gendersub - Griatch 2015</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.gendersub.gendersub.html">evennia.contrib.game_systems.gendersub.gendersub</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.gendersub.tests.html">evennia.contrib.game_systems.gendersub.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.gendersub.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.gendersub.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.gendersub</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,130 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.gendersub.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.gendersub.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.gendersub.tests">
|
||||
<span id="evennia-contrib-game-systems-gendersub-tests"></span><h1>evennia.contrib.game_systems.gendersub.tests<a class="headerlink" href="#module-evennia.contrib.game_systems.gendersub.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Test gendersub contrib.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.gendersub.tests.TestGenderSub">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.gendersub.tests.</code><code class="sig-name descname">TestGenderSub</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/gendersub/tests.html#TestGenderSub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.tests.TestGenderSub" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.gendersub.tests.TestGenderSub.test_setgender">
|
||||
<code class="sig-name descname">test_setgender</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/gendersub/tests.html#TestGenderSub.test_setgender"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.tests.TestGenderSub.test_setgender" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.gendersub.tests.TestGenderSub.test_gendercharacter">
|
||||
<code class="sig-name descname">test_gendercharacter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/gendersub/tests.html#TestGenderSub.test_gendercharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.gendersub.tests.TestGenderSub.test_gendercharacter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.gendersub.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.gendersub.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.gendersub.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
177
docs/1.0-dev/api/evennia.contrib.game_systems.html
Normal file
177
docs/1.0-dev/api/evennia.contrib.game_systems.html
Normal file
|
|
@ -0,0 +1,177 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems">
|
||||
<span id="evennia-contrib-game-systems"></span><h1>evennia.contrib.game_systems<a class="headerlink" href="#module-evennia.contrib.game_systems" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.barter.html">evennia.contrib.game_systems.barter</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.barter.barter.html">evennia.contrib.game_systems.barter.barter</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.barter.tests.html">evennia.contrib.game_systems.barter.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.clothing.html">evennia.contrib.game_systems.clothing</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.clothing.clothing.html">evennia.contrib.game_systems.clothing.clothing</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.clothing.tests.html">evennia.contrib.game_systems.clothing.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.cooldowns.html">evennia.contrib.game_systems.cooldowns</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.cooldowns.cooldowns.html">evennia.contrib.game_systems.cooldowns.cooldowns</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.cooldowns.tests.html">evennia.contrib.game_systems.cooldowns.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.crafting.html">evennia.contrib.game_systems.crafting</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html">evennia.contrib.game_systems.crafting.crafting</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#installation">Installation</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#crafting-in-game">Crafting in game</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#crafting-in-code">Crafting in code</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.crafting.crafting.html#recipes">Recipes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.crafting.example_recipes.html">evennia.contrib.game_systems.crafting.example_recipes</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.crafting.example_recipes.html#sword-crafting-tree">Sword crafting tree</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.crafting.example_recipes.html#recipes-used-for-spell-casting">Recipes used for spell casting</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.crafting.tests.html">evennia.contrib.game_systems.crafting.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.gendersub.html">evennia.contrib.game_systems.gendersub</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.gendersub.gendersub.html">evennia.contrib.game_systems.gendersub.gendersub</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.gendersub.tests.html">evennia.contrib.game_systems.gendersub.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.mail.html">evennia.contrib.game_systems.mail</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.mail.mail.html">evennia.contrib.game_systems.mail.mail</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.mail.tests.html">evennia.contrib.game_systems.mail.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.multidescer.html">evennia.contrib.game_systems.multidescer</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.multidescer.multidescer.html">evennia.contrib.game_systems.multidescer.multidescer</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.multidescer.tests.html">evennia.contrib.game_systems.multidescer.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.puzzles.html">evennia.contrib.game_systems.puzzles</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.puzzles.puzzles.html">evennia.contrib.game_systems.puzzles.puzzles</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.puzzles.tests.html">evennia.contrib.game_systems.puzzles.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.html">evennia.contrib.game_systems.turnbattle</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_basic.html">evennia.contrib.game_systems.turnbattle.tb_basic</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_equip.html">evennia.contrib.game_systems.turnbattle.tb_equip</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_items.html">evennia.contrib.game_systems.turnbattle.tb_items</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_magic.html">evennia.contrib.game_systems.turnbattle.tb_magic</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_range.html">evennia.contrib.game_systems.turnbattle.tb_range</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tests.html">evennia.contrib.game_systems.turnbattle.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.awsstorage — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.game_systems.mail — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.awsstorage</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.mail</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,13 +40,13 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.awsstorage">
|
||||
<span id="evennia-contrib-awsstorage"></span><h1>evennia.contrib.awsstorage<a class="headerlink" href="#module-evennia.contrib.awsstorage" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Intended to be a collecting folder for Django-specific contribs that do not have observable effects to players.</p>
|
||||
<section id="module-evennia.contrib.game_systems.mail">
|
||||
<span id="evennia-contrib-game-systems-mail"></span><h1>evennia.contrib.game_systems.mail<a class="headerlink" href="#module-evennia.contrib.game_systems.mail" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Mail system - grungies 2016</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.awsstorage.aws_s3_cdn.html">evennia.contrib.awsstorage.aws_s3_cdn</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.awsstorage.tests.html">evennia.contrib.awsstorage.tests</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.mail.mail.html">evennia.contrib.game_systems.mail.mail</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.mail.tests.html">evennia.contrib.game_systems.mail.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -74,7 +74,7 @@
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.awsstorage.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.mail.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.awsstorage.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="evennia.contrib.game_systems.mail.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -108,7 +108,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.awsstorage</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.mail</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.mail — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.game_systems.mail.mail — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.mail</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.mail.mail</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,21 +40,21 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.mail">
|
||||
<span id="evennia-contrib-mail"></span><h1>evennia.contrib.mail<a class="headerlink" href="#module-evennia.contrib.mail" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.game_systems.mail.mail">
|
||||
<span id="evennia-contrib-game-systems-mail-mail"></span><h1>evennia.contrib.game_systems.mail.mail<a class="headerlink" href="#module-evennia.contrib.game_systems.mail.mail" title="Permalink to this headline">¶</a></h1>
|
||||
<p>In-Game Mail system</p>
|
||||
<p>Evennia Contribution - grungies1138 2016</p>
|
||||
<p>A simple Brandymail style @mail system that uses the Msg class from Evennia
|
||||
Core. It has two Commands, both of which can be used on their own:</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><p>CmdMail - this should sit on the Account cmdset and makes the @mail command</p></li>
|
||||
<li><p>CmdMail - this should sit on the Account cmdset and makes the <strong>mail</strong> command</p></li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<div><p>available both IC and OOC. Mails will always go to Accounts (other players).</p>
|
||||
</div></blockquote>
|
||||
<ul class="simple">
|
||||
<li><p>CmdMailCharacter - this should sit on the Character cmdset and makes the @mail</p></li>
|
||||
<li><p>CmdMailCharacter - this should sit on the Character cmdset and makes the <strong>mail</strong></p></li>
|
||||
</ul>
|
||||
<blockquote>
|
||||
<div><p>command ONLY available when puppeting a character. Mails will be sent to other
|
||||
|
|
@ -73,7 +73,7 @@ Characters only and will not be available when OOC.</p>
|
|||
<li><p>CmdMail (IC + OOC mail, sent between players)</p>
|
||||
<blockquote>
|
||||
<div><p># mygame/commands/default_cmds.py</p>
|
||||
<p>from evennia.contrib import mail</p>
|
||||
<p>from evennia.contrib.game_systems import mail</p>
|
||||
<dl class="simple">
|
||||
<dt># in AccountCmdSet.at_cmdset_creation:</dt><dd><p>self.add(mail.CmdMail())</p>
|
||||
</dd>
|
||||
|
|
@ -83,7 +83,7 @@ Characters only and will not be available when OOC.</p>
|
|||
<li><p>CmdMailCharacter (optional, IC only mail, sent between characters)</p>
|
||||
<blockquote>
|
||||
<div><p># mygame/commands/default_cmds.py</p>
|
||||
<p>from evennia.contrib import mail</p>
|
||||
<p>from evennia.contrib.game_systems import mail</p>
|
||||
<dl class="simple">
|
||||
<dt># in CharacterCmdSet.at_cmdset_creation:</dt><dd><p>self.add(mail.CmdMailCharacter())</p>
|
||||
</dd>
|
||||
|
|
@ -92,10 +92,10 @@ Characters only and will not be available when OOC.</p>
|
|||
</li>
|
||||
</ul>
|
||||
<p>Once installed, use <strong>help mail</strong> in game for help with the mail command. Use
|
||||
@ic/@ooc to switch in and out of IC/OOC modes.</p>
|
||||
ic/ooc to switch in and out of IC/OOC modes.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.mail.CmdMail">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.mail.</code><code class="sig-name descname">CmdMail</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/mail.html#CmdMail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.mail.CmdMail" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMail">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.mail.mail.</code><code class="sig-name descname">CmdMail</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/mail/mail.html#CmdMail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxAccountCommand" title="evennia.commands.default.muxcommand.MuxAccountCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxAccountCommand</span></code></a></p>
|
||||
<p>Communicate with others by sending mail.</p>
|
||||
<dl>
|
||||
|
|
@ -135,35 +135,35 @@ reply - Replies to a received message, appending the original message to the b
|
|||
@mail/forward feend78 Griatch=4/You guys should read this.
|
||||
@mail/reply 9=Thanks for the info!</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.mail.CmdMail.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@mail'</em><a class="headerlink" href="#evennia.contrib.mail.CmdMail.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMail.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@mail'</em><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMail.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.mail.CmdMail.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['mail']</em><a class="headerlink" href="#evennia.contrib.mail.CmdMail.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMail.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['mail']</em><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMail.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.mail.CmdMail.lock">
|
||||
<code class="sig-name descname">lock</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.mail.CmdMail.lock" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMail.lock">
|
||||
<code class="sig-name descname">lock</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMail.lock" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.mail.CmdMail.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.mail.CmdMail.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMail.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMail.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.mail.CmdMail.parse">
|
||||
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/mail.html#CmdMail.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.mail.CmdMail.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMail.parse">
|
||||
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/mail/mail.html#CmdMail.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMail.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add convenience check to know if caller is an Account or not since this cmd
|
||||
will be able to add to either Object- or Account level.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.mail.CmdMail.search_targets">
|
||||
<code class="sig-name descname">search_targets</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">namelist</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/mail.html#CmdMail.search_targets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.mail.CmdMail.search_targets" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMail.search_targets">
|
||||
<code class="sig-name descname">search_targets</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">namelist</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/mail/mail.html#CmdMail.search_targets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMail.search_targets" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Search a list of targets of the same type as caller.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -179,8 +179,8 @@ will be able to add to either Object- or Account level.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.mail.CmdMail.get_all_mail">
|
||||
<code class="sig-name descname">get_all_mail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/mail.html#CmdMail.get_all_mail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.mail.CmdMail.get_all_mail" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMail.get_all_mail">
|
||||
<code class="sig-name descname">get_all_mail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/mail/mail.html#CmdMail.get_all_mail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMail.get_all_mail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="simple">
|
||||
<dt>Returns a list of all the messages where the caller is a recipient. These</dt><dd><p>are all messages tagged with tags of the <strong>mail</strong> category.</p>
|
||||
</dd>
|
||||
|
|
@ -193,8 +193,8 @@ will be able to add to either Object- or Account level.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.mail.CmdMail.send_mail">
|
||||
<code class="sig-name descname">send_mail</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">recipients</span></em>, <em class="sig-param"><span class="n">subject</span></em>, <em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="n">caller</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/mail.html#CmdMail.send_mail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.mail.CmdMail.send_mail" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMail.send_mail">
|
||||
<code class="sig-name descname">send_mail</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">recipients</span></em>, <em class="sig-param"><span class="n">subject</span></em>, <em class="sig-param"><span class="n">message</span></em>, <em class="sig-param"><span class="n">caller</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/mail/mail.html#CmdMail.send_mail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMail.send_mail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Function for sending new mail. Also useful for sending notifications
|
||||
from objects or systems.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -211,27 +211,27 @@ the newly created mails.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.mail.CmdMail.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/mail.html#CmdMail.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.mail.CmdMail.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMail.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/mail/mail.html#CmdMail.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMail.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do the main command functionality</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.mail.CmdMail.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.mail.CmdMail.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMail.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMail.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.mail.CmdMail.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'mail', 'category': 'general', 'key': '@mail', 'no_prefix': 'mail mail', 'tags': '', 'text': '\n Communicate with others by sending mail.\n\n Usage:\n @mail - Displays all the mail an account has in their mailbox\n @mail <#> - Displays a specific message\n @mail <accounts>=<subject>/<message>\n - Sends a message to the comma separated list of accounts.\n @mail/delete <#> - Deletes a specific message\n @mail/forward <account list>=<#>[/<Message>]\n - Forwards an existing message to the specified list of accounts,\n original message is delivered with optional Message prepended.\n @mail/reply <#>=<message>\n - Replies to a message #. Prepends message to the original\n message text.\n Switches:\n delete - deletes a message\n forward - forward a received message to another object with an optional message attached.\n reply - Replies to a received message, appending the original message to the bottom.\n Examples:\n @mail 2\n @mail Griatch=New mail/Hey man, I am sending you a message!\n @mail/delete 6\n @mail/forward feend78 Griatch=4/You guys should read this.\n @mail/reply 9=Thanks for the info!\n\n '}</em><a class="headerlink" href="#evennia.contrib.mail.CmdMail.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMail.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'mail', 'category': 'general', 'key': '@mail', 'no_prefix': 'mail mail', 'tags': '', 'text': '\n Communicate with others by sending mail.\n\n Usage:\n @mail - Displays all the mail an account has in their mailbox\n @mail <#> - Displays a specific message\n @mail <accounts>=<subject>/<message>\n - Sends a message to the comma separated list of accounts.\n @mail/delete <#> - Deletes a specific message\n @mail/forward <account list>=<#>[/<Message>]\n - Forwards an existing message to the specified list of accounts,\n original message is delivered with optional Message prepended.\n @mail/reply <#>=<message>\n - Replies to a message #. Prepends message to the original\n message text.\n Switches:\n delete - deletes a message\n forward - forward a received message to another object with an optional message attached.\n reply - Replies to a received message, appending the original message to the bottom.\n Examples:\n @mail 2\n @mail Griatch=New mail/Hey man, I am sending you a message!\n @mail/delete 6\n @mail/forward feend78 Griatch=4/You guys should read this.\n @mail/reply 9=Thanks for the info!\n\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMail.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.mail.CmdMailCharacter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.mail.</code><code class="sig-name descname">CmdMailCharacter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/mail.html#CmdMailCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.mail.CmdMailCharacter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.mail.CmdMail" title="evennia.contrib.mail.CmdMail"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.mail.CmdMail</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMailCharacter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.mail.mail.</code><code class="sig-name descname">CmdMailCharacter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/mail/mail.html#CmdMailCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMailCharacter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.game_systems.mail.mail.CmdMail" title="evennia.contrib.game_systems.mail.mail.CmdMail"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.mail.mail.CmdMail</span></code></a></p>
|
||||
<p>Communicate with others by sending mail.</p>
|
||||
<dl>
|
||||
<dt>Usage:</dt><dd><p>@mail - Displays all the mail an account has in their mailbox
|
||||
|
|
@ -270,33 +270,33 @@ reply - Replies to a received message, appending the original message to the b
|
|||
@mail/forward feend78 Griatch=4/You guys should read this.
|
||||
@mail/reply 9=Thanks for the info!</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.mail.CmdMailCharacter.account_caller">
|
||||
<code class="sig-name descname">account_caller</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.mail.CmdMailCharacter.account_caller" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMailCharacter.account_caller">
|
||||
<code class="sig-name descname">account_caller</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMailCharacter.account_caller" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.mail.CmdMailCharacter.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['mail']</em><a class="headerlink" href="#evennia.contrib.mail.CmdMailCharacter.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMailCharacter.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['mail']</em><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMailCharacter.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.mail.CmdMailCharacter.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.mail.CmdMailCharacter.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMailCharacter.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMailCharacter.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.mail.CmdMailCharacter.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@mail'</em><a class="headerlink" href="#evennia.contrib.mail.CmdMailCharacter.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMailCharacter.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@mail'</em><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMailCharacter.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.mail.CmdMailCharacter.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.mail.CmdMailCharacter.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMailCharacter.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMailCharacter.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.mail.CmdMailCharacter.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'mail', 'category': 'general', 'key': '@mail', 'no_prefix': 'mail mail', 'tags': '', 'text': '\n Communicate with others by sending mail.\n\n Usage:\n @mail - Displays all the mail an account has in their mailbox\n @mail <#> - Displays a specific message\n @mail <accounts>=<subject>/<message>\n - Sends a message to the comma separated list of accounts.\n @mail/delete <#> - Deletes a specific message\n @mail/forward <account list>=<#>[/<Message>]\n - Forwards an existing message to the specified list of accounts,\n original message is delivered with optional Message prepended.\n @mail/reply <#>=<message>\n - Replies to a message #. Prepends message to the original\n message text.\n Switches:\n delete - deletes a message\n forward - forward a received message to another object with an optional message attached.\n reply - Replies to a received message, appending the original message to the bottom.\n Examples:\n @mail 2\n @mail Griatch=New mail/Hey man, I am sending you a message!\n @mail/delete 6\n @mail/forward feend78 Griatch=4/You guys should read this.\n @mail/reply 9=Thanks for the info!\n\n '}</em><a class="headerlink" href="#evennia.contrib.mail.CmdMailCharacter.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.mail.mail.CmdMailCharacter.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'mail', 'category': 'general', 'key': '@mail', 'no_prefix': 'mail mail', 'tags': '', 'text': '\n Communicate with others by sending mail.\n\n Usage:\n @mail - Displays all the mail an account has in their mailbox\n @mail <#> - Displays a specific message\n @mail <accounts>=<subject>/<message>\n - Sends a message to the comma separated list of accounts.\n @mail/delete <#> - Deletes a specific message\n @mail/forward <account list>=<#>[/<Message>]\n - Forwards an existing message to the specified list of accounts,\n original message is delivered with optional Message prepended.\n @mail/reply <#>=<message>\n - Replies to a message #. Prepends message to the original\n message text.\n Switches:\n delete - deletes a message\n forward - forward a received message to another object with an optional message attached.\n reply - Replies to a received message, appending the original message to the bottom.\n Examples:\n @mail 2\n @mail Griatch=New mail/Hey man, I am sending you a message!\n @mail/delete 6\n @mail/forward feend78 Griatch=4/You guys should read this.\n @mail/reply 9=Thanks for the info!\n\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.mail.mail.CmdMailCharacter.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -326,7 +326,7 @@ reply - Replies to a received message, appending the original message to the b
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.mail.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.mail.mail.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -342,8 +342,8 @@ reply - Replies to a received message, appending the original message to the b
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.mail.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.mail.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.game_systems.mail.mail.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -360,7 +360,7 @@ reply - Replies to a received message, appending the original message to the b
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.mail</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.mail.mail</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
125
docs/1.0-dev/api/evennia.contrib.game_systems.mail.tests.html
Normal file
125
docs/1.0-dev/api/evennia.contrib.game_systems.mail.tests.html
Normal file
|
|
@ -0,0 +1,125 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.mail.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.mail.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.mail.tests">
|
||||
<span id="evennia-contrib-game-systems-mail-tests"></span><h1>evennia.contrib.game_systems.mail.tests<a class="headerlink" href="#module-evennia.contrib.game_systems.mail.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Test mail contrib</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.mail.tests.TestMail">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.mail.tests.</code><code class="sig-name descname">TestMail</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/mail/tests.html#TestMail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.mail.tests.TestMail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.mail.tests.TestMail.test_mail">
|
||||
<code class="sig-name descname">test_mail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/mail/tests.html#TestMail.test_mail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.mail.tests.TestMail.test_mail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.mail.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.mail.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.mail.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
120
docs/1.0-dev/api/evennia.contrib.game_systems.multidescer.html
Normal file
120
docs/1.0-dev/api/evennia.contrib.game_systems.multidescer.html
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.multidescer — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.multidescer</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.multidescer">
|
||||
<span id="evennia-contrib-game-systems-multidescer"></span><h1>evennia.contrib.game_systems.multidescer<a class="headerlink" href="#module-evennia.contrib.game_systems.multidescer" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Multidescer - Griatch 2016</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.multidescer.multidescer.html">evennia.contrib.game_systems.multidescer.multidescer</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.multidescer.tests.html">evennia.contrib.game_systems.multidescer.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.multidescer.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.multidescer.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.multidescer</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.multidescer — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.game_systems.multidescer.multidescer — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.multidescer</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.multidescer.multidescer</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,9 +40,9 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.multidescer">
|
||||
<span id="evennia-contrib-multidescer"></span><h1>evennia.contrib.multidescer<a class="headerlink" href="#module-evennia.contrib.multidescer" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Evennia Mutltidescer</p>
|
||||
<section id="module-evennia.contrib.game_systems.multidescer.multidescer">
|
||||
<span id="evennia-contrib-game-systems-multidescer-multidescer"></span><h1>evennia.contrib.game_systems.multidescer.multidescer<a class="headerlink" href="#module-evennia.contrib.game_systems.multidescer.multidescer" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Evennia Multidescer</p>
|
||||
<p>Contrib - Griatch 2016</p>
|
||||
<p>A “multidescer” is a concept from the MUSH world. It allows for
|
||||
creating, managing and switching between multiple character
|
||||
|
|
@ -53,22 +53,22 @@ list) and create it if it does not exist.</p>
|
|||
also adds the short descriptions and the <strong>sdesc</strong> command).</p>
|
||||
<p>Installation:</p>
|
||||
<p>Edit <strong>mygame/commands/default_cmdsets.py</strong> and add
|
||||
<strong>from evennia.contrib.multidescer import CmdMultiDesc</strong> to the top.</p>
|
||||
<strong>from evennia.contrib.game_systems.multidescer import CmdMultiDesc</strong> to the top.</p>
|
||||
<p>Next, look up the <strong>at_cmdset_create</strong> method of the <strong>CharacterCmdSet</strong>
|
||||
class and add a line <strong>self.add(CmdMultiDesc())</strong> to the end
|
||||
of it.</p>
|
||||
<p>Reload the server and you should have the +desc command available (it
|
||||
will replace the default <strong>desc</strong> command).</p>
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.multidescer.DescValidateError">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">evennia.contrib.multidescer.</code><code class="sig-name descname">DescValidateError</code><a class="reference internal" href="../_modules/evennia/contrib/multidescer.html#DescValidateError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.multidescer.DescValidateError" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.multidescer.multidescer.DescValidateError">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">evennia.contrib.game_systems.multidescer.multidescer.</code><code class="sig-name descname">DescValidateError</code><a class="reference internal" href="../_modules/evennia/contrib/game_systems/multidescer/multidescer.html#DescValidateError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.multidescer.multidescer.DescValidateError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></p>
|
||||
<p>Used for tracebacks from desc systems</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.multidescer.CmdMultiDesc">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.multidescer.</code><code class="sig-name descname">CmdMultiDesc</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/multidescer.html#CmdMultiDesc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.multidescer.CmdMultiDesc" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.multidescer.multidescer.</code><code class="sig-name descname">CmdMultiDesc</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/multidescer/multidescer.html#CmdMultiDesc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Manage multiple descriptions</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -88,40 +88,40 @@ any keys not matching an actual description will be inserted
|
|||
as plain text. Use e.g. ansi line break ||/ to add a new
|
||||
paragraph and + + or ansi space ||_ to add extra whitespace.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.multidescer.CmdMultiDesc.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '+desc'</em><a class="headerlink" href="#evennia.contrib.multidescer.CmdMultiDesc.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '+desc'</em><a class="headerlink" href="#evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.multidescer.CmdMultiDesc.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['desc']</em><a class="headerlink" href="#evennia.contrib.multidescer.CmdMultiDesc.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['desc']</em><a class="headerlink" href="#evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.multidescer.CmdMultiDesc.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.multidescer.CmdMultiDesc.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.multidescer.CmdMultiDesc.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.multidescer.CmdMultiDesc.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.multidescer.CmdMultiDesc.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/multidescer.html#CmdMultiDesc.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.multidescer.CmdMultiDesc.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/multidescer/multidescer.html#CmdMultiDesc.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Implements the multidescer. We will use <strong>db.desc</strong> for the
|
||||
description in use and <strong>db.multidesc</strong> to store all descriptions.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.multidescer.CmdMultiDesc.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.multidescer.CmdMultiDesc.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.multidescer.CmdMultiDesc.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'desc', 'category': 'general', 'key': '+desc', 'no_prefix': 'desc desc', 'tags': '', 'text': '\n Manage multiple descriptions\n\n Usage:\n +desc [key] - show current desc desc with <key>\n +desc <key> = <text> - add/replace desc with <key>\n +desc/list - list descriptions (abbreviated)\n +desc/list/full - list descriptions (full texts)\n +desc/edit <key> - add/edit desc <key> in line editor\n +desc/del <key> - delete desc <key>\n +desc/swap <key1>-<key2> - swap positions of <key1> and <key2> in list\n +desc/set <key> [+key+...] - set desc as default or combine multiple descs\n\n Notes:\n When combining multiple descs with +desc/set <key> + <key2> + ...,\n any keys not matching an actual description will be inserted\n as plain text. Use e.g. ansi line break ||/ to add a new\n paragraph and + + or ansi space ||_ to add extra whitespace.\n\n '}</em><a class="headerlink" href="#evennia.contrib.multidescer.CmdMultiDesc.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'desc', 'category': 'general', 'key': '+desc', 'no_prefix': 'desc desc', 'tags': '', 'text': '\n Manage multiple descriptions\n\n Usage:\n +desc [key] - show current desc desc with <key>\n +desc <key> = <text> - add/replace desc with <key>\n +desc/list - list descriptions (abbreviated)\n +desc/list/full - list descriptions (full texts)\n +desc/edit <key> - add/edit desc <key> in line editor\n +desc/del <key> - delete desc <key>\n +desc/swap <key1>-<key2> - swap positions of <key1> and <key2> in list\n +desc/set <key> [+key+...] - set desc as default or combine multiple descs\n\n Notes:\n When combining multiple descs with +desc/set <key> + <key2> + ...,\n any keys not matching an actual description will be inserted\n as plain text. Use e.g. ansi line break ||/ to add a new\n paragraph and + + or ansi space ||_ to add extra whitespace.\n\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.multidescer.multidescer.CmdMultiDesc.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -151,7 +151,7 @@ description in use and <strong>db.multidesc</strong> to store all descriptions.<
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.multidescer.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.multidescer.multidescer.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -167,8 +167,8 @@ description in use and <strong>db.multidesc</strong> to store all descriptions.<
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.multidescer.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.multidescer.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.game_systems.multidescer.multidescer.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -185,7 +185,7 @@ description in use and <strong>db.multidesc</strong> to store all descriptions.<
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.multidescer</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.multidescer.multidescer</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,125 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.multidescer.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.multidescer.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.multidescer.tests">
|
||||
<span id="evennia-contrib-game-systems-multidescer-tests"></span><h1>evennia.contrib.game_systems.multidescer.tests<a class="headerlink" href="#module-evennia.contrib.game_systems.multidescer.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Test multidescer contrib.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.multidescer.tests.TestMultidescer">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.multidescer.tests.</code><code class="sig-name descname">TestMultidescer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/multidescer/tests.html#TestMultidescer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.multidescer.tests.TestMultidescer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.multidescer.tests.TestMultidescer.test_cmdmultidesc">
|
||||
<code class="sig-name descname">test_cmdmultidesc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/multidescer/tests.html#TestMultidescer.test_cmdmultidesc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.multidescer.tests.TestMultidescer.test_cmdmultidesc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.multidescer.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.multidescer.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.multidescer.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
120
docs/1.0-dev/api/evennia.contrib.game_systems.puzzles.html
Normal file
120
docs/1.0-dev/api/evennia.contrib.game_systems.puzzles.html
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.puzzles — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.puzzles</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.puzzles">
|
||||
<span id="evennia-contrib-game-systems-puzzles"></span><h1>evennia.contrib.game_systems.puzzles<a class="headerlink" href="#module-evennia.contrib.game_systems.puzzles" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Puzzles - Henddher 2018</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.puzzles.puzzles.html">evennia.contrib.game_systems.puzzles.puzzles</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.puzzles.tests.html">evennia.contrib.game_systems.puzzles.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.puzzles.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.puzzles.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.puzzles</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.puzzles — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.game_systems.puzzles.puzzles — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.puzzles</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.puzzles.puzzles</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.puzzles">
|
||||
<span id="evennia-contrib-puzzles"></span><h1>evennia.contrib.puzzles<a class="headerlink" href="#module-evennia.contrib.puzzles" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.game_systems.puzzles.puzzles">
|
||||
<span id="evennia-contrib-game-systems-puzzles-puzzles"></span><h1>evennia.contrib.game_systems.puzzles.puzzles<a class="headerlink" href="#module-evennia.contrib.game_systems.puzzles.puzzles" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Puzzles System - Provides a typeclass and commands for
|
||||
objects that can be combined (i.e. ‘use’d) to produce
|
||||
new objects.</p>
|
||||
|
|
@ -49,22 +49,29 @@ new objects.</p>
|
|||
<p>A Puzzle is a recipe of what objects (aka parts) must
|
||||
be combined by a player so a new set of objects
|
||||
(aka results) are automatically created.</p>
|
||||
<p>Installation:</p>
|
||||
<p>Add the PuzzleSystemCmdSet to all players (e.g. in their Character typeclass).</p>
|
||||
<p>Alternatively:</p>
|
||||
<blockquote>
|
||||
<div><p>py self.cmdset.add(‘evennia.contrib.game_systems.puzzles.PuzzleSystemCmdSet’)</p>
|
||||
</div></blockquote>
|
||||
<p>Usage:</p>
|
||||
<p>Consider this simple Puzzle:</p>
|
||||
<blockquote>
|
||||
<div><p>orange, mango, yogurt, blender = fruit smoothie</p>
|
||||
</div></blockquote>
|
||||
<p>As a Builder:</p>
|
||||
<blockquote>
|
||||
<div><p>@create/drop orange
|
||||
@create/drop mango
|
||||
@create/drop yogurt
|
||||
@create/drop blender
|
||||
@create/drop fruit smoothie</p>
|
||||
<p>@puzzle smoothie, orange, mango, yogurt, blender = fruit smoothie
|
||||
<div><p>create/drop orange
|
||||
create/drop mango
|
||||
create/drop yogurt
|
||||
create/drop blender
|
||||
create/drop fruit smoothie</p>
|
||||
<p>puzzle smoothie, orange, mango, yogurt, blender = fruit smoothie
|
||||
…
|
||||
Puzzle smoothie(#1234) created successfuly.</p>
|
||||
<p>@destroy/force orange, mango, yogurt, blender, fruit smoothie</p>
|
||||
<p>@armpuzzle #1234
|
||||
<p>destroy/force orange, mango, yogurt, blender, fruit smoothie</p>
|
||||
<p>armpuzzle #1234
|
||||
Part orange is spawned at …
|
||||
Part mango is spawned at …
|
||||
….
|
||||
|
|
@ -85,68 +92,62 @@ command). Once the recipe is created, all parts and result
|
|||
can be disposed (i.e. destroyed).</p>
|
||||
<p>At a later time, a Builder or a Script can arm the puzzle
|
||||
and spawn all puzzle parts in their respective
|
||||
locations (See @armpuzzle).</p>
|
||||
locations (See armpuzzle).</p>
|
||||
<p>A regular player can collect the puzzle parts and combine
|
||||
them (See use command). If player has specified
|
||||
all pieces, the puzzle is considered solved and all
|
||||
its puzzle parts are destroyed while the puzzle results
|
||||
are spawened on their corresponding location.</p>
|
||||
<p>Installation:</p>
|
||||
<p>Add the PuzzleSystemCmdSet to all players.
|
||||
Alternatively:</p>
|
||||
<blockquote>
|
||||
<div><p>@py self.cmdset.add(‘evennia.contrib.puzzles.PuzzleSystemCmdSet’)</p>
|
||||
</div></blockquote>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.puzzles.proto_def">
|
||||
<code class="sig-prename descclassname">evennia.contrib.puzzles.</code><code class="sig-name descname">proto_def</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">with_tags</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#proto_def"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.proto_def" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.proto_def">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.puzzles.puzzles.</code><code class="sig-name descname">proto_def</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">with_tags</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#proto_def"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.proto_def" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Basic properties needed to spawn
|
||||
and compare recipe with candidate part</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.puzzles.maskout_protodef">
|
||||
<code class="sig-prename descclassname">evennia.contrib.puzzles.</code><code class="sig-name descname">maskout_protodef</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">protodef</span></em>, <em class="sig-param"><span class="n">mask</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#maskout_protodef"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.maskout_protodef" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.maskout_protodef">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.puzzles.puzzles.</code><code class="sig-name descname">maskout_protodef</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">protodef</span></em>, <em class="sig-param"><span class="n">mask</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#maskout_protodef"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.maskout_protodef" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a new protodef after removing protodef values based on mask</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.puzzles.PuzzleRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.puzzles.</code><code class="sig-name descname">PuzzleRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#PuzzleRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.PuzzleRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.PuzzleRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.puzzles.puzzles.</code><code class="sig-name descname">PuzzleRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#PuzzleRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.PuzzleRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript" title="evennia.scripts.scripts.DefaultScript"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript</span></code></a></p>
|
||||
<p>Definition of a Puzzle Recipe</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.puzzles.PuzzleRecipe.save_recipe">
|
||||
<code class="sig-name descname">save_recipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">puzzle_name</span></em>, <em class="sig-param"><span class="n">parts</span></em>, <em class="sig-param"><span class="n">results</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#PuzzleRecipe.save_recipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.PuzzleRecipe.save_recipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.PuzzleRecipe.save_recipe">
|
||||
<code class="sig-name descname">save_recipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">puzzle_name</span></em>, <em class="sig-param"><span class="n">parts</span></em>, <em class="sig-param"><span class="n">results</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#PuzzleRecipe.save_recipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.PuzzleRecipe.save_recipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.puzzles.PuzzleRecipe.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.puzzles.PuzzleRecipe.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.PuzzleRecipe.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.PuzzleRecipe.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.DoesNotExist" title="evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.puzzles.PuzzleRecipe.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.puzzles.PuzzleRecipe.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.PuzzleRecipe.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.PuzzleRecipe.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.PuzzleRecipe.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.puzzles.PuzzleRecipe'</em><a class="headerlink" href="#evennia.contrib.puzzles.PuzzleRecipe.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.PuzzleRecipe.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.puzzles.puzzles.PuzzleRecipe'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.PuzzleRecipe.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.PuzzleRecipe.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'PuzzleRecipe'</em><a class="headerlink" href="#evennia.contrib.puzzles.PuzzleRecipe.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.PuzzleRecipe.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'PuzzleRecipe'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.PuzzleRecipe.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.puzzles.CmdCreatePuzzleRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.puzzles.</code><code class="sig-name descname">CmdCreatePuzzleRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#CmdCreatePuzzleRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.CmdCreatePuzzleRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.puzzles.puzzles.</code><code class="sig-name descname">CmdCreatePuzzleRecipe</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#CmdCreatePuzzleRecipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Creates a puzzle recipe. A puzzle consists of puzzle-parts that
|
||||
the player can ‘use’ together to create a specified result.</p>
|
||||
|
|
@ -167,58 +168,58 @@ corresponding location in order to create the puzzle. After the creation of the
|
|||
these objects are not needed anymore and can be deleted. Components of the puzzle
|
||||
will be re-created by use of the <strong>@armpuzzle</strong> command later.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdCreatePuzzleRecipe.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@puzzle'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdCreatePuzzleRecipe.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@puzzle'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdCreatePuzzleRecipe.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@puzzlerecipe']</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdCreatePuzzleRecipe.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@puzzlerecipe']</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdCreatePuzzleRecipe.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(puzzle) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdCreatePuzzleRecipe.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(puzzle) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdCreatePuzzleRecipe.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'puzzles'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdCreatePuzzleRecipe.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'puzzles'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdCreatePuzzleRecipe.confirm">
|
||||
<code class="sig-name descname">confirm</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdCreatePuzzleRecipe.confirm" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.confirm">
|
||||
<code class="sig-name descname">confirm</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.confirm" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdCreatePuzzleRecipe.default_confirm">
|
||||
<code class="sig-name descname">default_confirm</code><em class="property"> = 'no'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdCreatePuzzleRecipe.default_confirm" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.default_confirm">
|
||||
<code class="sig-name descname">default_confirm</code><em class="property"> = 'no'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.default_confirm" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.puzzles.CmdCreatePuzzleRecipe.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#CmdCreatePuzzleRecipe.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.CmdCreatePuzzleRecipe.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#CmdCreatePuzzleRecipe.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is the hook function that actually does all the work. It is called
|
||||
by the cmdhandler right after self.parser() finishes, and so has access
|
||||
to all the variables defined therein.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdCreatePuzzleRecipe.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(puzzle) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdCreatePuzzleRecipe.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(puzzle) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdCreatePuzzleRecipe.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@puzzlerecipe', 'category': 'puzzles', 'key': '@puzzle', 'no_prefix': 'puzzle puzzlerecipe', 'tags': '', 'text': "\n Creates a puzzle recipe. A puzzle consists of puzzle-parts that\n the player can 'use' together to create a specified result.\n\n Usage:\n @puzzle name,<part1[,part2,...>] = <result1[,result2,...]>\n\n Example:\n create/drop balloon\n create/drop glass of water\n create/drop water balloon\n @puzzle waterballon,balloon,glass of water = water balloon\n @del ballon, glass of water, water balloon\n @armpuzzle #1\n\n Notes:\n Each part and result are objects that must (temporarily) exist and be placed in their\n corresponding location in order to create the puzzle. After the creation of the puzzle,\n these objects are not needed anymore and can be deleted. Components of the puzzle\n will be re-created by use of the `@armpuzzle` command later.\n\n "}</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdCreatePuzzleRecipe.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@puzzlerecipe', 'category': 'puzzles', 'key': '@puzzle', 'no_prefix': 'puzzle puzzlerecipe', 'tags': '', 'text': "\n Creates a puzzle recipe. A puzzle consists of puzzle-parts that\n the player can 'use' together to create a specified result.\n\n Usage:\n @puzzle name,<part1[,part2,...>] = <result1[,result2,...]>\n\n Example:\n create/drop balloon\n create/drop glass of water\n create/drop water balloon\n @puzzle waterballon,balloon,glass of water = water balloon\n @del ballon, glass of water, water balloon\n @armpuzzle #1\n\n Notes:\n Each part and result are objects that must (temporarily) exist and be placed in their\n corresponding location in order to create the puzzle. After the creation of the puzzle,\n these objects are not needed anymore and can be deleted. Components of the puzzle\n will be re-created by use of the `@armpuzzle` command later.\n\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdCreatePuzzleRecipe.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.puzzles.CmdEditPuzzle">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.puzzles.</code><code class="sig-name descname">CmdEditPuzzle</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#CmdEditPuzzle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.CmdEditPuzzle" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.puzzles.puzzles.</code><code class="sig-name descname">CmdEditPuzzle</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#CmdEditPuzzle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Edits puzzle properties</p>
|
||||
<dl>
|
||||
|
|
@ -245,48 +246,48 @@ use_success_location_message containing {result_names} and {caller} will</p>
|
|||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdEditPuzzle.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@puzzleedit'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdEditPuzzle.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@puzzleedit'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdEditPuzzle.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(puzzleedit) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdEditPuzzle.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(puzzleedit) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdEditPuzzle.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'puzzles'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdEditPuzzle.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'puzzles'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.puzzles.CmdEditPuzzle.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#CmdEditPuzzle.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.CmdEditPuzzle.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#CmdEditPuzzle.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is the hook function that actually does all the work. It is called
|
||||
by the cmdhandler right after self.parser() finishes, and so has access
|
||||
to all the variables defined therein.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdEditPuzzle.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdEditPuzzle.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdEditPuzzle.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(puzzleedit) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdEditPuzzle.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(puzzleedit) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdEditPuzzle.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'puzzles', 'key': '@puzzleedit', 'no_prefix': 'puzzleedit ', 'tags': '', 'text': "\n Edits puzzle properties\n\n Usage:\n @puzzleedit[/delete] <#dbref>\n @puzzleedit <#dbref>/use_success_message = <Custom message>\n @puzzleedit <#dbref>/use_success_location_message = <Custom message from {caller} producing {result_names}>\n @puzzleedit <#dbref>/mask = attr1[,attr2,...]>\n @puzzleedit[/addpart] <#dbref> = <obj[,obj2,...]>\n @puzzleedit[/delpart] <#dbref> = <obj[,obj2,...]>\n @puzzleedit[/addresult] <#dbref> = <obj[,obj2,...]>\n @puzzleedit[/delresult] <#dbref> = <obj[,obj2,...]>\n\n Switches:\n addpart - adds parts to the puzzle\n delpart - removes parts from the puzzle\n addresult - adds results to the puzzle\n delresult - removes results from the puzzle\n delete - deletes the recipe. Existing parts and results aren't modified\n\n mask - attributes to exclude during matching (e.g. location, desc, etc.)\n use_success_location_message containing {result_names} and {caller} will\n automatically be replaced with correct values. Both are optional.\n\n When removing parts/results, it's possible to remove all.\n\n "}</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdEditPuzzle.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'puzzles', 'key': '@puzzleedit', 'no_prefix': 'puzzleedit ', 'tags': '', 'text': "\n Edits puzzle properties\n\n Usage:\n @puzzleedit[/delete] <#dbref>\n @puzzleedit <#dbref>/use_success_message = <Custom message>\n @puzzleedit <#dbref>/use_success_location_message = <Custom message from {caller} producing {result_names}>\n @puzzleedit <#dbref>/mask = attr1[,attr2,...]>\n @puzzleedit[/addpart] <#dbref> = <obj[,obj2,...]>\n @puzzleedit[/delpart] <#dbref> = <obj[,obj2,...]>\n @puzzleedit[/addresult] <#dbref> = <obj[,obj2,...]>\n @puzzleedit[/delresult] <#dbref> = <obj[,obj2,...]>\n\n Switches:\n addpart - adds parts to the puzzle\n delpart - removes parts from the puzzle\n addresult - adds results to the puzzle\n delresult - removes results from the puzzle\n delete - deletes the recipe. Existing parts and results aren't modified\n\n mask - attributes to exclude during matching (e.g. location, desc, etc.)\n use_success_location_message containing {result_names} and {caller} will\n automatically be replaced with correct values. Both are optional.\n\n When removing parts/results, it's possible to remove all.\n\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdEditPuzzle.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.puzzles.CmdArmPuzzle">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.puzzles.</code><code class="sig-name descname">CmdArmPuzzle</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#CmdArmPuzzle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.CmdArmPuzzle" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.puzzles.puzzles.</code><code class="sig-name descname">CmdArmPuzzle</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#CmdArmPuzzle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Arms a puzzle by spawning all its parts.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -297,48 +298,48 @@ to all the variables defined therein.</p>
|
|||
<p>Create puzzles with <strong>@puzzle</strong>; get list of
|
||||
defined puzzles using <strong>@lspuzzlerecipes</strong>.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdArmPuzzle.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@armpuzzle'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdArmPuzzle.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@armpuzzle'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdArmPuzzle.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(armpuzzle) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdArmPuzzle.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(armpuzzle) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdArmPuzzle.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'puzzles'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdArmPuzzle.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'puzzles'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.puzzles.CmdArmPuzzle.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#CmdArmPuzzle.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.CmdArmPuzzle.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#CmdArmPuzzle.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is the hook function that actually does all the work. It is called
|
||||
by the cmdhandler right after self.parser() finishes, and so has access
|
||||
to all the variables defined therein.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdArmPuzzle.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdArmPuzzle.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdArmPuzzle.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(armpuzzle) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdArmPuzzle.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(armpuzzle) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdArmPuzzle.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'puzzles', 'key': '@armpuzzle', 'no_prefix': 'armpuzzle ', 'tags': '', 'text': '\n Arms a puzzle by spawning all its parts.\n\n Usage:\n @armpuzzle <puzzle #dbref>\n\n Notes:\n Create puzzles with `@puzzle`; get list of\n defined puzzles using `@lspuzzlerecipes`.\n\n '}</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdArmPuzzle.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'puzzles', 'key': '@armpuzzle', 'no_prefix': 'armpuzzle ', 'tags': '', 'text': '\n Arms a puzzle by spawning all its parts.\n\n Usage:\n @armpuzzle <puzzle #dbref>\n\n Notes:\n Create puzzles with `@puzzle`; get list of\n defined puzzles using `@lspuzzlerecipes`.\n\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdArmPuzzle.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.puzzles.CmdUsePuzzleParts">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.puzzles.</code><code class="sig-name descname">CmdUsePuzzleParts</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#CmdUsePuzzleParts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.CmdUsePuzzleParts" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.puzzles.puzzles.</code><code class="sig-name descname">CmdUsePuzzleParts</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#CmdUsePuzzleParts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Use an object, or a group of objects at once.</p>
|
||||
<p class="rubric">Example</p>
|
||||
|
|
@ -350,48 +351,48 @@ to all the variables defined therein.</p>
|
|||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdUsePuzzleParts.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'use'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdUsePuzzleParts.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'use'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdUsePuzzleParts.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['combine']</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdUsePuzzleParts.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['combine']</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdUsePuzzleParts.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:pperm(use) or pperm(Player)'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdUsePuzzleParts.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:pperm(use) or pperm(Player)'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdUsePuzzleParts.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'puzzles'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdUsePuzzleParts.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'puzzles'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.puzzles.CmdUsePuzzleParts.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#CmdUsePuzzleParts.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.CmdUsePuzzleParts.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#CmdUsePuzzleParts.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is the hook function that actually does all the work. It is called
|
||||
by the cmdhandler right after self.parser() finishes, and so has access
|
||||
to all the variables defined therein.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdUsePuzzleParts.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:pperm(use) or pperm(Player)'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdUsePuzzleParts.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:pperm(use) or pperm(Player)'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdUsePuzzleParts.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'combine', 'category': 'puzzles', 'key': 'use', 'no_prefix': ' combine', 'tags': '', 'text': '\n Use an object, or a group of objects at once.\n\n\n Example:\n You look around you and see a pole, a long string, and a needle.\n\n use pole, long string, needle\n\n Genius! You built a fishing pole.\n\n\n Usage:\n use <obj1> [,obj2,...]\n '}</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdUsePuzzleParts.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'combine', 'category': 'puzzles', 'key': 'use', 'no_prefix': ' combine', 'tags': '', 'text': '\n Use an object, or a group of objects at once.\n\n\n Example:\n You look around you and see a pole, a long string, and a needle.\n\n use pole, long string, needle\n\n Genius! You built a fishing pole.\n\n\n Usage:\n use <obj1> [,obj2,...]\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdUsePuzzleParts.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.puzzles.CmdListPuzzleRecipes">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.puzzles.</code><code class="sig-name descname">CmdListPuzzleRecipes</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#CmdListPuzzleRecipes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.CmdListPuzzleRecipes" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.puzzles.puzzles.</code><code class="sig-name descname">CmdListPuzzleRecipes</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#CmdListPuzzleRecipes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Searches for all puzzle recipes</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -399,48 +400,48 @@ to all the variables defined therein.</p>
|
|||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdListPuzzleRecipes.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@lspuzzlerecipes'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdListPuzzleRecipes.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@lspuzzlerecipes'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdListPuzzleRecipes.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(lspuzzlerecipes) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdListPuzzleRecipes.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(lspuzzlerecipes) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdListPuzzleRecipes.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'puzzles'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdListPuzzleRecipes.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'puzzles'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.puzzles.CmdListPuzzleRecipes.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#CmdListPuzzleRecipes.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.CmdListPuzzleRecipes.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#CmdListPuzzleRecipes.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is the hook function that actually does all the work. It is called
|
||||
by the cmdhandler right after self.parser() finishes, and so has access
|
||||
to all the variables defined therein.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdListPuzzleRecipes.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdListPuzzleRecipes.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdListPuzzleRecipes.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(lspuzzlerecipes) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdListPuzzleRecipes.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(lspuzzlerecipes) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdListPuzzleRecipes.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'puzzles', 'key': '@lspuzzlerecipes', 'no_prefix': 'lspuzzlerecipes ', 'tags': '', 'text': '\n Searches for all puzzle recipes\n\n Usage:\n @lspuzzlerecipes\n '}</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdListPuzzleRecipes.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'puzzles', 'key': '@lspuzzlerecipes', 'no_prefix': 'lspuzzlerecipes ', 'tags': '', 'text': '\n Searches for all puzzle recipes\n\n Usage:\n @lspuzzlerecipes\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListPuzzleRecipes.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.puzzles.CmdListArmedPuzzles">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.puzzles.</code><code class="sig-name descname">CmdListArmedPuzzles</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#CmdListArmedPuzzles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.CmdListArmedPuzzles" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.puzzles.puzzles.</code><code class="sig-name descname">CmdListArmedPuzzles</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#CmdListArmedPuzzles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Searches for all armed puzzles</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -448,61 +449,61 @@ to all the variables defined therein.</p>
|
|||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdListArmedPuzzles.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@lsarmedpuzzles'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdListArmedPuzzles.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@lsarmedpuzzles'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdListArmedPuzzles.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(lsarmedpuzzles) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdListArmedPuzzles.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(lsarmedpuzzles) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdListArmedPuzzles.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'puzzles'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdListArmedPuzzles.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'puzzles'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.puzzles.CmdListArmedPuzzles.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#CmdListArmedPuzzles.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.CmdListArmedPuzzles.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#CmdListArmedPuzzles.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is the hook function that actually does all the work. It is called
|
||||
by the cmdhandler right after self.parser() finishes, and so has access
|
||||
to all the variables defined therein.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdListArmedPuzzles.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdListArmedPuzzles.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdListArmedPuzzles.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(lsarmedpuzzles) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdListArmedPuzzles.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(lsarmedpuzzles) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.CmdListArmedPuzzles.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'puzzles', 'key': '@lsarmedpuzzles', 'no_prefix': 'lsarmedpuzzles ', 'tags': '', 'text': '\n Searches for all armed puzzles\n\n Usage:\n @lsarmedpuzzles\n '}</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdListArmedPuzzles.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'puzzles', 'key': '@lsarmedpuzzles', 'no_prefix': 'lsarmedpuzzles ', 'tags': '', 'text': '\n Searches for all armed puzzles\n\n Usage:\n @lsarmedpuzzles\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.CmdListArmedPuzzles.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.puzzles.PuzzleSystemCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.puzzles.</code><code class="sig-name descname">PuzzleSystemCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#PuzzleSystemCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.PuzzleSystemCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.PuzzleSystemCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.puzzles.puzzles.</code><code class="sig-name descname">PuzzleSystemCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#PuzzleSystemCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.PuzzleSystemCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
|
||||
<p>CmdSet to create, arm and resolve Puzzles</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.puzzles.PuzzleSystemCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/puzzles.html#PuzzleSystemCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.puzzles.PuzzleSystemCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.PuzzleSystemCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/puzzles.html#PuzzleSystemCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.PuzzleSystemCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method - this should be overloaded in the inheriting
|
||||
class, and should take care of populating the cmdset by use of
|
||||
self.add().</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.puzzles.PuzzleSystemCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.puzzles.PuzzleSystemCmdSet'</em><a class="headerlink" href="#evennia.contrib.puzzles.PuzzleSystemCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.puzzles.puzzles.PuzzleSystemCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.puzzles.puzzles.PuzzleSystemCmdSet'</em><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.puzzles.PuzzleSystemCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -532,7 +533,7 @@ self.add().</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.puzzles.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.puzzles.puzzles.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -548,8 +549,8 @@ self.add().</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.puzzles.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.puzzles.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.game_systems.puzzles.puzzles.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -566,7 +567,7 @@ self.add().</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.puzzles</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.puzzles.puzzles</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
176
docs/1.0-dev/api/evennia.contrib.game_systems.puzzles.tests.html
Normal file
176
docs/1.0-dev/api/evennia.contrib.game_systems.puzzles.tests.html
Normal file
|
|
@ -0,0 +1,176 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.puzzles.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.puzzles.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.puzzles.tests">
|
||||
<span id="evennia-contrib-game-systems-puzzles-tests"></span><h1>evennia.contrib.game_systems.puzzles.tests<a class="headerlink" href="#module-evennia.contrib.game_systems.puzzles.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Testing puzzles.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.puzzles.tests.TestPuzzles">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.puzzles.tests.</code><code class="sig-name descname">TestPuzzles</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/tests.html#TestPuzzles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.tests.TestPuzzles" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.puzzles.tests.TestPuzzles.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/tests.html#TestPuzzles.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.tests.TestPuzzles.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_cmdset_puzzle">
|
||||
<code class="sig-name descname">test_cmdset_puzzle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/tests.html#TestPuzzles.test_cmdset_puzzle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_cmdset_puzzle" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_cmd_puzzle">
|
||||
<code class="sig-name descname">test_cmd_puzzle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/tests.html#TestPuzzles.test_cmd_puzzle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_cmd_puzzle" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_cmd_armpuzzle">
|
||||
<code class="sig-name descname">test_cmd_armpuzzle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/tests.html#TestPuzzles.test_cmd_armpuzzle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_cmd_armpuzzle" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_cmd_use">
|
||||
<code class="sig-name descname">test_cmd_use</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/tests.html#TestPuzzles.test_cmd_use"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_cmd_use" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_puzzleedit">
|
||||
<code class="sig-name descname">test_puzzleedit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/tests.html#TestPuzzles.test_puzzleedit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_puzzleedit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_puzzleedit_add_remove_parts_results">
|
||||
<code class="sig-name descname">test_puzzleedit_add_remove_parts_results</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/tests.html#TestPuzzles.test_puzzleedit_add_remove_parts_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_puzzleedit_add_remove_parts_results" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_lspuzzlerecipes_lsarmedpuzzles">
|
||||
<code class="sig-name descname">test_lspuzzlerecipes_lsarmedpuzzles</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/tests.html#TestPuzzles.test_lspuzzlerecipes_lsarmedpuzzles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_lspuzzlerecipes_lsarmedpuzzles" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_e2e">
|
||||
<code class="sig-name descname">test_e2e</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/tests.html#TestPuzzles.test_e2e"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_e2e" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_e2e_accumulative">
|
||||
<code class="sig-name descname">test_e2e_accumulative</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/tests.html#TestPuzzles.test_e2e_accumulative"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_e2e_accumulative" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_e2e_interchangeable_parts_and_results">
|
||||
<code class="sig-name descname">test_e2e_interchangeable_parts_and_results</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/puzzles/tests.html#TestPuzzles.test_e2e_interchangeable_parts_and_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_e2e_interchangeable_parts_and_results" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.puzzles.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.puzzles.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.puzzles.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.evscaperoom — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.game_systems.turnbattle — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.evscaperoom</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.turnbattle</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,18 +40,17 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.evscaperoom">
|
||||
<span id="evennia-contrib-evscaperoom"></span><h1>evennia.contrib.evscaperoom<a class="headerlink" href="#module-evennia.contrib.evscaperoom" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.game_systems.turnbattle">
|
||||
<span id="evennia-contrib-game-systems-turnbattle"></span><h1>evennia.contrib.game_systems.turnbattle<a class="headerlink" href="#module-evennia.contrib.game_systems.turnbattle" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Turnbattle system - Tim Ashley Jenkins 2017</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.evscaperoom.commands.html">evennia.contrib.evscaperoom.commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.evscaperoom.menu.html">evennia.contrib.evscaperoom.menu</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.evscaperoom.objects.html">evennia.contrib.evscaperoom.objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.evscaperoom.room.html">evennia.contrib.evscaperoom.room</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.evscaperoom.scripts.html">evennia.contrib.evscaperoom.scripts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.evscaperoom.state.html">evennia.contrib.evscaperoom.state</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.evscaperoom.tests.html">evennia.contrib.evscaperoom.tests</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.evscaperoom.utils.html">evennia.contrib.evscaperoom.utils</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_basic.html">evennia.contrib.game_systems.turnbattle.tb_basic</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_equip.html">evennia.contrib.game_systems.turnbattle.tb_equip</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_items.html">evennia.contrib.game_systems.turnbattle.tb_items</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_magic.html">evennia.contrib.game_systems.turnbattle.tb_magic</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tb_range.html">evennia.contrib.game_systems.turnbattle.tb_range</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.turnbattle.tests.html">evennia.contrib.game_systems.turnbattle.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -79,7 +78,7 @@
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.evscaperoom.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.turnbattle.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -95,7 +94,7 @@
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.evscaperoom.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="evennia.contrib.game_systems.turnbattle.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -113,7 +112,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.evscaperoom</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.turnbattle</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.turnbattle.tb_basic — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.game_systems.turnbattle.tb_basic — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.turnbattle.tb_basic</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.turnbattle.tb_basic</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.turnbattle.tb_basic">
|
||||
<span id="evennia-contrib-turnbattle-tb-basic"></span><h1>evennia.contrib.turnbattle.tb_basic<a class="headerlink" href="#module-evennia.contrib.turnbattle.tb_basic" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.game_systems.turnbattle.tb_basic">
|
||||
<span id="evennia-contrib-game-systems-turnbattle-tb-basic"></span><h1>evennia.contrib.game_systems.turnbattle.tb_basic<a class="headerlink" href="#module-evennia.contrib.game_systems.turnbattle.tb_basic" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Simple turn-based combat system</p>
|
||||
<p>Contrib - Tim Ashley Jenkins 2017</p>
|
||||
<p>This is a framework for a simple turn-based combat system, similar
|
||||
|
|
@ -58,7 +58,7 @@ own battle system.</p>
|
|||
<p>To install and test, import this module’s TBBasicCharacter object into
|
||||
your game’s character.py module:</p>
|
||||
<blockquote>
|
||||
<div><p>from evennia.contrib.turnbattle.tb_basic import TBBasicCharacter</p>
|
||||
<div><p>from evennia.contrib.game_systems.turnbattle.tb_basic import TBBasicCharacter</p>
|
||||
</div></blockquote>
|
||||
<p>And change your game’s character typeclass to inherit from TBBasicCharacter
|
||||
instead of the default:</p>
|
||||
|
|
@ -67,7 +67,7 @@ instead of the default:</p>
|
|||
</div></blockquote>
|
||||
<p>Next, import this module into your default_cmdsets.py module:</p>
|
||||
<blockquote>
|
||||
<div><p>from evennia.contrib.turnbattle import tb_basic</p>
|
||||
<div><p>from evennia.contrib.game_systems.turnbattle import tb_basic</p>
|
||||
</div></blockquote>
|
||||
<p>And add the battle command set to your default command set:</p>
|
||||
<blockquote>
|
||||
|
|
@ -80,13 +80,13 @@ self.add(tb_basic.BattleCmdSet())</p>
|
|||
to your game’s ‘world’ folder and modify it there rather than importing it
|
||||
in your game and using it as-is.</p>
|
||||
<dl class="py data">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.ACTIONS_PER_TURN">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">ACTIONS_PER_TURN</code><em class="property"> = 1</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.ACTIONS_PER_TURN" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.ACTIONS_PER_TURN">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">ACTIONS_PER_TURN</code><em class="property"> = 1</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.ACTIONS_PER_TURN" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.roll_init">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">roll_init</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#roll_init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.roll_init" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.roll_init">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">roll_init</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#roll_init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.roll_init" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Rolls a number between 1-1000 to determine initiative.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -109,8 +109,8 @@ an advantage in turn order, like so:</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.get_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">get_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#get_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.get_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.get_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">get_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#get_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.get_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a value for an attack roll.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -137,8 +137,8 @@ to this function, even though nothing from either one are used in this example.<
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.get_defense">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">get_defense</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#get_defense"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.get_defense" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.get_defense">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">get_defense</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#get_defense"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.get_defense" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a value for defense, which an attack roll must equal or exceed in order
|
||||
for an attack to hit.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -164,8 +164,8 @@ attacker into account.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.get_damage">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">get_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#get_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.get_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.get_damage">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">get_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#get_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.get_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a value for damage to be deducted from the defender’s HP after abilities
|
||||
successful hit.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -191,8 +191,8 @@ properties from either the attacker or defender.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.apply_damage">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">apply_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">damage</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#apply_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.apply_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.apply_damage">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">apply_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">damage</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#apply_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.apply_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Applies damage to a target, reducing their HP by the damage amount to a
|
||||
minimum of 0.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -206,8 +206,8 @@ minimum of 0.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.at_defeat">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">at_defeat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defeated</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#at_defeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.at_defeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.at_defeat">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">at_defeat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defeated</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#at_defeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.at_defeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Announces the defeat of a fighter in combat.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -222,8 +222,8 @@ do it.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.resolve_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">resolve_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">attack_value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">defense_value</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#resolve_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.resolve_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.resolve_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">resolve_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">attack_value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">defense_value</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#resolve_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.resolve_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resolves an attack and outputs the result.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -240,8 +240,8 @@ so that they are easier to expand upon.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.combat_cleanup">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">combat_cleanup</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#combat_cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.combat_cleanup" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.combat_cleanup">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">combat_cleanup</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#combat_cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.combat_cleanup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cleans up all the temporary combat-related attributes on a character.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -254,8 +254,8 @@ longer needed once a fight ends.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.is_in_combat">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">is_in_combat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#is_in_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.is_in_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.is_in_combat">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">is_in_combat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#is_in_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.is_in_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns true if the given character is in combat.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -268,8 +268,8 @@ longer needed once a fight ends.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.is_turn">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">is_turn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#is_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.is_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.is_turn">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">is_turn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#is_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.is_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns true if it’s currently the given character’s turn in combat.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -282,8 +282,8 @@ longer needed once a fight ends.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.spend_action">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">spend_action</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">actions</span></em>, <em class="sig-param"><span class="n">action_name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#spend_action"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.spend_action" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.spend_action">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">spend_action</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">actions</span></em>, <em class="sig-param"><span class="n">action_name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#spend_action"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.spend_action" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Spends a character’s available combat actions and checks for end of turn.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -302,21 +302,21 @@ longer needed once a fight ends.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicCharacter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">TBBasicCharacter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#TBBasicCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicCharacter" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">TBBasicCharacter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#TBBasicCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter" title="evennia.objects.objects.DefaultCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter</span></code></a></p>
|
||||
<p>A character able to participate in turn-based combat. Has attributes for current
|
||||
and maximum HP, and access to combat commands.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicCharacter.at_object_creation">
|
||||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#TBBasicCharacter.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicCharacter.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter.at_object_creation">
|
||||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#TBBasicCharacter.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called once, when this object is first created. This is the
|
||||
normal hook to overload for most object types.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicCharacter.at_pre_move">
|
||||
<code class="sig-name descname">at_pre_move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">destination</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#TBBasicCharacter.at_pre_move"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicCharacter.at_pre_move" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter.at_pre_move">
|
||||
<code class="sig-name descname">at_pre_move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">destination</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#TBBasicCharacter.at_pre_move"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter.at_pre_move" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called just before starting to move this object to
|
||||
destination.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -333,32 +333,32 @@ before it is even started.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicCharacter.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicCharacter.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.DoesNotExist" title="evennia.objects.objects.DefaultCharacter.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicCharacter.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicCharacter.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned" title="evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicCharacter.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.turnbattle.tb_basic.TBBasicCharacter'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicCharacter.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicCharacter.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TBBasicCharacter'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicCharacter.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TBBasicCharacter'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicCharacter.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">TBBasicTurnHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#TBBasicTurnHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">TBBasicTurnHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#TBBasicTurnHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript" title="evennia.scripts.scripts.DefaultScript"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript</span></code></a></p>
|
||||
<p>This is the script that handles the progression of combat through turns.
|
||||
On creation (when a fight is started) it adds all combat-ready characters
|
||||
|
|
@ -368,26 +368,26 @@ room as its object.</p>
|
|||
<p>Fights persist until only one participant is left with any HP or all
|
||||
remaining participants choose to end the combat with the ‘disengage’ command.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#TBBasicTurnHandler.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#TBBasicTurnHandler.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called once, when the script is created.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.at_stop">
|
||||
<code class="sig-name descname">at_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#TBBasicTurnHandler.at_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.at_stop" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.at_stop">
|
||||
<code class="sig-name descname">at_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#TBBasicTurnHandler.at_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.at_stop" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called at script termination.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.at_repeat">
|
||||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#TBBasicTurnHandler.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.at_repeat">
|
||||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#TBBasicTurnHandler.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called once every self.interval seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.initialize_for_combat">
|
||||
<code class="sig-name descname">initialize_for_combat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#TBBasicTurnHandler.initialize_for_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.initialize_for_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.initialize_for_combat">
|
||||
<code class="sig-name descname">initialize_for_combat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#TBBasicTurnHandler.initialize_for_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.initialize_for_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Prepares a character for combat when starting or entering a fight.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -397,8 +397,8 @@ remaining participants choose to end the combat with the ‘disengage’ command
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.start_turn">
|
||||
<code class="sig-name descname">start_turn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#TBBasicTurnHandler.start_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.start_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.start_turn">
|
||||
<code class="sig-name descname">start_turn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#TBBasicTurnHandler.start_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.start_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Readies a character for the start of their turn by replenishing their
|
||||
available actions and notifying them that their turn has come up.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -415,14 +415,14 @@ something similar.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.next_turn">
|
||||
<code class="sig-name descname">next_turn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#TBBasicTurnHandler.next_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.next_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.next_turn">
|
||||
<code class="sig-name descname">next_turn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#TBBasicTurnHandler.next_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.next_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Advances to the next character in the turn order.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.turn_end_check">
|
||||
<code class="sig-name descname">turn_end_check</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#TBBasicTurnHandler.turn_end_check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.turn_end_check" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.turn_end_check">
|
||||
<code class="sig-name descname">turn_end_check</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#TBBasicTurnHandler.turn_end_check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.turn_end_check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Tests to see if a character’s turn is over, and cycles to the next turn if it is.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -432,8 +432,8 @@ something similar.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.join_fight">
|
||||
<code class="sig-name descname">join_fight</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#TBBasicTurnHandler.join_fight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.join_fight" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.join_fight">
|
||||
<code class="sig-name descname">join_fight</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#TBBasicTurnHandler.join_fight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.join_fight" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a new character to a fight already in progress.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -443,32 +443,32 @@ something similar.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.DoesNotExist" title="evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TBBasicTurnHandler'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.TBBasicTurnHandler.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TBBasicTurnHandler'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.TBBasicTurnHandler.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdFight">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">CmdFight</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#CmdFight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdFight" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdFight">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">CmdFight</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#CmdFight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdFight" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Starts a fight with everyone in the same room as you.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -479,41 +479,41 @@ something similar.</p>
|
|||
fight is added to combat, and a turn order is randomly rolled.
|
||||
When it’s your turn, you can attack other characters.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdFight.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'fight'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdFight.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdFight.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'fight'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdFight.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdFight.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdFight.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdFight.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdFight.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdFight.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#CmdFight.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdFight.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdFight.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#CmdFight.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdFight.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdFight.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdFight.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdFight.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdFight.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdFight.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdFight.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdFight.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdFight.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdFight.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'fight', 'no_prefix': ' ', 'tags': '', 'text': "\n Starts a fight with everyone in the same room as you.\n\n Usage:\n fight\n\n When you start a fight, everyone in the room who is able to\n fight is added to combat, and a turn order is randomly rolled.\n When it's your turn, you can attack other characters.\n "}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdFight.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdFight.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'fight', 'no_prefix': ' ', 'tags': '', 'text': "\n Starts a fight with everyone in the same room as you.\n\n Usage:\n fight\n\n When you start a fight, everyone in the room who is able to\n fight is added to combat, and a turn order is randomly rolled.\n When it's your turn, you can attack other characters.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdFight.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdAttack">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">CmdAttack</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#CmdAttack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdAttack" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdAttack">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">CmdAttack</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#CmdAttack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdAttack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Attacks another character.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -523,41 +523,41 @@ When it’s your turn, you can attack other characters.</p>
|
|||
<p>When in a fight, you may attack another character. The attack has
|
||||
a chance to hit, and if successful, will deal damage.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdAttack.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'attack'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdAttack.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdAttack.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'attack'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdAttack.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdAttack.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdAttack.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdAttack.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdAttack.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdAttack.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#CmdAttack.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdAttack.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdAttack.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#CmdAttack.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdAttack.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdAttack.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdAttack.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdAttack.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdAttack.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdAttack.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdAttack.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdAttack.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdAttack.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdAttack.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'attack', 'no_prefix': ' ', 'tags': '', 'text': '\n Attacks another character.\n\n Usage:\n attack <target>\n\n When in a fight, you may attack another character. The attack has\n a chance to hit, and if successful, will deal damage.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdAttack.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdAttack.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'attack', 'no_prefix': ' ', 'tags': '', 'text': '\n Attacks another character.\n\n Usage:\n attack <target>\n\n When in a fight, you may attack another character. The attack has\n a chance to hit, and if successful, will deal damage.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdAttack.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdPass">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">CmdPass</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#CmdPass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdPass" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">CmdPass</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#CmdPass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Passes on your turn.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -567,41 +567,41 @@ a chance to hit, and if successful, will deal damage.</p>
|
|||
<p>When in a fight, you can use this command to end your turn early, even
|
||||
if there are still any actions you can take.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdPass.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'pass'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdPass.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'pass'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdPass.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdPass.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdPass.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#CmdPass.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdPass.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#CmdPass.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdPass.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdPass.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdPass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdDisengage">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">CmdDisengage</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#CmdDisengage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdDisengage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdDisengage">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">CmdDisengage</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#CmdDisengage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdDisengage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Passes your turn and attempts to end combat.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -612,41 +612,41 @@ if there are still any actions you can take.</p>
|
|||
the fight. If all participants in a fight disengage, the
|
||||
fight ends.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdDisengage.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'disengage'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdDisengage.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdDisengage.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'disengage'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdDisengage.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdDisengage.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['spare']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdDisengage.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdDisengage.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['spare']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdDisengage.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdDisengage.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdDisengage.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdDisengage.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdDisengage.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdDisengage.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#CmdDisengage.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdDisengage.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdDisengage.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#CmdDisengage.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdDisengage.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdDisengage.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdDisengage.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdDisengage.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdDisengage.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdDisengage.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'spare', 'category': 'combat', 'key': 'disengage', 'no_prefix': ' spare', 'tags': '', 'text': "\n Passes your turn and attempts to end combat.\n\n Usage:\n disengage\n\n Ends your turn early and signals that you're trying to end\n the fight. If all participants in a fight disengage, the\n fight ends.\n "}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdDisengage.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdDisengage.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'spare', 'category': 'combat', 'key': 'disengage', 'no_prefix': ' spare', 'tags': '', 'text': "\n Passes your turn and attempts to end combat.\n\n Usage:\n disengage\n\n Ends your turn early and signals that you're trying to end\n the fight. If all participants in a fight disengage, the\n fight ends.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdDisengage.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdRest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">CmdRest</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#CmdRest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdRest" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdRest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">CmdRest</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#CmdRest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdRest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Recovers damage.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -656,41 +656,41 @@ fight ends.</p>
|
|||
<p>Resting recovers your HP to its maximum, but you can only
|
||||
rest if you’re not in a fight.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdRest.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'rest'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdRest.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdRest.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'rest'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdRest.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdRest.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdRest.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdRest.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdRest.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdRest.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#CmdRest.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdRest.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdRest.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#CmdRest.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdRest.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdRest.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdRest.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdRest.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdRest.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdRest.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdRest.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdRest.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdRest.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdRest.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'rest', 'no_prefix': ' ', 'tags': '', 'text': "\n Recovers damage.\n\n Usage:\n rest\n\n Resting recovers your HP to its maximum, but you can only\n rest if you're not in a fight.\n "}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdRest.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdRest.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'rest', 'no_prefix': ' ', 'tags': '', 'text': "\n Recovers damage.\n\n Usage:\n rest\n\n Resting recovers your HP to its maximum, but you can only\n rest if you're not in a fight.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdRest.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdCombatHelp">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">CmdCombatHelp</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#CmdCombatHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdCombatHelp" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdCombatHelp">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">CmdCombatHelp</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#CmdCombatHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdCombatHelp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.help.html#evennia.commands.default.help.CmdHelp" title="evennia.commands.default.help.CmdHelp"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.help.CmdHelp</span></code></a></p>
|
||||
<p>View help or a list of topics</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -702,57 +702,57 @@ help all</p>
|
|||
<p>This will search for help on commands and other
|
||||
topics related to the game.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdCombatHelp.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#CmdCombatHelp.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdCombatHelp.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdCombatHelp.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#CmdCombatHelp.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdCombatHelp.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Run the dynamic help entry creator.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdCombatHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdCombatHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdCombatHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdCombatHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdCombatHelp.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdCombatHelp.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdCombatHelp.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdCombatHelp.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdCombatHelp.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'help'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdCombatHelp.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdCombatHelp.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'help'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdCombatHelp.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdCombatHelp.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdCombatHelp.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdCombatHelp.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdCombatHelp.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.CmdCombatHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '?', 'category': 'general', 'key': 'help', 'no_prefix': ' ?', 'tags': '', 'text': '\n View help or a list of topics\n\n Usage:\n help <topic or command>\n help list\n help all\n\n This will search for help on commands and other\n topics related to the game.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdCombatHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdCombatHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '?', 'category': 'general', 'key': 'help', 'no_prefix': ' ?', 'tags': '', 'text': '\n View help or a list of topics\n\n Usage:\n help <topic or command>\n help list\n help all\n\n This will search for help on commands and other\n topics related to the game.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdCombatHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.BattleCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_basic.</code><code class="sig-name descname">BattleCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#BattleCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.BattleCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.BattleCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_basic.</code><code class="sig-name descname">BattleCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#BattleCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.BattleCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.cmdset_character.html#evennia.commands.default.cmdset_character.CharacterCmdSet" title="evennia.commands.default.cmdset_character.CharacterCmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.cmdset_character.CharacterCmdSet</span></code></a></p>
|
||||
<p>This command set includes all the commmands used in the battle system.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.BattleCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'DefaultCharacter'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.BattleCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.BattleCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'DefaultCharacter'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.BattleCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.BattleCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_basic.html#BattleCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.BattleCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.BattleCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_basic.html#BattleCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.BattleCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Populates the cmdset</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_basic.BattleCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.turnbattle.tb_basic.BattleCmdSet'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.BattleCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.BattleCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.turnbattle.tb_basic.BattleCmdSet'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.BattleCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -782,7 +782,7 @@ topics related to the game.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.turnbattle.tb_basic.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.turnbattle.tb_basic.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -798,8 +798,8 @@ topics related to the game.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.turnbattle.tb_basic.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.turnbattle.tb_basic.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.game_systems.turnbattle.tb_basic.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -816,7 +816,7 @@ topics related to the game.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.turnbattle.tb_basic</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.turnbattle.tb_basic</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.turnbattle.tb_items — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.game_systems.turnbattle.tb_items — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.turnbattle.tb_items</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.turnbattle.tb_items</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.turnbattle.tb_items">
|
||||
<span id="evennia-contrib-turnbattle-tb-items"></span><h1>evennia.contrib.turnbattle.tb_items<a class="headerlink" href="#module-evennia.contrib.turnbattle.tb_items" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.game_systems.turnbattle.tb_items">
|
||||
<span id="evennia-contrib-game-systems-turnbattle-tb-items"></span><h1>evennia.contrib.game_systems.turnbattle.tb_items<a class="headerlink" href="#module-evennia.contrib.game_systems.turnbattle.tb_items" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Simple turn-based combat system with items and status effects</p>
|
||||
<p>Contrib - Tim Ashley Jenkins 2017</p>
|
||||
<p>This is a version of the ‘turnbattle’ combat system that includes
|
||||
|
|
@ -80,7 +80,7 @@ can be specified on the item as well, but they are optional.</p>
|
|||
<p>To install and test, import this module’s TBItemsCharacter object into
|
||||
your game’s character.py module:</p>
|
||||
<blockquote>
|
||||
<div><p>from evennia.contrib.turnbattle.tb_items import TBItemsCharacter</p>
|
||||
<div><p>from evennia.contrib.game_systems.turnbattle.tb_items import TBItemsCharacter</p>
|
||||
</div></blockquote>
|
||||
<p>And change your game’s character typeclass to inherit from TBItemsCharacter
|
||||
instead of the default:</p>
|
||||
|
|
@ -89,7 +89,7 @@ instead of the default:</p>
|
|||
</div></blockquote>
|
||||
<p>Next, import this module into your default_cmdsets.py module:</p>
|
||||
<blockquote>
|
||||
<div><p>from evennia.contrib.turnbattle import tb_items</p>
|
||||
<div><p>from evennia.contrib.game_systems.turnbattle import tb_items</p>
|
||||
</div></blockquote>
|
||||
<p>And add the battle command set to your default command set:</p>
|
||||
<blockquote>
|
||||
|
|
@ -102,13 +102,13 @@ self.add(tb_items.BattleCmdSet())</p>
|
|||
to your game’s ‘world’ folder and modify it there rather than importing it
|
||||
in your game and using it as-is.</p>
|
||||
<dl class="py data">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.DEF_DOWN_MOD">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">DEF_DOWN_MOD</code><em class="property"> = -15</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.DEF_DOWN_MOD" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.DEF_DOWN_MOD">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">DEF_DOWN_MOD</code><em class="property"> = -15</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.DEF_DOWN_MOD" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.roll_init">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">roll_init</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#roll_init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.roll_init" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.roll_init">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">roll_init</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#roll_init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.roll_init" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Rolls a number between 1-1000 to determine initiative.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -131,8 +131,8 @@ an advantage in turn order, like so:</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.get_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">get_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#get_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.get_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.get_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">get_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#get_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.get_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a value for an attack roll.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -157,8 +157,8 @@ so that attack items’ accuracy is affected as well.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.get_defense">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">get_defense</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#get_defense"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.get_defense" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.get_defense">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">get_defense</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#get_defense"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.get_defense" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a value for defense, which an attack roll must equal or exceed in order
|
||||
for an attack to hit.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -182,8 +182,8 @@ for an attack to hit.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.get_damage">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">get_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#get_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.get_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.get_damage">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">get_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#get_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.get_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a value for damage to be deducted from the defender’s HP after abilities
|
||||
successful hit.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -209,8 +209,8 @@ conditions.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.apply_damage">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">apply_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">damage</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#apply_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.apply_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.apply_damage">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">apply_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">damage</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#apply_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.apply_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Applies damage to a target, reducing their HP by the damage amount to a
|
||||
minimum of 0.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -224,8 +224,8 @@ minimum of 0.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.at_defeat">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">at_defeat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defeated</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#at_defeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.at_defeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.at_defeat">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">at_defeat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defeated</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#at_defeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.at_defeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Announces the defeat of a fighter in combat.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -240,8 +240,8 @@ do it.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.resolve_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">resolve_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">attack_value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">defense_value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">damage_value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inflict_condition</span><span class="o">=</span><span class="default_value">[]</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#resolve_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.resolve_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.resolve_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">resolve_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">attack_value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">defense_value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">damage_value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">inflict_condition</span><span class="o">=</span><span class="default_value">[]</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#resolve_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.resolve_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resolves an attack and outputs the result.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -267,8 +267,8 @@ made with items.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.combat_cleanup">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">combat_cleanup</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#combat_cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.combat_cleanup" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.combat_cleanup">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">combat_cleanup</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#combat_cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.combat_cleanup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cleans up all the temporary combat-related attributes on a character.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -281,8 +281,8 @@ longer needed once a fight ends.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.is_in_combat">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">is_in_combat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#is_in_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.is_in_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.is_in_combat">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">is_in_combat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#is_in_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.is_in_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns true if the given character is in combat.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -295,8 +295,8 @@ longer needed once a fight ends.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.is_turn">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">is_turn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#is_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.is_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.is_turn">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">is_turn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#is_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.is_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns true if it’s currently the given character’s turn in combat.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -309,8 +309,8 @@ longer needed once a fight ends.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.spend_action">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">spend_action</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">actions</span></em>, <em class="sig-param"><span class="n">action_name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#spend_action"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.spend_action" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.spend_action">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">spend_action</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">actions</span></em>, <em class="sig-param"><span class="n">action_name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#spend_action"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.spend_action" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Spends a character’s available combat actions and checks for end of turn.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -329,8 +329,8 @@ longer needed once a fight ends.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.spend_item_use">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">spend_item_use</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em>, <em class="sig-param"><span class="n">user</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#spend_item_use"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.spend_item_use" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.spend_item_use">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">spend_item_use</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em>, <em class="sig-param"><span class="n">user</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#spend_item_use"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.spend_item_use" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Spends one use on an item with limited uses.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -348,8 +348,8 @@ as the name of the prototype to spawn.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.use_item">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">use_item</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">user</span></em>, <em class="sig-param"><span class="n">item</span></em>, <em class="sig-param"><span class="n">target</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#use_item"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.use_item" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.use_item">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">use_item</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">user</span></em>, <em class="sig-param"><span class="n">item</span></em>, <em class="sig-param"><span class="n">target</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#use_item"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.use_item" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Performs the action of using an item.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -363,8 +363,8 @@ as the name of the prototype to spawn.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.condition_tickdown">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">condition_tickdown</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">turnchar</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#condition_tickdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.condition_tickdown" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.condition_tickdown">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">condition_tickdown</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">turnchar</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#condition_tickdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.condition_tickdown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Ticks down the duration of conditions on a character at the start of a given character’s turn.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -381,8 +381,8 @@ combat, it’s instead called when a character’s at_update() hook is called, w
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.add_condition">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">add_condition</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">turnchar</span></em>, <em class="sig-param"><span class="n">condition</span></em>, <em class="sig-param"><span class="n">duration</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#add_condition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.add_condition" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.add_condition">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">add_condition</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">turnchar</span></em>, <em class="sig-param"><span class="n">condition</span></em>, <em class="sig-param"><span class="n">duration</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#add_condition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.add_condition" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a condition to a fighter.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -397,21 +397,21 @@ combat, it’s instead called when a character’s at_update() hook is called, w
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">TBItemsCharacter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacter" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">TBItemsCharacter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter" title="evennia.objects.objects.DefaultCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter</span></code></a></p>
|
||||
<p>A character able to participate in turn-based combat. Has attributes for current
|
||||
and maximum HP, and access to combat commands.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacter.at_object_creation">
|
||||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsCharacter.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacter.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.at_object_creation">
|
||||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsCharacter.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called once, when this object is first created. This is the
|
||||
normal hook to overload for most object types.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacter.at_pre_move">
|
||||
<code class="sig-name descname">at_pre_move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">destination</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsCharacter.at_pre_move"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacter.at_pre_move" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.at_pre_move">
|
||||
<code class="sig-name descname">at_pre_move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">destination</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsCharacter.at_pre_move"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.at_pre_move" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called just before starting to move this object to
|
||||
destination.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -428,88 +428,88 @@ before it is even started.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacter.at_turn_start">
|
||||
<code class="sig-name descname">at_turn_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsCharacter.at_turn_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacter.at_turn_start" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.at_turn_start">
|
||||
<code class="sig-name descname">at_turn_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsCharacter.at_turn_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.at_turn_start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook called at the beginning of this character’s turn in combat.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacter.apply_turn_conditions">
|
||||
<code class="sig-name descname">apply_turn_conditions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsCharacter.apply_turn_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacter.apply_turn_conditions" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.apply_turn_conditions">
|
||||
<code class="sig-name descname">apply_turn_conditions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsCharacter.apply_turn_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.apply_turn_conditions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Applies the effect of conditions that occur at the start of each
|
||||
turn in combat, or every 30 seconds out of combat.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacter.at_update">
|
||||
<code class="sig-name descname">at_update</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsCharacter.at_update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacter.at_update" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.at_update">
|
||||
<code class="sig-name descname">at_update</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsCharacter.at_update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.at_update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fires every 30 seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacter.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacter.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.DoesNotExist" title="evennia.objects.objects.DefaultCharacter.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacter.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacter.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned" title="evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacter.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.turnbattle.tb_items.TBItemsCharacter'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacter.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacter.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TBItemsCharacter'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacter.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TBItemsCharacter'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacterTest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">TBItemsCharacterTest</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsCharacterTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacterTest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacter" title="evennia.contrib.turnbattle.tb_items.TBItemsCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.turnbattle.tb_items.TBItemsCharacter</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacterTest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">TBItemsCharacterTest</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsCharacterTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacterTest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter" title="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter</span></code></a></p>
|
||||
<p>Just like the TBItemsCharacter, but doesn’t subscribe to the TickerHandler.
|
||||
This makes it easier to run unit tests on.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacterTest.at_object_creation">
|
||||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsCharacterTest.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacterTest.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacterTest.at_object_creation">
|
||||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsCharacterTest.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacterTest.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called once, when this object is first created. This is the
|
||||
normal hook to overload for most object types.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacterTest.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacterTest.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacter.DoesNotExist" title="evennia.contrib.turnbattle.tb_items.TBItemsCharacter.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.turnbattle.tb_items.TBItemsCharacter.DoesNotExist</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacterTest.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacterTest.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.DoesNotExist" title="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacterTest.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacterTest.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacter.MultipleObjectsReturned" title="evennia.contrib.turnbattle.tb_items.TBItemsCharacter.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.turnbattle.tb_items.TBItemsCharacter.MultipleObjectsReturned</span></code></a></p>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacterTest.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacterTest.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.MultipleObjectsReturned" title="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacterTest.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.turnbattle.tb_items.TBItemsCharacterTest'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacterTest.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacterTest.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacterTest'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacterTest.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsCharacterTest.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TBItemsCharacterTest'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsCharacterTest.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacterTest.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TBItemsCharacterTest'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacterTest.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">TBItemsTurnHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsTurnHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">TBItemsTurnHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsTurnHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript" title="evennia.scripts.scripts.DefaultScript"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript</span></code></a></p>
|
||||
<p>This is the script that handles the progression of combat through turns.
|
||||
On creation (when a fight is started) it adds all combat-ready characters
|
||||
|
|
@ -519,26 +519,26 @@ room as its object.</p>
|
|||
<p>Fights persist until only one participant is left with any HP or all
|
||||
remaining participants choose to end the combat with the ‘disengage’ command.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsTurnHandler.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsTurnHandler.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called once, when the script is created.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.at_stop">
|
||||
<code class="sig-name descname">at_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsTurnHandler.at_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.at_stop" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.at_stop">
|
||||
<code class="sig-name descname">at_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsTurnHandler.at_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.at_stop" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called at script termination.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.at_repeat">
|
||||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsTurnHandler.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.at_repeat">
|
||||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsTurnHandler.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called once every self.interval seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.initialize_for_combat">
|
||||
<code class="sig-name descname">initialize_for_combat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsTurnHandler.initialize_for_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.initialize_for_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.initialize_for_combat">
|
||||
<code class="sig-name descname">initialize_for_combat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsTurnHandler.initialize_for_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.initialize_for_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Prepares a character for combat when starting or entering a fight.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -548,8 +548,8 @@ remaining participants choose to end the combat with the ‘disengage’ command
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.start_turn">
|
||||
<code class="sig-name descname">start_turn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsTurnHandler.start_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.start_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.start_turn">
|
||||
<code class="sig-name descname">start_turn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsTurnHandler.start_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.start_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Readies a character for the start of their turn by replenishing their
|
||||
available actions and notifying them that their turn has come up.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -566,14 +566,14 @@ something similar.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.next_turn">
|
||||
<code class="sig-name descname">next_turn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsTurnHandler.next_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.next_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.next_turn">
|
||||
<code class="sig-name descname">next_turn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsTurnHandler.next_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.next_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Advances to the next character in the turn order.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.turn_end_check">
|
||||
<code class="sig-name descname">turn_end_check</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsTurnHandler.turn_end_check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.turn_end_check" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.turn_end_check">
|
||||
<code class="sig-name descname">turn_end_check</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsTurnHandler.turn_end_check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.turn_end_check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Tests to see if a character’s turn is over, and cycles to the next turn if it is.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -583,8 +583,8 @@ something similar.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.join_fight">
|
||||
<code class="sig-name descname">join_fight</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#TBItemsTurnHandler.join_fight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.join_fight" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.join_fight">
|
||||
<code class="sig-name descname">join_fight</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#TBItemsTurnHandler.join_fight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.join_fight" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a new character to a fight already in progress.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -594,32 +594,32 @@ something similar.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.DoesNotExist" title="evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TBItemsTurnHandler'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.TBItemsTurnHandler.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TBItemsTurnHandler'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsTurnHandler.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdFight">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">CmdFight</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#CmdFight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdFight" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdFight">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">CmdFight</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#CmdFight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdFight" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Starts a fight with everyone in the same room as you.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -630,41 +630,41 @@ something similar.</p>
|
|||
fight is added to combat, and a turn order is randomly rolled.
|
||||
When it’s your turn, you can attack other characters.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdFight.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'fight'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdFight.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdFight.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'fight'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdFight.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdFight.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdFight.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdFight.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdFight.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdFight.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#CmdFight.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdFight.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdFight.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#CmdFight.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdFight.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdFight.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdFight.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdFight.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdFight.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdFight.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdFight.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdFight.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdFight.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdFight.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'fight', 'no_prefix': ' ', 'tags': '', 'text': "\n Starts a fight with everyone in the same room as you.\n\n Usage:\n fight\n\n When you start a fight, everyone in the room who is able to\n fight is added to combat, and a turn order is randomly rolled.\n When it's your turn, you can attack other characters.\n "}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdFight.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdFight.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'fight', 'no_prefix': ' ', 'tags': '', 'text': "\n Starts a fight with everyone in the same room as you.\n\n Usage:\n fight\n\n When you start a fight, everyone in the room who is able to\n fight is added to combat, and a turn order is randomly rolled.\n When it's your turn, you can attack other characters.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdFight.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdAttack">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">CmdAttack</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#CmdAttack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdAttack" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdAttack">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">CmdAttack</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#CmdAttack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdAttack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Attacks another character.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -674,41 +674,41 @@ When it’s your turn, you can attack other characters.</p>
|
|||
<p>When in a fight, you may attack another character. The attack has
|
||||
a chance to hit, and if successful, will deal damage.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdAttack.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'attack'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdAttack.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdAttack.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'attack'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdAttack.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdAttack.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdAttack.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdAttack.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdAttack.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdAttack.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#CmdAttack.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdAttack.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdAttack.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#CmdAttack.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdAttack.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdAttack.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdAttack.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdAttack.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdAttack.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdAttack.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdAttack.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdAttack.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdAttack.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdAttack.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'attack', 'no_prefix': ' ', 'tags': '', 'text': '\n Attacks another character.\n\n Usage:\n attack <target>\n\n When in a fight, you may attack another character. The attack has\n a chance to hit, and if successful, will deal damage.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdAttack.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdAttack.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'attack', 'no_prefix': ' ', 'tags': '', 'text': '\n Attacks another character.\n\n Usage:\n attack <target>\n\n When in a fight, you may attack another character. The attack has\n a chance to hit, and if successful, will deal damage.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdAttack.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdPass">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">CmdPass</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#CmdPass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdPass" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdPass">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">CmdPass</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#CmdPass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Passes on your turn.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -718,41 +718,41 @@ a chance to hit, and if successful, will deal damage.</p>
|
|||
<p>When in a fight, you can use this command to end your turn early, even
|
||||
if there are still any actions you can take.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdPass.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'pass'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdPass.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'pass'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdPass.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdPass.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdPass.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#CmdPass.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdPass.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#CmdPass.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdPass.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdPass.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdPass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdDisengage">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">CmdDisengage</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#CmdDisengage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdDisengage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdDisengage">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">CmdDisengage</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#CmdDisengage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdDisengage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Passes your turn and attempts to end combat.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -763,41 +763,41 @@ if there are still any actions you can take.</p>
|
|||
the fight. If all participants in a fight disengage, the
|
||||
fight ends.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdDisengage.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'disengage'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdDisengage.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdDisengage.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'disengage'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdDisengage.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdDisengage.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['spare']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdDisengage.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdDisengage.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['spare']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdDisengage.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdDisengage.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdDisengage.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdDisengage.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdDisengage.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdDisengage.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#CmdDisengage.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdDisengage.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdDisengage.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#CmdDisengage.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdDisengage.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdDisengage.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdDisengage.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdDisengage.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdDisengage.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdDisengage.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'spare', 'category': 'combat', 'key': 'disengage', 'no_prefix': ' spare', 'tags': '', 'text': "\n Passes your turn and attempts to end combat.\n\n Usage:\n disengage\n\n Ends your turn early and signals that you're trying to end\n the fight. If all participants in a fight disengage, the\n fight ends.\n "}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdDisengage.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdDisengage.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'spare', 'category': 'combat', 'key': 'disengage', 'no_prefix': ' spare', 'tags': '', 'text': "\n Passes your turn and attempts to end combat.\n\n Usage:\n disengage\n\n Ends your turn early and signals that you're trying to end\n the fight. If all participants in a fight disengage, the\n fight ends.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdDisengage.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdRest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">CmdRest</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#CmdRest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdRest" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdRest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">CmdRest</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#CmdRest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdRest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Recovers damage.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -807,41 +807,41 @@ fight ends.</p>
|
|||
<p>Resting recovers your HP to its maximum, but you can only
|
||||
rest if you’re not in a fight.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdRest.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'rest'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdRest.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdRest.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'rest'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdRest.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdRest.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdRest.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdRest.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdRest.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdRest.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#CmdRest.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdRest.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdRest.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#CmdRest.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdRest.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdRest.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdRest.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdRest.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdRest.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdRest.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdRest.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdRest.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdRest.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdRest.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'rest', 'no_prefix': ' ', 'tags': '', 'text': "\n Recovers damage.\n\n Usage:\n rest\n\n Resting recovers your HP to its maximum, but you can only\n rest if you're not in a fight.\n "}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdRest.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdRest.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'rest', 'no_prefix': ' ', 'tags': '', 'text': "\n Recovers damage.\n\n Usage:\n rest\n\n Resting recovers your HP to its maximum, but you can only\n rest if you're not in a fight.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdRest.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdCombatHelp">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">CmdCombatHelp</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#CmdCombatHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdCombatHelp" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdCombatHelp">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">CmdCombatHelp</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#CmdCombatHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdCombatHelp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.help.html#evennia.commands.default.help.CmdHelp" title="evennia.commands.default.help.CmdHelp"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.help.CmdHelp</span></code></a></p>
|
||||
<p>View help or a list of topics</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -853,41 +853,41 @@ help all</p>
|
|||
<p>This will search for help on commands and other
|
||||
topics related to the game.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdCombatHelp.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#CmdCombatHelp.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdCombatHelp.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdCombatHelp.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#CmdCombatHelp.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdCombatHelp.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Run the dynamic help entry creator.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdCombatHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdCombatHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdCombatHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdCombatHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdCombatHelp.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdCombatHelp.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdCombatHelp.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdCombatHelp.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdCombatHelp.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'help'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdCombatHelp.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdCombatHelp.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'help'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdCombatHelp.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdCombatHelp.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdCombatHelp.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdCombatHelp.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdCombatHelp.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdCombatHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '?', 'category': 'general', 'key': 'help', 'no_prefix': ' ?', 'tags': '', 'text': '\n View help or a list of topics\n\n Usage:\n help <topic or command>\n help list\n help all\n\n This will search for help on commands and other\n topics related to the game.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdCombatHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdCombatHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '?', 'category': 'general', 'key': 'help', 'no_prefix': ' ?', 'tags': '', 'text': '\n View help or a list of topics\n\n Usage:\n help <topic or command>\n help list\n help all\n\n This will search for help on commands and other\n topics related to the game.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdCombatHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdUse">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">CmdUse</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#CmdUse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdUse" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdUse">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">CmdUse</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#CmdUse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdUse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Use an item.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -898,64 +898,64 @@ topics related to the game.</p>
|
|||
provide information as to its effects. Some items can be used
|
||||
to attack others, and as such can only be used in combat.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdUse.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'use'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdUse.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdUse.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'use'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdUse.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdUse.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdUse.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdUse.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdUse.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdUse.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#CmdUse.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdUse.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdUse.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#CmdUse.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdUse.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdUse.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdUse.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdUse.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdUse.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdUse.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdUse.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdUse.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdUse.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.CmdUse.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'use', 'no_prefix': ' ', 'tags': '', 'text': '\n Use an item.\n\n Usage:\n use <item> [= target]\n\n An item can have various function - looking at the item may\n provide information as to its effects. Some items can be used\n to attack others, and as such can only be used in combat.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdUse.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdUse.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'use', 'no_prefix': ' ', 'tags': '', 'text': '\n Use an item.\n\n Usage:\n use <item> [= target]\n\n An item can have various function - looking at the item may\n provide information as to its effects. Some items can be used\n to attack others, and as such can only be used in combat.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdUse.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.BattleCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">BattleCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#BattleCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.BattleCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.BattleCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">BattleCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#BattleCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.BattleCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.cmdset_character.html#evennia.commands.default.cmdset_character.CharacterCmdSet" title="evennia.commands.default.cmdset_character.CharacterCmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.cmdset_character.CharacterCmdSet</span></code></a></p>
|
||||
<p>This command set includes all the commmands used in the battle system.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.BattleCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'DefaultCharacter'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.BattleCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.BattleCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'DefaultCharacter'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.BattleCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.BattleCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#BattleCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.BattleCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.BattleCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#BattleCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.BattleCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Populates the cmdset</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.BattleCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.turnbattle.tb_items.BattleCmdSet'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.BattleCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.BattleCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.turnbattle.tb_items.BattleCmdSet'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.BattleCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.itemfunc_heal">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">itemfunc_heal</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em>, <em class="sig-param"><span class="n">user</span></em>, <em class="sig-param"><span class="n">target</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#itemfunc_heal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.itemfunc_heal" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.itemfunc_heal">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">itemfunc_heal</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em>, <em class="sig-param"><span class="n">user</span></em>, <em class="sig-param"><span class="n">target</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#itemfunc_heal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.itemfunc_heal" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Item function that heals HP.</p>
|
||||
<dl class="simple">
|
||||
<dt>kwargs:</dt><dd><p>min_healing(int): Minimum amount of HP recovered
|
||||
|
|
@ -965,8 +965,8 @@ max_healing(int): Maximum amount of HP recovered</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.itemfunc_add_condition">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">itemfunc_add_condition</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em>, <em class="sig-param"><span class="n">user</span></em>, <em class="sig-param"><span class="n">target</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#itemfunc_add_condition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.itemfunc_add_condition" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.itemfunc_add_condition">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">itemfunc_add_condition</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em>, <em class="sig-param"><span class="n">user</span></em>, <em class="sig-param"><span class="n">target</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#itemfunc_add_condition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.itemfunc_add_condition" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Item function that gives the target one or more conditions.</p>
|
||||
<dl class="simple">
|
||||
<dt>kwargs:</dt><dd><dl class="simple">
|
||||
|
|
@ -981,8 +981,8 @@ for an item that can give an enemy a harmful condition.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.itemfunc_cure_condition">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">itemfunc_cure_condition</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em>, <em class="sig-param"><span class="n">user</span></em>, <em class="sig-param"><span class="n">target</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#itemfunc_cure_condition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.itemfunc_cure_condition" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.itemfunc_cure_condition">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">itemfunc_cure_condition</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em>, <em class="sig-param"><span class="n">user</span></em>, <em class="sig-param"><span class="n">target</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#itemfunc_cure_condition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.itemfunc_cure_condition" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Item function that’ll remove given conditions from a target.</p>
|
||||
<dl class="simple">
|
||||
<dt>kwargs:</dt><dd><p>to_cure(list): List of conditions (str) that the item cures when used</p>
|
||||
|
|
@ -991,8 +991,8 @@ for an item that can give an enemy a harmful condition.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.itemfunc_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">itemfunc_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em>, <em class="sig-param"><span class="n">user</span></em>, <em class="sig-param"><span class="n">target</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_items.html#itemfunc_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.itemfunc_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.itemfunc_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">itemfunc_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">item</span></em>, <em class="sig-param"><span class="n">user</span></em>, <em class="sig-param"><span class="n">target</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_items.html#itemfunc_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.itemfunc_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Item function that attacks a target.</p>
|
||||
<dl>
|
||||
<dt>kwargs:</dt><dd><p>min_damage(int): Minimum damage dealt by the attack
|
||||
|
|
@ -1010,8 +1010,8 @@ and duration.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py data">
|
||||
<dt id="evennia.contrib.turnbattle.tb_items.ITEMFUNCS">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_items.</code><code class="sig-name descname">ITEMFUNCS</code><em class="property"> = {'add_condition': <function itemfunc_add_condition>, 'attack': <function itemfunc_attack>, 'cure_condition': <function itemfunc_cure_condition>, 'heal': <function itemfunc_heal>}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.ITEMFUNCS" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.ITEMFUNCS">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_items.</code><code class="sig-name descname">ITEMFUNCS</code><em class="property"> = {'add_condition': <function itemfunc_add_condition>, 'attack': <function itemfunc_attack>, 'cure_condition': <function itemfunc_cure_condition>, 'heal': <function itemfunc_heal>}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.ITEMFUNCS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>You can paste these prototypes into your game’s prototypes.py module in your
|
||||
/world/ folder, and use the spawner to create them - they serve as examples
|
||||
of items you can make and a handy way to demonstrate the system for
|
||||
|
|
@ -1061,7 +1061,7 @@ items using the same function work differently.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.turnbattle.tb_items.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.turnbattle.tb_items.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -1077,8 +1077,8 @@ items using the same function work differently.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.turnbattle.tb_items.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.turnbattle.tb_items.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.game_systems.turnbattle.tb_items.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -1095,7 +1095,7 @@ items using the same function work differently.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.turnbattle.tb_items</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.turnbattle.tb_items</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.turnbattle.tb_magic — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.game_systems.turnbattle.tb_magic — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.turnbattle.tb_magic</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.turnbattle.tb_magic</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.turnbattle.tb_magic">
|
||||
<span id="evennia-contrib-turnbattle-tb-magic"></span><h1>evennia.contrib.turnbattle.tb_magic<a class="headerlink" href="#module-evennia.contrib.turnbattle.tb_magic" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.game_systems.turnbattle.tb_magic">
|
||||
<span id="evennia-contrib-game-systems-turnbattle-tb-magic"></span><h1>evennia.contrib.game_systems.turnbattle.tb_magic<a class="headerlink" href="#module-evennia.contrib.game_systems.turnbattle.tb_magic" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Simple turn-based combat system with spell casting</p>
|
||||
<p>Contrib - Tim Ashley Jenkins 2017</p>
|
||||
<p>This is a version of the ‘turnbattle’ contrib that includes a basic,
|
||||
|
|
@ -73,7 +73,7 @@ or whatever else your game requires.</p>
|
|||
<p>To install and test, import this module’s TBMagicCharacter object into
|
||||
your game’s character.py module:</p>
|
||||
<blockquote>
|
||||
<div><p>from evennia.contrib.turnbattle.tb_magic import TBMagicCharacter</p>
|
||||
<div><p>from evennia.contrib.game_systems.turnbattle.tb_magic import TBMagicCharacter</p>
|
||||
</div></blockquote>
|
||||
<p>And change your game’s character typeclass to inherit from TBMagicCharacter
|
||||
instead of the default:</p>
|
||||
|
|
@ -86,7 +86,7 @@ Use <strong>update self</strong> to try on yourself or use py to call <strong>at
|
|||
on all existing Characters.</p>
|
||||
<p>Next, import this module into your default_cmdsets.py module:</p>
|
||||
<blockquote>
|
||||
<div><p>from evennia.contrib.turnbattle import tb_magic</p>
|
||||
<div><p>from evennia.contrib.game_systems.turnbattle import tb_magic</p>
|
||||
</div></blockquote>
|
||||
<p>And add the battle command set to your default command set:</p>
|
||||
<blockquote>
|
||||
|
|
@ -99,13 +99,13 @@ self.add(tb_magic.BattleCmdSet())</p>
|
|||
to your game’s ‘world’ folder and modify it there rather than importing it
|
||||
in your game and using it as-is.</p>
|
||||
<dl class="py data">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.ACTIONS_PER_TURN">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">ACTIONS_PER_TURN</code><em class="property"> = 1</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.ACTIONS_PER_TURN" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.ACTIONS_PER_TURN">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">ACTIONS_PER_TURN</code><em class="property"> = 1</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.ACTIONS_PER_TURN" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.roll_init">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">roll_init</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#roll_init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.roll_init" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.roll_init">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">roll_init</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#roll_init"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.roll_init" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Rolls a number between 1-1000 to determine initiative.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -128,8 +128,8 @@ an advantage in turn order, like so:</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.get_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">get_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#get_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.get_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.get_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">get_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#get_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.get_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a value for an attack roll.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -156,8 +156,8 @@ to this function, even though nothing from either one are used in this example.<
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.get_defense">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">get_defense</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#get_defense"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.get_defense" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.get_defense">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">get_defense</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#get_defense"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.get_defense" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a value for defense, which an attack roll must equal or exceed in order
|
||||
for an attack to hit.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -183,8 +183,8 @@ attacker into account.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.get_damage">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">get_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#get_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.get_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.get_damage">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">get_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#get_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.get_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns a value for damage to be deducted from the defender’s HP after abilities
|
||||
successful hit.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -210,8 +210,8 @@ properties from either the attacker or defender.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.apply_damage">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">apply_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">damage</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#apply_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.apply_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.apply_damage">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">apply_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">damage</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#apply_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.apply_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Applies damage to a target, reducing their HP by the damage amount to a
|
||||
minimum of 0.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -225,8 +225,8 @@ minimum of 0.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.at_defeat">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">at_defeat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defeated</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#at_defeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.at_defeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.at_defeat">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">at_defeat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defeated</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#at_defeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.at_defeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Announces the defeat of a fighter in combat.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -241,8 +241,8 @@ do it.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.resolve_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">resolve_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">attack_value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">defense_value</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#resolve_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.resolve_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.resolve_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">resolve_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attacker</span></em>, <em class="sig-param"><span class="n">defender</span></em>, <em class="sig-param"><span class="n">attack_value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">defense_value</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#resolve_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.resolve_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Resolves an attack and outputs the result.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -259,8 +259,8 @@ so that they are easier to expand upon.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.combat_cleanup">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">combat_cleanup</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#combat_cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.combat_cleanup" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.combat_cleanup">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">combat_cleanup</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#combat_cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.combat_cleanup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cleans up all the temporary combat-related attributes on a character.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -273,8 +273,8 @@ longer needed once a fight ends.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.is_in_combat">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">is_in_combat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#is_in_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.is_in_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.is_in_combat">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">is_in_combat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#is_in_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.is_in_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns true if the given character is in combat.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -287,8 +287,8 @@ longer needed once a fight ends.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.is_turn">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">is_turn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#is_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.is_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.is_turn">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">is_turn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#is_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.is_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns true if it’s currently the given character’s turn in combat.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -301,8 +301,8 @@ longer needed once a fight ends.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.spend_action">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">spend_action</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">actions</span></em>, <em class="sig-param"><span class="n">action_name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#spend_action"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.spend_action" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.spend_action">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">spend_action</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em>, <em class="sig-param"><span class="n">actions</span></em>, <em class="sig-param"><span class="n">action_name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#spend_action"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.spend_action" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Spends a character’s available combat actions and checks for end of turn.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -321,14 +321,14 @@ longer needed once a fight ends.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicCharacter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">TBMagicCharacter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#TBMagicCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicCharacter" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">TBMagicCharacter</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter" title="evennia.objects.objects.DefaultCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter</span></code></a></p>
|
||||
<p>A character able to participate in turn-based combat. Has attributes for current
|
||||
and maximum HP, and access to combat commands.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicCharacter.at_object_creation">
|
||||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#TBMagicCharacter.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicCharacter.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.at_object_creation">
|
||||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicCharacter.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called once, when this object is first created. This is the
|
||||
normal hook to overload for most object types.</p>
|
||||
<p>Adds attributes for a character’s current and maximum HP.
|
||||
|
|
@ -338,8 +338,8 @@ can be changed at creation and factor into combat calculations.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicCharacter.at_pre_move">
|
||||
<code class="sig-name descname">at_pre_move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">destination</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#TBMagicCharacter.at_pre_move"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicCharacter.at_pre_move" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.at_pre_move">
|
||||
<code class="sig-name descname">at_pre_move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">destination</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicCharacter.at_pre_move"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.at_pre_move" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called just before starting to move this object to
|
||||
destination.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -356,32 +356,32 @@ before it is even started.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicCharacter.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicCharacter.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.DoesNotExist" title="evennia.objects.objects.DefaultCharacter.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicCharacter.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicCharacter.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned" title="evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicCharacter.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.turnbattle.tb_magic.TBMagicCharacter'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicCharacter.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicCharacter.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TBMagicCharacter'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicCharacter.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TBMagicCharacter'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicCharacter.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">TBMagicTurnHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#TBMagicTurnHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">TBMagicTurnHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicTurnHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript" title="evennia.scripts.scripts.DefaultScript"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript</span></code></a></p>
|
||||
<p>This is the script that handles the progression of combat through turns.
|
||||
On creation (when a fight is started) it adds all combat-ready characters
|
||||
|
|
@ -391,26 +391,26 @@ room as its object.</p>
|
|||
<p>Fights persist until only one participant is left with any HP or all
|
||||
remaining participants choose to end the combat with the ‘disengage’ command.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#TBMagicTurnHandler.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.at_script_creation">
|
||||
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicTurnHandler.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called once, when the script is created.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.at_stop">
|
||||
<code class="sig-name descname">at_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#TBMagicTurnHandler.at_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.at_stop" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.at_stop">
|
||||
<code class="sig-name descname">at_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicTurnHandler.at_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.at_stop" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called at script termination.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.at_repeat">
|
||||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#TBMagicTurnHandler.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.at_repeat">
|
||||
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicTurnHandler.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called once every self.interval seconds.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.initialize_for_combat">
|
||||
<code class="sig-name descname">initialize_for_combat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#TBMagicTurnHandler.initialize_for_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.initialize_for_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.initialize_for_combat">
|
||||
<code class="sig-name descname">initialize_for_combat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicTurnHandler.initialize_for_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.initialize_for_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Prepares a character for combat when starting or entering a fight.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -420,8 +420,8 @@ remaining participants choose to end the combat with the ‘disengage’ command
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.start_turn">
|
||||
<code class="sig-name descname">start_turn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#TBMagicTurnHandler.start_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.start_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.start_turn">
|
||||
<code class="sig-name descname">start_turn</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicTurnHandler.start_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.start_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Readies a character for the start of their turn by replenishing their
|
||||
available actions and notifying them that their turn has come up.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -438,14 +438,14 @@ something similar.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.next_turn">
|
||||
<code class="sig-name descname">next_turn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#TBMagicTurnHandler.next_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.next_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.next_turn">
|
||||
<code class="sig-name descname">next_turn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicTurnHandler.next_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.next_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Advances to the next character in the turn order.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.turn_end_check">
|
||||
<code class="sig-name descname">turn_end_check</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#TBMagicTurnHandler.turn_end_check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.turn_end_check" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.turn_end_check">
|
||||
<code class="sig-name descname">turn_end_check</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicTurnHandler.turn_end_check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.turn_end_check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Tests to see if a character’s turn is over, and cycles to the next turn if it is.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -455,8 +455,8 @@ something similar.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.join_fight">
|
||||
<code class="sig-name descname">join_fight</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#TBMagicTurnHandler.join_fight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.join_fight" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.join_fight">
|
||||
<code class="sig-name descname">join_fight</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">character</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#TBMagicTurnHandler.join_fight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.join_fight" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds a new character to a fight already in progress.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -466,32 +466,32 @@ something similar.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.DoesNotExist" title="evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TBMagicTurnHandler'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.TBMagicTurnHandler.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'TBMagicTurnHandler'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.TBMagicTurnHandler.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdFight">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">CmdFight</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdFight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdFight" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">CmdFight</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdFight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Starts a fight with everyone in the same room as you.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -502,41 +502,41 @@ something similar.</p>
|
|||
fight is added to combat, and a turn order is randomly rolled.
|
||||
When it’s your turn, you can attack other characters.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdFight.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'fight'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdFight.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'fight'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdFight.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdFight.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdFight.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdFight.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdFight.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdFight.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdFight.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdFight.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdFight.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdFight.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdFight.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'fight', 'no_prefix': ' ', 'tags': '', 'text': "\n Starts a fight with everyone in the same room as you.\n\n Usage:\n fight\n\n When you start a fight, everyone in the room who is able to\n fight is added to combat, and a turn order is randomly rolled.\n When it's your turn, you can attack other characters.\n "}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdFight.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'fight', 'no_prefix': ' ', 'tags': '', 'text': "\n Starts a fight with everyone in the same room as you.\n\n Usage:\n fight\n\n When you start a fight, everyone in the room who is able to\n fight is added to combat, and a turn order is randomly rolled.\n When it's your turn, you can attack other characters.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdFight.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdAttack">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">CmdAttack</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdAttack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdAttack" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">CmdAttack</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdAttack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Attacks another character.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -546,41 +546,41 @@ When it’s your turn, you can attack other characters.</p>
|
|||
<p>When in a fight, you may attack another character. The attack has
|
||||
a chance to hit, and if successful, will deal damage.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdAttack.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'attack'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdAttack.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'attack'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdAttack.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdAttack.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdAttack.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdAttack.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdAttack.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdAttack.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdAttack.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdAttack.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdAttack.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdAttack.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdAttack.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'attack', 'no_prefix': ' ', 'tags': '', 'text': '\n Attacks another character.\n\n Usage:\n attack <target>\n\n When in a fight, you may attack another character. The attack has\n a chance to hit, and if successful, will deal damage.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdAttack.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'attack', 'no_prefix': ' ', 'tags': '', 'text': '\n Attacks another character.\n\n Usage:\n attack <target>\n\n When in a fight, you may attack another character. The attack has\n a chance to hit, and if successful, will deal damage.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdAttack.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdPass">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">CmdPass</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdPass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdPass" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">CmdPass</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdPass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Passes on your turn.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -590,41 +590,41 @@ a chance to hit, and if successful, will deal damage.</p>
|
|||
<p>When in a fight, you can use this command to end your turn early, even
|
||||
if there are still any actions you can take.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdPass.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'pass'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdPass.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'pass'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdPass.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdPass.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdPass.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdPass.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdPass.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdPass.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdPass.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdPass.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdPass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdDisengage">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">CmdDisengage</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdDisengage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdDisengage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">CmdDisengage</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdDisengage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Passes your turn and attempts to end combat.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -635,41 +635,41 @@ if there are still any actions you can take.</p>
|
|||
the fight. If all participants in a fight disengage, the
|
||||
fight ends.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdDisengage.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'disengage'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdDisengage.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'disengage'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdDisengage.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['spare']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdDisengage.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['spare']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdDisengage.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdDisengage.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdDisengage.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdDisengage.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdDisengage.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdDisengage.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdDisengage.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdDisengage.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdDisengage.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'spare', 'category': 'combat', 'key': 'disengage', 'no_prefix': ' spare', 'tags': '', 'text': "\n Passes your turn and attempts to end combat.\n\n Usage:\n disengage\n\n Ends your turn early and signals that you're trying to end\n the fight. If all participants in a fight disengage, the\n fight ends.\n "}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdDisengage.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'spare', 'category': 'combat', 'key': 'disengage', 'no_prefix': ' spare', 'tags': '', 'text': "\n Passes your turn and attempts to end combat.\n\n Usage:\n disengage\n\n Ends your turn early and signals that you're trying to end\n the fight. If all participants in a fight disengage, the\n fight ends.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdDisengage.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdLearnSpell">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">CmdLearnSpell</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdLearnSpell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdLearnSpell" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">CmdLearnSpell</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdLearnSpell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Learn a magic spell.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -693,41 +693,41 @@ fight ends.</p>
|
|||
<p><a href="#id11"><span class="problematic" id="id12">|</span></a>wcactus conjuration|n (2 MP): Creates a cactus.</p>
|
||||
</div></blockquote>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdLearnSpell.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'learnspell'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdLearnSpell.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'learnspell'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdLearnSpell.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'magic'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdLearnSpell.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'magic'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdLearnSpell.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdLearnSpell.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdLearnSpell.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdLearnSpell.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdLearnSpell.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdLearnSpell.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdLearnSpell.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdLearnSpell.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdLearnSpell.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'magic', 'key': 'learnspell', 'no_prefix': ' ', 'tags': '', 'text': "\n Learn a magic spell.\n\n Usage:\n learnspell <spell name>\n\n Adds a spell by name to your list of spells known.\n\n The following spells are provided as examples:\n\n |wmagic missile|n (3 MP): Fires three missiles that never miss. Can target\n up to three different enemies.\n\n |wflame shot|n (3 MP): Shoots a high-damage jet of flame at one target.\n\n |wcure wounds|n (5 MP): Heals damage on one target.\n\n |wmass cure wounds|n (10 MP): Like 'cure wounds', but can heal up to 5\n targets at once.\n\n |wfull heal|n (12 MP): Heals one target back to full HP.\n\n |wcactus conjuration|n (2 MP): Creates a cactus.\n "}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdLearnSpell.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'magic', 'key': 'learnspell', 'no_prefix': ' ', 'tags': '', 'text': "\n Learn a magic spell.\n\n Usage:\n learnspell <spell name>\n\n Adds a spell by name to your list of spells known.\n\n The following spells are provided as examples:\n\n |wmagic missile|n (3 MP): Fires three missiles that never miss. Can target\n up to three different enemies.\n\n |wflame shot|n (3 MP): Shoots a high-damage jet of flame at one target.\n\n |wcure wounds|n (5 MP): Heals damage on one target.\n\n |wmass cure wounds|n (10 MP): Like 'cure wounds', but can heal up to 5\n targets at once.\n\n |wfull heal|n (12 MP): Heals one target back to full HP.\n\n |wcactus conjuration|n (2 MP): Creates a cactus.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdLearnSpell.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdCast">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">CmdCast</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdCast"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdCast" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">CmdCast</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdCast"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Cast a magic spell that you know, provided you have the MP
|
||||
to spend on its casting.</p>
|
||||
|
|
@ -739,18 +739,18 @@ to spend on its casting.</p>
|
|||
on only yourself, and some don’t need a target specified at all.
|
||||
Typing ‘cast’ by itself will give you a list of spells you know.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdCast.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'cast'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdCast.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'cast'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdCast.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'magic'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdCast.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'magic'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdCast.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdCast.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdCast.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdCast.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
<p>Note: This is a quite long command, since it has to cope with all
|
||||
the different circumstances in which you may or may not be able
|
||||
|
|
@ -761,25 +761,25 @@ function.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdCast.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdCast.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdCast.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdCast.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdCast.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'magic', 'key': 'cast', 'no_prefix': ' ', 'tags': '', 'text': "\n Cast a magic spell that you know, provided you have the MP\n to spend on its casting.\n\n Usage:\n cast <spellname> [= <target1>, <target2>, etc...]\n\n Some spells can be cast on multiple targets, some can be cast\n on only yourself, and some don't need a target specified at all.\n Typing 'cast' by itself will give you a list of spells you know.\n "}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdCast.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'magic', 'key': 'cast', 'no_prefix': ' ', 'tags': '', 'text': "\n Cast a magic spell that you know, provided you have the MP\n to spend on its casting.\n\n Usage:\n cast <spellname> [= <target1>, <target2>, etc...]\n\n Some spells can be cast on multiple targets, some can be cast\n on only yourself, and some don't need a target specified at all.\n Typing 'cast' by itself will give you a list of spells you know.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCast.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdRest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">CmdRest</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdRest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdRest" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">CmdRest</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdRest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Recovers damage and restores MP.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -789,41 +789,41 @@ function.</p>
|
|||
<p>Resting recovers your HP and MP to their maximum, but you can
|
||||
only rest if you’re not in a fight.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdRest.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'rest'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdRest.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'rest'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdRest.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdRest.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdRest.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdRest.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdRest.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdRest.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdRest.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdRest.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdRest.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdRest.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdRest.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'rest', 'no_prefix': ' ', 'tags': '', 'text': "\n Recovers damage and restores MP.\n\n Usage:\n rest\n\n Resting recovers your HP and MP to their maximum, but you can\n only rest if you're not in a fight.\n "}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdRest.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'rest', 'no_prefix': ' ', 'tags': '', 'text': "\n Recovers damage and restores MP.\n\n Usage:\n rest\n\n Resting recovers your HP and MP to their maximum, but you can\n only rest if you're not in a fight.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdRest.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdStatus">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">CmdStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">CmdStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||||
<p>Gives combat information.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -833,41 +833,41 @@ only rest if you’re not in a fight.</p>
|
|||
<p>Shows your current and maximum HP and your distance from
|
||||
other targets in combat.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdStatus.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'status'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdStatus.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'status'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdStatus.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdStatus.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'combat'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdStatus.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdStatus.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdStatus.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdStatus.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This performs the actual command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdStatus.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdStatus.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdStatus.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdStatus.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdStatus.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'status', 'no_prefix': ' ', 'tags': '', 'text': '\n Gives combat information.\n\n Usage:\n status\n\n Shows your current and maximum HP and your distance from\n other targets in combat.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdStatus.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'combat', 'key': 'status', 'no_prefix': ' ', 'tags': '', 'text': '\n Gives combat information.\n\n Usage:\n status\n\n Shows your current and maximum HP and your distance from\n other targets in combat.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdStatus.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdCombatHelp">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">CmdCombatHelp</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdCombatHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdCombatHelp" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">CmdCombatHelp</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdCombatHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.help.html#evennia.commands.default.help.CmdHelp" title="evennia.commands.default.help.CmdHelp"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.help.CmdHelp</span></code></a></p>
|
||||
<p>View help or a list of topics</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -879,64 +879,64 @@ help all</p>
|
|||
<p>This will search for help on commands and other
|
||||
topics related to the game.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdCombatHelp.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#CmdCombatHelp.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdCombatHelp.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#CmdCombatHelp.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Run the dynamic help entry creator.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdCombatHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdCombatHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdCombatHelp.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdCombatHelp.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdCombatHelp.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'help'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdCombatHelp.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'help'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdCombatHelp.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdCombatHelp.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.CmdCombatHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '?', 'category': 'general', 'key': 'help', 'no_prefix': ' ?', 'tags': '', 'text': '\n View help or a list of topics\n\n Usage:\n help <topic or command>\n help list\n help all\n\n This will search for help on commands and other\n topics related to the game.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdCombatHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '?', 'category': 'general', 'key': 'help', 'no_prefix': ' ?', 'tags': '', 'text': '\n View help or a list of topics\n\n Usage:\n help <topic or command>\n help list\n help all\n\n This will search for help on commands and other\n topics related to the game.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdCombatHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.BattleCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">BattleCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#BattleCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.BattleCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.BattleCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">BattleCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#BattleCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.BattleCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.cmdset_character.html#evennia.commands.default.cmdset_character.CharacterCmdSet" title="evennia.commands.default.cmdset_character.CharacterCmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.cmdset_character.CharacterCmdSet</span></code></a></p>
|
||||
<p>This command set includes all the commmands used in the battle system.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.BattleCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'DefaultCharacter'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.BattleCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.BattleCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'DefaultCharacter'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.BattleCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.BattleCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#BattleCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.BattleCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.BattleCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#BattleCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.BattleCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Populates the cmdset</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.BattleCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.turnbattle.tb_magic.BattleCmdSet'</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.BattleCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.BattleCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.game_systems.turnbattle.tb_magic.BattleCmdSet'</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.BattleCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.spell_healing">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">spell_healing</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caster</span></em>, <em class="sig-param"><span class="n">spell_name</span></em>, <em class="sig-param"><span class="n">targets</span></em>, <em class="sig-param"><span class="n">cost</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#spell_healing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.spell_healing" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.spell_healing">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">spell_healing</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caster</span></em>, <em class="sig-param"><span class="n">spell_name</span></em>, <em class="sig-param"><span class="n">targets</span></em>, <em class="sig-param"><span class="n">cost</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#spell_healing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.spell_healing" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Spell that restores HP to a target or targets.</p>
|
||||
<dl class="simple">
|
||||
<dt>kwargs:</dt><dd><dl class="simple">
|
||||
|
|
@ -948,8 +948,8 @@ topics related to the game.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.spell_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">spell_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caster</span></em>, <em class="sig-param"><span class="n">spell_name</span></em>, <em class="sig-param"><span class="n">targets</span></em>, <em class="sig-param"><span class="n">cost</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#spell_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.spell_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.spell_attack">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">spell_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caster</span></em>, <em class="sig-param"><span class="n">spell_name</span></em>, <em class="sig-param"><span class="n">targets</span></em>, <em class="sig-param"><span class="n">cost</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#spell_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.spell_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Spell that deals damage in combat. Similar to resolve_attack.</p>
|
||||
<dl class="simple">
|
||||
<dt>kwargs:</dt><dd><dl class="simple">
|
||||
|
|
@ -971,8 +971,8 @@ attacked once.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.turnbattle.tb_magic.spell_conjure">
|
||||
<code class="sig-prename descclassname">evennia.contrib.turnbattle.tb_magic.</code><code class="sig-name descname">spell_conjure</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caster</span></em>, <em class="sig-param"><span class="n">spell_name</span></em>, <em class="sig-param"><span class="n">targets</span></em>, <em class="sig-param"><span class="n">cost</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/turnbattle/tb_magic.html#spell_conjure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.spell_conjure" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.spell_conjure">
|
||||
<code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tb_magic.</code><code class="sig-name descname">spell_conjure</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caster</span></em>, <em class="sig-param"><span class="n">spell_name</span></em>, <em class="sig-param"><span class="n">targets</span></em>, <em class="sig-param"><span class="n">cost</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tb_magic.html#spell_conjure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.spell_conjure" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Spell that creates an object.</p>
|
||||
<dl class="simple">
|
||||
<dt>kwargs:</dt><dd><p>obj_key (str): Key of the created object.
|
||||
|
|
@ -1010,7 +1010,7 @@ instead of creating objects directly.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.turnbattle.tb_magic.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.turnbattle.tb_magic.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -1026,8 +1026,8 @@ instead of creating objects directly.</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.turnbattle.tb_magic.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.turnbattle.tb_magic.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.game_systems.turnbattle.tb_magic.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -1044,7 +1044,7 @@ instead of creating objects directly.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.turnbattle.tb_magic</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.turnbattle.tb_magic</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -0,0 +1,296 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.game_systems.turnbattle.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.turnbattle.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.game_systems.turnbattle.tests">
|
||||
<span id="evennia-contrib-game-systems-turnbattle-tests"></span><h1>evennia.contrib.game_systems.turnbattle.tests<a class="headerlink" href="#module-evennia.contrib.game_systems.turnbattle.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Turnbattle tests.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleBasicCmd">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tests.</code><code class="sig-name descname">TestTurnBattleBasicCmd</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleBasicCmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleBasicCmd" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleBasicCmd.test_turnbattlecmd">
|
||||
<code class="sig-name descname">test_turnbattlecmd</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleBasicCmd.test_turnbattlecmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleBasicCmd.test_turnbattlecmd" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleEquipCmd">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tests.</code><code class="sig-name descname">TestTurnBattleEquipCmd</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleEquipCmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleEquipCmd" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleEquipCmd.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleEquipCmd.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleEquipCmd.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleEquipCmd.test_turnbattleequipcmd">
|
||||
<code class="sig-name descname">test_turnbattleequipcmd</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleEquipCmd.test_turnbattleequipcmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleEquipCmd.test_turnbattleequipcmd" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleRangeCmd">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tests.</code><code class="sig-name descname">TestTurnBattleRangeCmd</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleRangeCmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleRangeCmd" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleRangeCmd.test_turnbattlerangecmd">
|
||||
<code class="sig-name descname">test_turnbattlerangecmd</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleRangeCmd.test_turnbattlerangecmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleRangeCmd.test_turnbattlerangecmd" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleItemsCmd">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tests.</code><code class="sig-name descname">TestTurnBattleItemsCmd</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleItemsCmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleItemsCmd" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleItemsCmd.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleItemsCmd.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleItemsCmd.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleItemsCmd.test_turnbattleitemcmd">
|
||||
<code class="sig-name descname">test_turnbattleitemcmd</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleItemsCmd.test_turnbattleitemcmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleItemsCmd.test_turnbattleitemcmd" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleMagicCmd">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tests.</code><code class="sig-name descname">TestTurnBattleMagicCmd</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleMagicCmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleMagicCmd" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleMagicCmd.test_turnbattlemagiccmd">
|
||||
<code class="sig-name descname">test_turnbattlemagiccmd</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleMagicCmd.test_turnbattlemagiccmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleMagicCmd.test_turnbattlemagiccmd" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleBasicFunc">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tests.</code><code class="sig-name descname">TestTurnBattleBasicFunc</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleBasicFunc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleBasicFunc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleBasicFunc.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleBasicFunc.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleBasicFunc.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleBasicFunc.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleBasicFunc.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleBasicFunc.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleBasicFunc.test_tbbasicfunc">
|
||||
<code class="sig-name descname">test_tbbasicfunc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleBasicFunc.test_tbbasicfunc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleBasicFunc.test_tbbasicfunc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleEquipFunc">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tests.</code><code class="sig-name descname">TestTurnBattleEquipFunc</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleEquipFunc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleEquipFunc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleEquipFunc.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleEquipFunc.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleEquipFunc.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleEquipFunc.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleEquipFunc.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleEquipFunc.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleEquipFunc.test_tbequipfunc">
|
||||
<code class="sig-name descname">test_tbequipfunc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleEquipFunc.test_tbequipfunc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleEquipFunc.test_tbequipfunc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleRangeFunc">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tests.</code><code class="sig-name descname">TestTurnBattleRangeFunc</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleRangeFunc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleRangeFunc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleRangeFunc.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleRangeFunc.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleRangeFunc.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleRangeFunc.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleRangeFunc.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleRangeFunc.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleRangeFunc.test_tbrangefunc">
|
||||
<code class="sig-name descname">test_tbrangefunc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleRangeFunc.test_tbrangefunc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleRangeFunc.test_tbrangefunc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleItemsFunc">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tests.</code><code class="sig-name descname">TestTurnBattleItemsFunc</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleItemsFunc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleItemsFunc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleItemsFunc.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleItemsFunc.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleItemsFunc.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleItemsFunc.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleItemsFunc.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleItemsFunc.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleItemsFunc.test_tbitemsfunc">
|
||||
<code class="sig-name descname">test_tbitemsfunc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleItemsFunc.test_tbitemsfunc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleItemsFunc.test_tbitemsfunc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleMagicFunc">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.game_systems.turnbattle.tests.</code><code class="sig-name descname">TestTurnBattleMagicFunc</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleMagicFunc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleMagicFunc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleMagicFunc.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleMagicFunc.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleMagicFunc.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleMagicFunc.tearDown">
|
||||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleMagicFunc.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleMagicFunc.tearDown" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleMagicFunc.test_tbbasicfunc">
|
||||
<code class="sig-name descname">test_tbbasicfunc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/game_systems/turnbattle/tests.html#TestTurnBattleMagicFunc.test_tbbasicfunc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tests.TestTurnBattleMagicFunc.test_tbbasicfunc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.game_systems.turnbattle.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.game_systems.turnbattle.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.turnbattle.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.extended_room — Evennia 1.0-dev documentation</title>
|
||||
<title>evennia.contrib.grid.extended_room.extended_room — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.extended_room</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.grid.extended_room.extended_room</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
|
@ -40,8 +40,8 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.extended_room">
|
||||
<span id="evennia-contrib-extended-room"></span><h1>evennia.contrib.extended_room<a class="headerlink" href="#module-evennia.contrib.extended_room" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.contrib.grid.extended_room.extended_room">
|
||||
<span id="evennia-contrib-grid-extended-room-extended-room"></span><h1>evennia.contrib.grid.extended_room.extended_room<a class="headerlink" href="#module-evennia.contrib.grid.extended_room.extended_room" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Extended Room</p>
|
||||
<p>Evennia Contribution - Griatch 2012, vincent-lg 2019</p>
|
||||
<p>This is an extended Room typeclass for Evennia. It is supported
|
||||
|
|
@ -79,7 +79,7 @@ at, without there having to be a database object created for it. The
|
|||
Details are simply stored in a dictionary on the room and if the look
|
||||
command cannot find an object match for a <strong>look <target></strong> command it
|
||||
will also look through the available details at the current location
|
||||
if applicable. The <strong>@detail</strong> command is used to change details.</p>
|
||||
if applicable. The <strong>detail</strong> command is used to change details.</p>
|
||||
<ol class="arabic simple" start="4">
|
||||
<li><p>Extra commands</p></li>
|
||||
</ol>
|
||||
|
|
@ -100,13 +100,13 @@ CmdExtendedRoomDetail - command allowing to manipulate details in this room</p>
|
|||
new commands for use.</p>
|
||||
<p>In more detail, in mygame/commands/default_cmdsets.py:</p>
|
||||
<p>…
|
||||
from evennia.contrib import extended_room # <-new</p>
|
||||
from evennia.contrib import extended_room # <—</p>
|
||||
<dl>
|
||||
<dt>class CharacterCmdset(default_cmds.Character_CmdSet):</dt><dd><p>…
|
||||
def at_cmdset_creation(self):</p>
|
||||
<blockquote>
|
||||
<div><p>…
|
||||
self.add(extended_room.ExtendedRoomCmdSet) # <-new</p>
|
||||
self.add(extended_room.ExtendedRoomCmdSet) # <—</p>
|
||||
</div></blockquote>
|
||||
</dd>
|
||||
</dl>
|
||||
|
|
@ -114,27 +114,27 @@ self.add(extended_room.ExtendedRoomCmdSet) # <-new</p>
|
|||
on rooms with the typeclass <strong>ExtendedRoom</strong>. Create new rooms with the right
|
||||
typeclass or use the <strong>typeclass</strong> command to swap existing rooms.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoom">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.extended_room.</code><code class="sig-name descname">ExtendedRoom</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#ExtendedRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoom" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoom">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.extended_room.extended_room.</code><code class="sig-name descname">ExtendedRoom</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#ExtendedRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultRoom" title="evennia.objects.objects.DefaultRoom"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultRoom</span></code></a></p>
|
||||
<p>This room implements a more advanced <strong>look</strong> functionality depending on
|
||||
time. It also allows for “details”, together with a slightly modified
|
||||
look command.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoom.at_object_creation">
|
||||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#ExtendedRoom.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoom.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.at_object_creation">
|
||||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#ExtendedRoom.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when room is first created only.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoom.get_time_and_season">
|
||||
<code class="sig-name descname">get_time_and_season</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#ExtendedRoom.get_time_and_season"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoom.get_time_and_season" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.get_time_and_season">
|
||||
<code class="sig-name descname">get_time_and_season</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#ExtendedRoom.get_time_and_season"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.get_time_and_season" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Calculate the current time and season ids.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoom.replace_timeslots">
|
||||
<code class="sig-name descname">replace_timeslots</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">raw_desc</span></em>, <em class="sig-param"><span class="n">curr_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#ExtendedRoom.replace_timeslots"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoom.replace_timeslots" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.replace_timeslots">
|
||||
<code class="sig-name descname">replace_timeslots</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">raw_desc</span></em>, <em class="sig-param"><span class="n">curr_time</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#ExtendedRoom.replace_timeslots"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.replace_timeslots" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Filter so that only time markers <strong><timeslot>…</timeslot></strong> of
|
||||
the correct timeslot remains in the description.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -151,8 +151,8 @@ the correct timeslot remains in the description.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoom.return_detail">
|
||||
<code class="sig-name descname">return_detail</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#ExtendedRoom.return_detail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoom.return_detail" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.return_detail">
|
||||
<code class="sig-name descname">return_detail</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#ExtendedRoom.return_detail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.return_detail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This will attempt to match a “detail” to look for in the room.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -174,8 +174,8 @@ markers.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoom.set_detail">
|
||||
<code class="sig-name descname">set_detail</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">detailkey</span></em>, <em class="sig-param"><span class="n">description</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#ExtendedRoom.set_detail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoom.set_detail" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.set_detail">
|
||||
<code class="sig-name descname">set_detail</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">detailkey</span></em>, <em class="sig-param"><span class="n">description</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#ExtendedRoom.set_detail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.set_detail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This sets a new detail, using an Attribute “details”.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -191,8 +191,8 @@ at the given detailkey.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoom.del_detail">
|
||||
<code class="sig-name descname">del_detail</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">detailkey</span></em>, <em class="sig-param"><span class="n">description</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#ExtendedRoom.del_detail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoom.del_detail" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.del_detail">
|
||||
<code class="sig-name descname">del_detail</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">detailkey</span></em>, <em class="sig-param"><span class="n">description</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#ExtendedRoom.del_detail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.del_detail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete a detail.</p>
|
||||
<p>The description is ignored.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -209,8 +209,8 @@ the detail doesn’t exist in this room.</p>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoom.return_appearance">
|
||||
<code class="sig-name descname">return_appearance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#ExtendedRoom.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoom.return_appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.return_appearance">
|
||||
<code class="sig-name descname">return_appearance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#ExtendedRoom.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.return_appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is called when e.g. the look command wants to retrieve
|
||||
the description of this object.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -228,39 +228,39 @@ overriding the call (unused by default).</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoom.update_current_description">
|
||||
<code class="sig-name descname">update_current_description</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#ExtendedRoom.update_current_description"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoom.update_current_description" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.update_current_description">
|
||||
<code class="sig-name descname">update_current_description</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#ExtendedRoom.update_current_description"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.update_current_description" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This will update the description of the room if the time or season
|
||||
has changed since last checked.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoom.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoom.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultRoom.DoesNotExist" title="evennia.objects.objects.DefaultRoom.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultRoom.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoom.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoom.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultRoom.MultipleObjectsReturned" title="evennia.objects.objects.DefaultRoom.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultRoom.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoom.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.extended_room.ExtendedRoom'</em><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoom.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.grid.extended_room.extended_room.ExtendedRoom'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoom.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'ExtendedRoom'</em><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoom.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'ExtendedRoom'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomLook">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.extended_room.</code><code class="sig-name descname">CmdExtendedRoomLook</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#CmdExtendedRoomLook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.extended_room.extended_room.</code><code class="sig-name descname">CmdExtendedRoomLook</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#CmdExtendedRoomLook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.general.html#evennia.commands.default.general.CmdLook" title="evennia.commands.default.general.CmdLook"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.general.CmdLook</span></code></a></p>
|
||||
<p>look</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -272,41 +272,41 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a><account&g
|
|||
</dl>
|
||||
<p>Observes your location, details at your location or objects in your vicinity.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomLook.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#CmdExtendedRoomLook.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#CmdExtendedRoomLook.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Handle the looking - add fallback to details.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomLook.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomLook.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'look'</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'look'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomLook.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDesc">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.extended_room.</code><code class="sig-name descname">CmdExtendedRoomDesc</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#CmdExtendedRoomDesc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDesc" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.extended_room.extended_room.</code><code class="sig-name descname">CmdExtendedRoomDesc</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#CmdExtendedRoomDesc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.building.html#evennia.commands.default.building.CmdDesc" title="evennia.commands.default.building.CmdDesc"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.building.CmdDesc</span></code></a></p>
|
||||
<p><strong>desc</strong> - describe an object or room.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -329,52 +329,52 @@ timeslot. The available times are night, morning, afternoon and evening.</p>
|
|||
<p>Note that seasons and time-of-day slots only work on rooms in this
|
||||
version of the <strong>desc</strong> command.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDesc.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['describe']</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDesc.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['describe']</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDesc.switch_options">
|
||||
<code class="sig-name descname">switch_options</code><em class="property"> = ()</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDesc.switch_options" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.switch_options">
|
||||
<code class="sig-name descname">switch_options</code><em class="property"> = ()</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.switch_options" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDesc.reset_times">
|
||||
<code class="sig-name descname">reset_times</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#CmdExtendedRoomDesc.reset_times"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDesc.reset_times" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.reset_times">
|
||||
<code class="sig-name descname">reset_times</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#CmdExtendedRoomDesc.reset_times"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.reset_times" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>By deleteting the caches we force a re-load.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDesc.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#CmdExtendedRoomDesc.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDesc.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#CmdExtendedRoomDesc.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Define extended command</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDesc.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'building'</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDesc.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'building'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDesc.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@desc'</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDesc.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@desc'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDesc.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(desc) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDesc.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(desc) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDesc.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'describe', 'category': 'building', 'key': '@desc', 'no_prefix': 'desc describe', 'tags': '', 'text': '\n `desc` - describe an object or room.\n\n Usage:\n desc[/switch] [<obj> =] <description>\n\n Switches for `desc`:\n spring - set description for <season> in current room.\n summer\n autumn\n winter\n\n Sets the "desc" attribute on an object. If an object is not given,\n describe the current room.\n\n You can also embed special time markers in your room description, like this:\n\n ```\n <night>In the darkness, the forest looks foreboding.</night>.\n ```\n\n Text marked this way will only display when the server is truly at the given\n timeslot. The available times are night, morning, afternoon and evening.\n\n Note that seasons and time-of-day slots only work on rooms in this\n version of the `desc` command.\n\n '}</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDesc.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'describe', 'category': 'building', 'key': '@desc', 'no_prefix': 'desc describe', 'tags': '', 'text': '\n `desc` - describe an object or room.\n\n Usage:\n desc[/switch] [<obj> =] <description>\n\n Switches for `desc`:\n spring - set description for <season> in current room.\n summer\n autumn\n winter\n\n Sets the "desc" attribute on an object. If an object is not given,\n describe the current room.\n\n You can also embed special time markers in your room description, like this:\n\n ```\n <night>In the darkness, the forest looks foreboding.</night>.\n ```\n\n Text marked this way will only display when the server is truly at the given\n timeslot. The available times are night, morning, afternoon and evening.\n\n Note that seasons and time-of-day slots only work on rooms in this\n version of the `desc` command.\n\n '}</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDesc.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDetail">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.extended_room.</code><code class="sig-name descname">CmdExtendedRoomDetail</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#CmdExtendedRoomDetail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDetail" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.extended_room.extended_room.</code><code class="sig-name descname">CmdExtendedRoomDetail</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#CmdExtendedRoomDetail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>sets a detail on a room</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -396,48 +396,48 @@ and the description. You can assign the same description to several
|
|||
details using the alias syntax (replace key by alias1;alias2;alias3;…).
|
||||
To remove one or several details, use the @detail/del switch.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDetail.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@detail'</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDetail.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = '@detail'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDetail.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDetail.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDetail.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'building'</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDetail.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'building'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDetail.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#CmdExtendedRoomDetail.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDetail.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#CmdExtendedRoomDetail.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is the hook function that actually does all the work. It is called
|
||||
by the cmdhandler right after self.parser() finishes, and so has access
|
||||
to all the variables defined therein.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDetail.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDetail.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDetail.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDetail.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDetail.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'building', 'key': '@detail', 'no_prefix': 'detail ', 'tags': '', 'text': '\n sets a detail on a room\n\n Usage:\n @detail[/del] <key> [= <description>]\n @detail <key>;<alias>;... = description\n\n Example:\n @detail\n @detail walls = The walls are covered in ...\n @detail castle;ruin;tower = The distant ruin ...\n @detail/del wall\n @detail/del castle;ruin;tower\n\n This command allows to show the current room details if you enter it\n without any argument. Otherwise, sets or deletes a detail on the current\n room, if this room supports details like an extended room. To add new\n detail, just use the @detail command, specifying the key, an equal sign\n and the description. You can assign the same description to several\n details using the alias syntax (replace key by alias1;alias2;alias3;...).\n To remove one or several details, use the @detail/del switch.\n\n '}</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDetail.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'building', 'key': '@detail', 'no_prefix': 'detail ', 'tags': '', 'text': '\n sets a detail on a room\n\n Usage:\n @detail[/del] <key> [= <description>]\n @detail <key>;<alias>;... = description\n\n Example:\n @detail\n @detail walls = The walls are covered in ...\n @detail castle;ruin;tower = The distant ruin ...\n @detail/del wall\n @detail/del castle;ruin;tower\n\n This command allows to show the current room details if you enter it\n without any argument. Otherwise, sets or deletes a detail on the current\n room, if this room supports details like an extended room. To add new\n detail, just use the @detail command, specifying the key, an equal sign\n and the description. You can assign the same description to several\n details using the alias syntax (replace key by alias1;alias2;alias3;...).\n To remove one or several details, use the @detail/del switch.\n\n '}</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomDetail.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomGameTime">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.extended_room.</code><code class="sig-name descname">CmdExtendedRoomGameTime</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#CmdExtendedRoomGameTime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomGameTime" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.extended_room.extended_room.</code><code class="sig-name descname">CmdExtendedRoomGameTime</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#CmdExtendedRoomGameTime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||||
<p>Check the game time</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -446,59 +446,59 @@ to all the variables defined therein.</p>
|
|||
</dl>
|
||||
<p>Shows the current in-game time and season.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomGameTime.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'time'</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomGameTime.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'time'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomGameTime.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomGameTime.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime.locks">
|
||||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime.locks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomGameTime.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomGameTime.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomGameTime.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#CmdExtendedRoomGameTime.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomGameTime.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime.func">
|
||||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#CmdExtendedRoomGameTime.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime.func" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Reads time info from current room</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomGameTime.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomGameTime.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomGameTime.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomGameTime.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.CmdExtendedRoomGameTime.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'time', 'no_prefix': ' ', 'tags': '', 'text': '\n Check the game time\n\n Usage:\n time\n\n Shows the current in-game time and season.\n '}</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomGameTime.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'time', 'no_prefix': ' ', 'tags': '', 'text': '\n Check the game time\n\n Usage:\n time\n\n Shows the current in-game time and season.\n '}</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomGameTime.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoomCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.extended_room.</code><code class="sig-name descname">ExtendedRoomCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#ExtendedRoomCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoomCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoomCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.extended_room.extended_room.</code><code class="sig-name descname">ExtendedRoomCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#ExtendedRoomCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoomCmdSet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
|
||||
<p>Groups the extended-room commands.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoomCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/extended_room.html#ExtendedRoomCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoomCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoomCmdSet.at_cmdset_creation">
|
||||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/extended_room.html#ExtendedRoomCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoomCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook method - this should be overloaded in the inheriting
|
||||
class, and should take care of populating the cmdset by use of
|
||||
self.add().</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.extended_room.ExtendedRoomCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.extended_room.ExtendedRoomCmdSet'</em><a class="headerlink" href="#evennia.contrib.extended_room.ExtendedRoomCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.ExtendedRoomCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.grid.extended_room.extended_room.ExtendedRoomCmdSet'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.ExtendedRoomCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -528,7 +528,7 @@ self.add().</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.extended_room.md.txt"
|
||||
<li><a href="../_sources/api/evennia.contrib.grid.extended_room.extended_room.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -544,8 +544,8 @@ self.add().</p>
|
|||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.extended_room.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.contrib.extended_room.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="evennia.contrib.grid.extended_room.extended_room.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -562,7 +562,7 @@ self.add().</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.extended_room</a></li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.grid.extended_room.extended_room</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
120
docs/1.0-dev/api/evennia.contrib.grid.extended_room.html
Normal file
120
docs/1.0-dev/api/evennia.contrib.grid.extended_room.html
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.grid.extended_room — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.grid.extended_room</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.grid.extended_room">
|
||||
<span id="evennia-contrib-grid-extended-room"></span><h1>evennia.contrib.grid.extended_room<a class="headerlink" href="#module-evennia.contrib.grid.extended_room" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Extended Room - Griatch 2012, vincent-lg 2019</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.grid.extended_room.extended_room.html">evennia.contrib.grid.extended_room.extended_room</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.grid.extended_room.tests.html">evennia.contrib.grid.extended_room.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.grid.extended_room.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.grid.extended_room.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.grid.extended_room</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
185
docs/1.0-dev/api/evennia.contrib.grid.extended_room.tests.html
Normal file
185
docs/1.0-dev/api/evennia.contrib.grid.extended_room.tests.html
Normal file
|
|
@ -0,0 +1,185 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.grid.extended_room.tests — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.grid.extended_room.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.grid.extended_room.tests">
|
||||
<span id="evennia-contrib-grid-extended-room-tests"></span><h1>evennia.contrib.grid.extended_room.tests<a class="headerlink" href="#module-evennia.contrib.grid.extended_room.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Testing of ExtendedRoom contrib</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.grid.extended_room.tests.ForceUTCDatetime">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.extended_room.tests.</code><code class="sig-name descname">ForceUTCDatetime</code><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/tests.html#ForceUTCDatetime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.tests.ForceUTCDatetime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code></p>
|
||||
<p>Force UTC datetime.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.grid.extended_room.tests.ForceUTCDatetime.fromtimestamp">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">fromtimestamp</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">timestamp</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/tests.html#ForceUTCDatetime.fromtimestamp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.tests.ForceUTCDatetime.fromtimestamp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Force fromtimestamp to run with naive datetimes.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.grid.extended_room.tests.TestExtendedRoom">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.extended_room.tests.</code><code class="sig-name descname">TestExtendedRoom</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/tests.html#TestExtendedRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.tests.TestExtendedRoom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.tests.html#evennia.commands.default.tests.EvenniaCommandTest" title="evennia.commands.default.tests.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.tests.EvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.grid.extended_room.tests.TestExtendedRoom.room_typeclass">
|
||||
<code class="sig-name descname">room_typeclass</code><a class="headerlink" href="#evennia.contrib.grid.extended_room.tests.TestExtendedRoom.room_typeclass" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.contrib.grid.extended_room.extended_room.html#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom" title="evennia.contrib.grid.extended_room.extended_room.ExtendedRoom"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.grid.extended_room.extended_room.ExtendedRoom</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.grid.extended_room.tests.TestExtendedRoom.DETAIL_DESC">
|
||||
<code class="sig-name descname">DETAIL_DESC</code><em class="property"> = 'A test detail.'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.tests.TestExtendedRoom.DETAIL_DESC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.grid.extended_room.tests.TestExtendedRoom.SPRING_DESC">
|
||||
<code class="sig-name descname">SPRING_DESC</code><em class="property"> = 'A spring description.'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.tests.TestExtendedRoom.SPRING_DESC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.grid.extended_room.tests.TestExtendedRoom.OLD_DESC">
|
||||
<code class="sig-name descname">OLD_DESC</code><em class="property"> = 'Old description.'</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.tests.TestExtendedRoom.OLD_DESC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.grid.extended_room.tests.TestExtendedRoom.setUp">
|
||||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/tests.html#TestExtendedRoom.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.tests.TestExtendedRoom.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets up testing environment</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.grid.extended_room.tests.TestExtendedRoom.test_return_appearance">
|
||||
<code class="sig-name descname">test_return_appearance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/tests.html#TestExtendedRoom.test_return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.tests.TestExtendedRoom.test_return_appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.grid.extended_room.tests.TestExtendedRoom.test_return_detail">
|
||||
<code class="sig-name descname">test_return_detail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/tests.html#TestExtendedRoom.test_return_detail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.tests.TestExtendedRoom.test_return_detail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.grid.extended_room.tests.TestExtendedRoom.test_cmdextendedlook">
|
||||
<code class="sig-name descname">test_cmdextendedlook</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/tests.html#TestExtendedRoom.test_cmdextendedlook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.tests.TestExtendedRoom.test_cmdextendedlook" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.grid.extended_room.tests.TestExtendedRoom.test_cmdsetdetail">
|
||||
<code class="sig-name descname">test_cmdsetdetail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/tests.html#TestExtendedRoom.test_cmdsetdetail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.tests.TestExtendedRoom.test_cmdsetdetail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.grid.extended_room.tests.TestExtendedRoom.test_cmdgametime">
|
||||
<code class="sig-name descname">test_cmdgametime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/extended_room/tests.html#TestExtendedRoom.test_cmdgametime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.extended_room.tests.TestExtendedRoom.test_cmdgametime" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.grid.extended_room.tests.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.grid.extended_room.tests.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.grid.extended_room.tests</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
175
docs/1.0-dev/api/evennia.contrib.grid.html
Normal file
175
docs/1.0-dev/api/evennia.contrib.grid.html
Normal file
|
|
@ -0,0 +1,175 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.grid — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.grid</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.contrib.grid">
|
||||
<span id="evennia-contrib-grid"></span><h1>evennia.contrib.grid<a class="headerlink" href="#module-evennia.contrib.grid" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Contribs related to moving in and manipulating the game world and grid.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.grid.extended_room.html">evennia.contrib.grid.extended_room</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.extended_room.extended_room.html">evennia.contrib.grid.extended_room.extended_room</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.extended_room.tests.html">evennia.contrib.grid.extended_room.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.grid.mapbuilder.html">evennia.contrib.grid.mapbuilder</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.mapbuilder.mapbuilder.html">evennia.contrib.grid.mapbuilder.mapbuilder</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.mapbuilder.tests.html">evennia.contrib.grid.mapbuilder.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.grid.simpledoor.html">evennia.contrib.grid.simpledoor</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.simpledoor.simpledoor.html">evennia.contrib.grid.simpledoor.simpledoor</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.simpledoor.tests.html">evennia.contrib.grid.simpledoor.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.grid.slow_exit.html">evennia.contrib.grid.slow_exit</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.slow_exit.slow_exit.html">evennia.contrib.grid.slow_exit.slow_exit</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.grid.slow_exit.slow_exit.html#installation">Installation:</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.grid.slow_exit.slow_exit.html#in-mygame-typeclasses-exits-py">in mygame/typeclasses/exits.py</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.grid.slow_exit.slow_exit.html#notes">Notes:</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.slow_exit.tests.html">evennia.contrib.grid.slow_exit.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.grid.wilderness.html">evennia.contrib.grid.wilderness</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.wilderness.tests.html">evennia.contrib.grid.wilderness.tests</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.wilderness.wilderness.html">evennia.contrib.grid.wilderness.wilderness</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.grid.wilderness.wilderness.html#usage">Usage</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.grid.wilderness.wilderness.html#customisation">Customisation</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.grid.wilderness.wilderness.html#example">Example</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.grid.wilderness.wilderness.html#implementation-details">Implementation details</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.html">evennia.contrib.grid.xyzgrid</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.commands.html">evennia.contrib.grid.xyzgrid.commands</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.example.html">evennia.contrib.grid.xyzgrid.example</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.launchcmd.html">evennia.contrib.grid.xyzgrid.launchcmd</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.prototypes.html">evennia.contrib.grid.xyzgrid.prototypes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.tests.html">evennia.contrib.grid.xyzgrid.tests</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.utils.html">evennia.contrib.grid.xyzgrid.utils</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.xymap.html">evennia.contrib.grid.xyzgrid.xymap</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.xymap.html#xymap">XYMap</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.xymap_legend.html">evennia.contrib.grid.xyzgrid.xymap_legend</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.xymap_legend.html#map-legend-components">Map legend components</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.xyzgrid.html">evennia.contrib.grid.xyzgrid.xyzgrid</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.grid.xyzgrid.xyzroom.html">evennia.contrib.grid.xyzgrid.xyzroom</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.grid.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.grid.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.grid</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
119
docs/1.0-dev/api/evennia.contrib.grid.mapbuilder.html
Normal file
119
docs/1.0-dev/api/evennia.contrib.grid.mapbuilder.html
Normal file
|
|
@ -0,0 +1,119 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>evennia.contrib.grid.mapbuilder — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
||||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.grid.mapbuilder</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="evennia-contrib-grid-mapbuilder">
|
||||
<h1>evennia.contrib.grid.mapbuilder<a class="headerlink" href="#evennia-contrib-grid-mapbuilder" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.grid.mapbuilder.mapbuilder.html">evennia.contrib.grid.mapbuilder.mapbuilder</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.grid.mapbuilder.tests.html">evennia.contrib.grid.mapbuilder.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<p class="logo"><a href="../index.html">
|
||||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||||
</a></p>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.contrib.grid.mapbuilder.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com">Home page</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.contrib.grid.mapbuilder.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.grid.mapbuilder</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue