mirror of
https://github.com/evennia/evennia.git
synced 2026-04-02 05:57:16 +02:00
Updated HTML docs
This commit is contained in:
Evennia docbuilder action
parent
937794ad0b
commit
dcc4cbe66f
316 changed files with 34330 additions and 3279 deletions
|
|
@ -353,6 +353,38 @@
|
|||
<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.evadventure.html">evennia.contrib.tutorials.evadventure</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.build_techdemo.html">evennia.contrib.tutorials.evadventure.build_techdemo</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.build_world.html">evennia.contrib.tutorials.evadventure.build_world</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.characters.html">evennia.contrib.tutorials.evadventure.characters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.chargen.html">evennia.contrib.tutorials.evadventure.chargen</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.combat_turnbased.html">evennia.contrib.tutorials.evadventure.combat_turnbased</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.commands.html">evennia.contrib.tutorials.evadventure.commands</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.dungeon.html">evennia.contrib.tutorials.evadventure.dungeon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.enums.html">evennia.contrib.tutorials.evadventure.enums</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.equipment.html">evennia.contrib.tutorials.evadventure.equipment</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.npcs.html">evennia.contrib.tutorials.evadventure.npcs</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html">evennia.contrib.tutorials.evadventure.objects</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.quests.html">evennia.contrib.tutorials.evadventure.quests</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.random_tables.html">evennia.contrib.tutorials.evadventure.random_tables</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.rooms.html">evennia.contrib.tutorials.evadventure.rooms</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.rules.html">evennia.contrib.tutorials.evadventure.rules</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.shops.html">evennia.contrib.tutorials.evadventure.shops</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.utils.html">evennia.contrib.tutorials.evadventure.utils</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.html">evennia.contrib.tutorials.evadventure.tests</a><ul>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.mixins.html">evennia.contrib.tutorials.evadventure.tests.mixins</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_characters.html">evennia.contrib.tutorials.evadventure.tests.test_characters</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_combat.html">evennia.contrib.tutorials.evadventure.tests.test_combat</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_commands.html">evennia.contrib.tutorials.evadventure.tests.test_commands</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_dungeon.html">evennia.contrib.tutorials.evadventure.tests.test_dungeon</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_equipment.html">evennia.contrib.tutorials.evadventure.tests.test_equipment</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_quests.html">evennia.contrib.tutorials.evadventure.tests.test_quests</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_rules.html">evennia.contrib.tutorials.evadventure.tests.test_rules</a></li>
|
||||
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_utils.html">evennia.contrib.tutorials.evadventure.tests.test_utils</a></li>
|
||||
</ul>
|
||||
</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>
|
||||
|
|
@ -390,6 +422,11 @@
|
|||
<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.name_generator.html">evennia.contrib.utils.name_generator</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.utils.name_generator.namegen.html">evennia.contrib.utils.name_generator.namegen</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.utils.name_generator.tests.html">evennia.contrib.utils.name_generator.tests</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>
|
||||
|
|
|
|||
|
|
@ -193,6 +193,18 @@ at_account_creation()</p>
|
|||
<em class="property">property </em><code class="sig-name descname">characters</code><a class="headerlink" href="#evennia.accounts.accounts.DefaultAccount.characters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.accounts.DefaultAccount.uses_screenreader">
|
||||
<code class="sig-name descname">uses_screenreader</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">session</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/accounts/accounts.html#DefaultAccount.uses_screenreader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.accounts.DefaultAccount.uses_screenreader" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Shortcut to determine if a session uses a screenreader. If no session given,
|
||||
will return true if any of the sessions use a screenreader.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>session</strong> (<a class="reference internal" href="evennia.server.session.html#evennia.server.session.Session" title="evennia.server.session.Session"><em>Session</em></a><em>, </em><em>optional</em>) – The session to check for screen reader.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.accounts.DefaultAccount.get_display_name">
|
||||
<code class="sig-name descname">get_display_name</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/accounts/accounts.html#DefaultAccount.get_display_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.accounts.DefaultAccount.get_display_name" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -889,7 +901,7 @@ overriding the call (unused by default).</p></li>
|
|||
<p class="rubric">Notes</p>
|
||||
<p>This is called <em>before</em> an eventual Character’s
|
||||
<strong>at_post_login</strong> hook. By default it is used to set up
|
||||
auto-puppeting based on <strong>MULTISESSION_MODE</strong>.</p>
|
||||
auto-puppeting based on <strong>MULTISESSION_MODE</strong></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -1009,6 +1021,11 @@ to do it.</p>
|
|||
(i.e. not for a restart).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.accounts.accounts.DefaultAccount.ooc_appearance_template">
|
||||
<code class="sig-name descname">ooc_appearance_template</code><em class="property"> = '--------------------------------------------------------------------\n{header}\n\n{sessions}\n\n |whelp|n - more commands\n |wpublic <text>|n - talk on public channel\n |wcharcreate <name> [=description]|n - create new character\n |wchardelete <name>|n - delete a character\n |wic <name>|n - enter the game as character (|wooc|n to get back here)\n |wic|n - enter the game as latest character controlled.\n\n{characters}\n{footer}\n--------------------------------------------------------------------'</em><a class="headerlink" href="#evennia.accounts.accounts.DefaultAccount.ooc_appearance_template" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.accounts.accounts.DefaultAccount.at_look">
|
||||
<code class="sig-name descname">at_look</code><span class="sig-paren">(</span><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">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/accounts/accounts.html#DefaultAccount.at_look"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.accounts.DefaultAccount.at_look" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -1018,7 +1035,7 @@ just what this means.</p>
|
|||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>target</strong> (<em>Object</em><em> or </em><em>list</em><em>, </em><em>optional</em>) – An object or a list
|
||||
objects to inspect.</p></li>
|
||||
objects to inspect. This is normally a list of characters.</p></li>
|
||||
<li><p><strong>session</strong> (<a class="reference internal" href="evennia.server.session.html#evennia.server.session.Session" title="evennia.server.session.Session"><em>Session</em></a><em>, </em><em>optional</em>) – The session doing this look.</p></li>
|
||||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||||
overriding the call (unused by default).</p></li>
|
||||
|
|
@ -1091,8 +1108,9 @@ errors (list): List of error messages accrued during this request.</p>
|
|||
<dl class="py method">
|
||||
<dt id="evennia.accounts.accounts.DefaultGuest.at_post_login">
|
||||
<code class="sig-name descname">at_post_login</code><span class="sig-paren">(</span><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/accounts/accounts.html#DefaultGuest.at_post_login"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.accounts.accounts.DefaultGuest.at_post_login" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>In theory, guests only have one character regardless of which
|
||||
MULTISESSION_MODE we’re in. They don’t get a choice.</p>
|
||||
<dd><p>By default, Guests only have one character regardless of which
|
||||
MAX_NR_CHARACTERS we use. They also always auto-puppet a matching
|
||||
character and don’t get a choice.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
|
|
|
|||
|
|
@ -84,7 +84,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"> = ['l', 'ls']</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"> = ['ls', 'l']</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">
|
||||
|
|
@ -115,7 +115,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': '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>
|
||||
<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>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -89,7 +89,7 @@ skipping, reloading etc.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.batchprocess.CmdBatchCommands.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['batchcommand', 'batchcmd']</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['batchcmd', 'batchcommand']</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -120,7 +120,7 @@ skipping, reloading etc.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.batchprocess.CmdBatchCommands.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'batchcommand batchcmd', 'category': 'building', 'key': 'batchcommands', 'no_prefix': ' batchcommand batchcmd', 'tags': '', 'text': '\n build from batch-command file\n\n Usage:\n batchcommands[/interactive] <python.path.to.file>\n\n Switch:\n interactive - this mode will offer more control when\n executing the batch file, like stepping,\n skipping, reloading etc.\n\n Runs batches of commands from a batch-cmd text file (*.ev).\n\n '}</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'batchcmd batchcommand', 'category': 'building', 'key': 'batchcommands', 'no_prefix': ' batchcmd batchcommand', 'tags': '', 'text': '\n build from batch-command file\n\n Usage:\n batchcommands[/interactive] <python.path.to.file>\n\n Switch:\n interactive - this mode will offer more control when\n executing the batch file, like stepping,\n skipping, reloading etc.\n\n Runs batches of commands from a batch-cmd text file (*.ev).\n\n '}</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -1296,7 +1296,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"> = ['@update', '@parent', '@type', '@swap', '@typeclasses']</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"> = ['@swap', '@typeclasses', '@parent', '@update', '@type']</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">
|
||||
|
|
@ -1327,7 +1327,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': '@update @parent @type @swap @typeclasses', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass update parent type swap typeclasses', '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': '@swap @typeclasses @parent @update @type', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass swap typeclasses parent update type', '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>
|
||||
|
|
|
|||
|
|
@ -126,7 +126,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"> = ['l', 'ls']</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"> = ['ls', 'l']</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">
|
||||
|
|
@ -157,7 +157,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': '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>
|
||||
<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>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -482,7 +482,7 @@ location you are currently in.</p>
|
|||
<dt>Usage:</dt><dd><p>give <inventory obj> <to||=> <target></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Gives an items from your inventory to another character,
|
||||
<p>Gives an item from your inventory to another person,
|
||||
placing it in their inventory.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdGive.key">
|
||||
|
|
@ -527,7 +527,7 @@ placing it in their inventory.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.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> <to||=> <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.commands.default.general.CmdGive.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<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> <to||=> <target>\n\n Gives an item from your inventory to another person,\n placing it in their inventory.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdGive.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -549,7 +549,7 @@ placing it in their inventory.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdSay.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ["'", '"']</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['"', "'"]</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -580,7 +580,7 @@ placing it in their inventory.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdSay.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '\' "', 'category': 'general', 'key': 'say', 'no_prefix': ' \' "', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '" \'', 'category': 'general', 'key': 'say', 'no_prefix': ' " \'', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -660,7 +660,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">
|
||||
|
|
@ -701,7 +701,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>
|
||||
|
|
@ -724,7 +724,7 @@ which permission groups you are a member of.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdAccess.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['groups', 'hierarchy']</em><a class="headerlink" href="#evennia.commands.default.general.CmdAccess.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['hierarchy', 'groups']</em><a class="headerlink" href="#evennia.commands.default.general.CmdAccess.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -755,7 +755,7 @@ which permission groups you are a member of.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdAccess.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'groups hierarchy', 'category': 'general', 'key': 'access', 'no_prefix': ' groups hierarchy', 'tags': '', 'text': '\n show your current game access\n\n Usage:\n access\n\n This command shows you the permission hierarchy and\n which permission groups you are a member of.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdAccess.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hierarchy groups', 'category': 'general', 'key': 'access', 'no_prefix': ' hierarchy groups', 'tags': '', 'text': '\n show your current game access\n\n Usage:\n access\n\n This command shows you the permission hierarchy and\n which permission groups you are a member of.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdAccess.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -423,9 +423,10 @@ main test suite started with</p>
|
|||
<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.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaCommandTest" title="evennia.utils.test_resources.BaseEvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<p>Test different account-specific modes</p>
|
||||
<dl class="py attribute">
|
||||
<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>
|
||||
<code class="sig-name descname">test_ooc_look</code><em class="property"> = None</em><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -493,6 +494,86 @@ main test suite started with</p>
|
|||
<code class="sig-name descname">test_quell</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/tests.html#TestAccount.test_quell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_quell" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_00">
|
||||
<code class="sig-name descname">test_ooc_look_00</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_00" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_01">
|
||||
<code class="sig-name descname">test_ooc_look_01</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_01" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_02">
|
||||
<code class="sig-name descname">test_ooc_look_02</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_02" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_03">
|
||||
<code class="sig-name descname">test_ooc_look_03</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_03" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_04">
|
||||
<code class="sig-name descname">test_ooc_look_04</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_04" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_05">
|
||||
<code class="sig-name descname">test_ooc_look_05</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_05" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_06">
|
||||
<code class="sig-name descname">test_ooc_look_06</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_06" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_07">
|
||||
<code class="sig-name descname">test_ooc_look_07</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_07" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_08">
|
||||
<code class="sig-name descname">test_ooc_look_08</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_08" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_09">
|
||||
<code class="sig-name descname">test_ooc_look_09</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_09" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_10">
|
||||
<code class="sig-name descname">test_ooc_look_10</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_10" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_11">
|
||||
<code class="sig-name descname">test_ooc_look_11</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_11" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_12">
|
||||
<code class="sig-name descname">test_ooc_look_12</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_12" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_13">
|
||||
<code class="sig-name descname">test_ooc_look_13</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_13" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_14">
|
||||
<code class="sig-name descname">test_ooc_look_14</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_14" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.commands.default.tests.TestAccount.test_ooc_look_15">
|
||||
<code class="sig-name descname">test_ooc_look_15</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.tests.TestAccount.test_ooc_look_15" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
|
|
@ -772,7 +853,7 @@ main test suite started with</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 '/tmp/tmp0n4td1_2/5757afe091e13689dfca4e25c5bda1e0931b823d/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>
|
||||
<code class="sig-name descname">red_button</code><em class="property"> = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmpsxtp1u0e/a68f3b4a7ce5c48fbd40b791d5d4d3733427f0b0/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">
|
||||
|
|
|
|||
|
|
@ -73,7 +73,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"> = ['co', 'conn', 'con']</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">
|
||||
|
|
@ -108,7 +108,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': 'co conn con', 'category': 'general', 'key': 'connect', 'no_prefix': ' co conn con', '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>
|
||||
|
|
@ -132,7 +132,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"> = ['cr', 'cre']</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"> = ['cre', 'cr']</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">
|
||||
|
|
@ -163,7 +163,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': '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>
|
||||
<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>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -187,7 +187,7 @@ version is a bit more complicated.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['q', 'qu']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['qu', 'q']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -213,7 +213,7 @@ version is a bit more complicated.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'no_prefix': ' q qu', 'tags': '', 'text': '\n quit when in unlogged-in state\n\n Usage:\n quit\n\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.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<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 quit when in unlogged-in state\n\n Usage:\n quit\n\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.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -237,7 +237,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">
|
||||
|
|
@ -263,7 +263,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>
|
||||
|
|
@ -286,7 +286,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">
|
||||
|
|
@ -312,7 +312,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>
|
||||
|
|
|
|||
|
|
@ -90,7 +90,7 @@ the module given by settings.CONNECTION_SCREEN_MODULE.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['co', 'conn', 'con']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.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.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -120,7 +120,7 @@ there is no object yet before the account has logged in)</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<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': 'co conn con', 'category': 'general', 'key': 'connect', 'no_prefix': ' co conn con', '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>
|
||||
<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>
|
||||
|
|
@ -142,7 +142,7 @@ there is no object yet before the account has logged in)</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<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>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['cre', 'cr']</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">
|
||||
|
|
@ -178,7 +178,7 @@ name enclosed in quotes:</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<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>
|
||||
<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.base_systems.email_login.email_login.CmdUnconnectedCreate.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -197,7 +197,7 @@ version is a bit more complicated.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['q', 'qu']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<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">
|
||||
|
|
@ -223,7 +223,7 @@ version is a bit more complicated.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<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': 'q qu', 'category': 'general', 'key': 'quit', 'no_prefix': ' q qu', '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>
|
||||
<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>
|
||||
|
|
@ -242,7 +242,7 @@ All it does is display the connect screen.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['look', 'l']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.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.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -268,7 +268,7 @@ All it does is display the connect screen.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<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': '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.base_systems.email_login.email_login.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 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>
|
||||
|
|
@ -286,7 +286,7 @@ for simplicity. It shows a pane of info.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<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>
|
||||
<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">
|
||||
|
|
@ -312,7 +312,7 @@ for simplicity. It shows a pane of info.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<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>
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -111,7 +111,7 @@ aliases to an already joined channel.</p>
|
|||
|
||||
<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>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['chanalias', 'aliaschan']</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">
|
||||
|
|
@ -142,7 +142,7 @@ aliases to an already joined channel.</p>
|
|||
|
||||
<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>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'chanalias aliaschan', 'category': 'comms', 'key': 'addcom', 'no_prefix': ' chanalias aliaschan', '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>
|
||||
|
|
|
|||
|
|
@ -162,7 +162,7 @@ the operation will be general or on the room.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['abort', 'quit', 'chicken out', 'q']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['chicken out', 'q', 'abort', 'quit']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -186,7 +186,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'abort quit chicken out q', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' abort quit chicken out q', 'tags': '', 'text': '\n Give up\n\n Usage:\n give up\n\n Abandons your attempts at escaping and of ever winning the pie-eating contest.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'chicken out q abort quit', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' chicken out q abort quit', 'tags': '', 'text': '\n Give up\n\n Usage:\n give up\n\n Abandons your attempts at escaping and of ever winning the pie-eating contest.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -207,7 +207,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -241,7 +241,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'evscaperoom', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n Look at the room, an object or the currently focused object\n\n Usage:\n look [obj]\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'evscaperoom', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n Look at the room, an object or the currently focused object\n\n Usage:\n look [obj]\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -322,7 +322,7 @@ shout</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['shout', 'whisper', ';']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['shout', ';', 'whisper']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -351,7 +351,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'shout whisper ;', 'category': 'general', 'key': 'say', 'no_prefix': ' shout whisper ;', 'tags': '', 'text': '\n Perform an communication action.\n\n Usage:\n say <text>\n whisper\n shout\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'shout ; whisper', 'category': 'general', 'key': 'say', 'no_prefix': ' shout ; whisper', 'tags': '', 'text': '\n Perform an communication action.\n\n Usage:\n say <text>\n whisper\n shout\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -379,7 +379,7 @@ emote /me points to /box and /lever.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = [':', 'pose']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['pose', ':']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -418,7 +418,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ': pose', 'category': 'general', 'key': 'emote', 'no_prefix': ' : pose', 'tags': '', 'text': '\n Perform a free-form emote. Use /me to\n include yourself in the emote and /name\n to include other objects or characters.\n Use "..." to enact speech.\n\n Usage:\n emote <emote>\n :<emote\n\n Example:\n emote /me smiles at /peter\n emote /me points to /box and /lever.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'pose :', 'category': 'general', 'key': 'emote', 'no_prefix': ' pose :', 'tags': '', 'text': '\n Perform a free-form emote. Use /me to\n include yourself in the emote and /name\n to include other objects or characters.\n Use "..." to enact speech.\n\n Usage:\n emote <emote>\n :<emote\n\n Example:\n emote /me smiles at /peter\n emote /me points to /box and /lever.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -441,7 +441,7 @@ looks and what actions is available.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['examine', 'e', 'ex', 'unfocus']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['examine', 'ex', 'unfocus', 'e']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -470,7 +470,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'examine e ex unfocus', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' examine e ex unfocus', 'tags': '', 'text': '\n Focus your attention on a target.\n\n Usage:\n focus <obj>\n\n Once focusing on an object, use look to get more information about how it\n looks and what actions is available.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'examine ex unfocus e', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' examine ex unfocus e', 'tags': '', 'text': '\n Focus your attention on a target.\n\n Usage:\n focus <obj>\n\n Once focusing on an object, use look to get more information about how it\n looks and what actions is available.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -532,7 +532,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdGet.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['give', 'inv', 'inventory', 'i']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['give', 'inventory', 'inv', 'i']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -556,7 +556,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdGet.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'give inv inventory i', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' give inv inventory i', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'give inventory inv i', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' give inventory inv i', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -577,7 +577,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdRerouter.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@dig', '@open']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdRerouter.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@open', '@dig']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdRerouter.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -600,7 +600,7 @@ to all the variables defined therein.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdRerouter.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@dig @open', 'category': 'general', 'key': 'open', 'no_prefix': ' dig open', 'tags': '', 'text': '\n Interact with an object in focus.\n\n Usage:\n <action> [arg]\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdRerouter.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@open @dig', 'category': 'general', 'key': 'open', 'no_prefix': ' open dig', 'tags': '', 'text': '\n Interact with an object in focus.\n\n Usage:\n <action> [arg]\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdRerouter.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -623,7 +623,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<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">
|
||||
|
|
@ -649,7 +649,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<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': '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.game_systems.turnbattle.tb_basic.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -518,7 +518,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -538,7 +538,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_equip.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.game_systems.turnbattle.tb_equip.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<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_equip.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -641,7 +641,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<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">
|
||||
|
|
@ -661,7 +661,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<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': '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.game_systems.turnbattle.tb_items.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -420,7 +420,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<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">
|
||||
|
|
@ -440,7 +440,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<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': '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.game_systems.turnbattle.tb_magic.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -880,7 +880,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -900,7 +900,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_range.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.game_systems.turnbattle.tb_range.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<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_range.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -291,7 +291,7 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a><account&g
|
|||
|
||||
<dl class="py attribute">
|
||||
<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>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</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">
|
||||
|
|
@ -311,7 +311,7 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a><account&g
|
|||
|
||||
<dl class="py attribute">
|
||||
<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>
|
||||
<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.grid.extended_room.extended_room.CmdExtendedRoomLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -338,6 +338,38 @@ useful but are deemed too game-specific to go into the core library.</p>
|
|||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.bodyfunctions.tests.html">evennia.contrib.tutorials.bodyfunctions.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.html">evennia.contrib.tutorials.evadventure</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.build_techdemo.html">evennia.contrib.tutorials.evadventure.build_techdemo</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.build_world.html">evennia.contrib.tutorials.evadventure.build_world</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.characters.html">evennia.contrib.tutorials.evadventure.characters</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.chargen.html">evennia.contrib.tutorials.evadventure.chargen</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.combat_turnbased.html">evennia.contrib.tutorials.evadventure.combat_turnbased</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.commands.html">evennia.contrib.tutorials.evadventure.commands</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.dungeon.html">evennia.contrib.tutorials.evadventure.dungeon</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.enums.html">evennia.contrib.tutorials.evadventure.enums</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.equipment.html">evennia.contrib.tutorials.evadventure.equipment</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.npcs.html">evennia.contrib.tutorials.evadventure.npcs</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html">evennia.contrib.tutorials.evadventure.objects</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.quests.html">evennia.contrib.tutorials.evadventure.quests</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.random_tables.html">evennia.contrib.tutorials.evadventure.random_tables</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.rooms.html">evennia.contrib.tutorials.evadventure.rooms</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.rules.html">evennia.contrib.tutorials.evadventure.rules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.shops.html">evennia.contrib.tutorials.evadventure.shops</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.utils.html">evennia.contrib.tutorials.evadventure.utils</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.html">evennia.contrib.tutorials.evadventure.tests</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.mixins.html">evennia.contrib.tutorials.evadventure.tests.mixins</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_characters.html">evennia.contrib.tutorials.evadventure.tests.test_characters</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_combat.html">evennia.contrib.tutorials.evadventure.tests.test_combat</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_commands.html">evennia.contrib.tutorials.evadventure.tests.test_commands</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_dungeon.html">evennia.contrib.tutorials.evadventure.tests.test_dungeon</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_equipment.html">evennia.contrib.tutorials.evadventure.tests.test_equipment</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_quests.html">evennia.contrib.tutorials.evadventure.tests.test_quests</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_rules.html">evennia.contrib.tutorials.evadventure.tests.test_rules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_utils.html">evennia.contrib.tutorials.evadventure.tests.test_utils</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.mirror.html">evennia.contrib.tutorials.mirror</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.mirror.mirror.html">evennia.contrib.tutorials.mirror.mirror</a></li>
|
||||
</ul>
|
||||
|
|
@ -375,6 +407,11 @@ useful but are deemed too game-specific to go into the core library.</p>
|
|||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html">evennia.contrib.utils.fieldfill.fieldfill</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.name_generator.html">evennia.contrib.utils.name_generator</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.name_generator.namegen.html">evennia.contrib.utils.name_generator.namegen</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.name_generator.tests.html">evennia.contrib.utils.name_generator.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.html">evennia.contrib.utils.random_string_generator</a><ul>
|
||||
<li class="toctree-l3"><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-l3"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.tests.html">evennia.contrib.utils.random_string_generator.tests</a></li>
|
||||
|
|
|
|||
|
|
@ -643,7 +643,7 @@ a different language.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ["'", '"']</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['"', "'"]</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -674,7 +674,7 @@ a different language.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '\' "', 'category': 'general', 'key': 'say', 'no_prefix': ' \' "', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '" \'', 'category': 'general', 'key': 'say', 'no_prefix': ' " \'', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@
|
|||
<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.tutorials.mirror" href="evennia.contrib.tutorials.mirror.html" />
|
||||
<link rel="next" title="evennia.contrib.tutorials.evadventure" href="evennia.contrib.tutorials.evadventure.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.bodyfunctions.bodyfunctions" href="evennia.contrib.tutorials.bodyfunctions.bodyfunctions.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.mirror.html" title="evennia.contrib.tutorials.mirror"
|
||||
<a href="evennia.contrib.tutorials.evadventure.html" title="evennia.contrib.tutorials.evadventure"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.bodyfunctions.bodyfunctions.html" title="evennia.contrib.tutorials.bodyfunctions.bodyfunctions"
|
||||
|
|
@ -117,8 +117,8 @@
|
|||
<p class="topless"><a href="evennia.contrib.tutorials.bodyfunctions.bodyfunctions.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.bodyfunctions.bodyfunctions</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.mirror.html"
|
||||
title="next chapter">evennia.contrib.tutorials.mirror</a></p>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure</a></p>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
|
|
@ -156,7 +156,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.mirror.html" title="evennia.contrib.tutorials.mirror"
|
||||
<a href="evennia.contrib.tutorials.evadventure.html" title="evennia.contrib.tutorials.evadventure"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.bodyfunctions.bodyfunctions.html" title="evennia.contrib.tutorials.bodyfunctions.bodyfunctions"
|
||||
|
|
|
|||
|
|
@ -0,0 +1,143 @@
|
|||
|
||||
<!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.tutorials.evadventure.build_techdemo — 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>
|
||||
<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.tutorials.evadventure.build_world" href="evennia.contrib.tutorials.evadventure.build_world.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure" href="evennia.contrib.tutorials.evadventure.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.build_world.html" title="evennia.contrib.tutorials.evadventure.build_world"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.html" title="evennia.contrib.tutorials.evadventure"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.build_techdemo</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-tutorials-evadventure-build-techdemo">
|
||||
<h1>evennia.contrib.tutorials.evadventure.build_techdemo<a class="headerlink" href="#evennia-contrib-tutorials-evadventure-build-techdemo" 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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.build_world.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.build_world</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.tutorials.evadventure.build_techdemo.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.tutorials.evadventure.build_techdemo.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.build_world.html" title="evennia.contrib.tutorials.evadventure.build_world"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.html" title="evennia.contrib.tutorials.evadventure"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.build_techdemo</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,143 @@
|
|||
|
||||
<!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.tutorials.evadventure.build_world — 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>
|
||||
<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.tutorials.evadventure.characters" href="evennia.contrib.tutorials.evadventure.characters.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.build_techdemo" href="evennia.contrib.tutorials.evadventure.build_techdemo.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.characters.html" title="evennia.contrib.tutorials.evadventure.characters"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.build_techdemo.html" title="evennia.contrib.tutorials.evadventure.build_techdemo"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.build_world</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.tutorials.evadventure.build_world">
|
||||
<span id="evennia-contrib-tutorials-evadventure-build-world"></span><h1>evennia.contrib.tutorials.evadventure.build_world<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.build_world" 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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.build_techdemo.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.build_techdemo</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.characters.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.characters</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.tutorials.evadventure.build_world.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.tutorials.evadventure.build_world.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.characters.html" title="evennia.contrib.tutorials.evadventure.characters"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.build_techdemo.html" title="evennia.contrib.tutorials.evadventure.build_techdemo"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.build_world</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,576 @@
|
|||
|
||||
<!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.tutorials.evadventure.characters — 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>
|
||||
<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.tutorials.evadventure.chargen" href="evennia.contrib.tutorials.evadventure.chargen.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.build_world" href="evennia.contrib.tutorials.evadventure.build_world.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.chargen.html" title="evennia.contrib.tutorials.evadventure.chargen"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.build_world.html" title="evennia.contrib.tutorials.evadventure.build_world"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.characters</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.tutorials.evadventure.characters">
|
||||
<span id="evennia-contrib-tutorials-evadventure-characters"></span><h1>evennia.contrib.tutorials.evadventure.characters<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.characters" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Character class.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.LivingMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.characters.</code><code class="sig-name descname">LivingMixin</code><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#LivingMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.LivingMixin" 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 class to use for all living things.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.LivingMixin.is_pc">
|
||||
<code class="sig-name descname">is_pc</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.LivingMixin.is_pc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.LivingMixin.hurt_level">
|
||||
<em class="property">property </em><code class="sig-name descname">hurt_level</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.LivingMixin.hurt_level" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>String describing how hurt this character is.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.LivingMixin.heal">
|
||||
<code class="sig-name descname">heal</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">hp</span></em>, <em class="sig-param"><span class="n">healer</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/tutorials/evadventure/characters.html#LivingMixin.heal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.LivingMixin.heal" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Heal by a certain amount of HP.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.LivingMixin.at_damage">
|
||||
<code class="sig-name descname">at_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">damage</span></em>, <em class="sig-param"><span class="n">attacker</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/tutorials/evadventure/characters.html#LivingMixin.at_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.LivingMixin.at_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when attacked and taking damage.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.LivingMixin.at_defeat">
|
||||
<code class="sig-name descname">at_defeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#LivingMixin.at_defeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.LivingMixin.at_defeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when this living thing reaches HP 0.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.LivingMixin.at_death">
|
||||
<code class="sig-name descname">at_death</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#LivingMixin.at_death"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.LivingMixin.at_death" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when this living thing dies.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.LivingMixin.at_pay">
|
||||
<code class="sig-name descname">at_pay</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">amount</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#LivingMixin.at_pay"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.LivingMixin.at_pay" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get coins, but no more than we actually have.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.LivingMixin.at_looted">
|
||||
<code class="sig-name descname">at_looted</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looter</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#LivingMixin.at_looted"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.LivingMixin.at_looted" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when being looted (after defeat).</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>looter</strong> (<em>Object</em>) – The one doing the looting.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.LivingMixin.pre_loot">
|
||||
<code class="sig-name descname">pre_loot</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defeated_enemy</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#LivingMixin.pre_loot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.LivingMixin.pre_loot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called just before looting an enemy.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>defeated_enemy</strong> (<em>Object</em>) – The enemy soon to loot.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>bool</em> – If False, no looting is allowed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.LivingMixin.at_do_loot">
|
||||
<code class="sig-name descname">at_do_loot</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defeated_enemy</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#LivingMixin.at_do_loot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.LivingMixin.at_do_loot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when looting another entity.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>defeated_enemy</strong> – The thing to loot.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.LivingMixin.post_loot">
|
||||
<code class="sig-name descname">post_loot</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defeated_enemy</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#LivingMixin.post_loot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.LivingMixin.post_loot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called just after having looted an enemy.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>defeated_enemy</strong> (<em>Object</em>) – The enemy just looted.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.characters.</code><code class="sig-name descname">EvAdventureCharacter</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/tutorials/evadventure/characters.html#EvAdventureCharacter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.characters.LivingMixin" title="evennia.contrib.tutorials.evadventure.characters.LivingMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.characters.LivingMixin</span></code></a>, <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 for use with EvAdventure.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.is_pc">
|
||||
<code class="sig-name descname">is_pc</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.is_pc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.strength">
|
||||
<code class="sig-name descname">strength</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.strength" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.dexterity">
|
||||
<code class="sig-name descname">dexterity</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.dexterity" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.constitution">
|
||||
<code class="sig-name descname">constitution</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.constitution" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.intelligence">
|
||||
<code class="sig-name descname">intelligence</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.intelligence" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.wisdom">
|
||||
<code class="sig-name descname">wisdom</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.wisdom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.charisma">
|
||||
<code class="sig-name descname">charisma</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.charisma" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.hp">
|
||||
<code class="sig-name descname">hp</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.hp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.hp_max">
|
||||
<code class="sig-name descname">hp_max</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.hp_max" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.level">
|
||||
<code class="sig-name descname">level</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.level" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.coins">
|
||||
<code class="sig-name descname">coins</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.coins" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.xp">
|
||||
<code class="sig-name descname">xp</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.xp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.xp_per_level">
|
||||
<code class="sig-name descname">xp_per_level</code><em class="property"> = 1000</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.xp_per_level" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.equipment">
|
||||
<code class="sig-name descname">equipment</code><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#EvAdventureCharacter.equipment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.equipment" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Allows to access equipment like char.equipment.worn</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.quests">
|
||||
<code class="sig-name descname">quests</code><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#EvAdventureCharacter.quests"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.quests" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Access and track quests</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.weapon">
|
||||
<em class="property">property </em><code class="sig-name descname">weapon</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.weapon" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.armor">
|
||||
<em class="property">property </em><code class="sig-name descname">armor</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.armor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.at_pre_object_receive">
|
||||
<code class="sig-name descname">at_pre_object_receive</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">moved_object</span></em>, <em class="sig-param"><span class="n">source_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/tutorials/evadventure/characters.html#EvAdventureCharacter.at_pre_object_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.at_pre_object_receive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook called by Evennia before moving an object here. Return False to abort move.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>moved_object</strong> (<em>Object</em>) – Object to move into this one (that is, into inventory).</p></li>
|
||||
<li><p><strong>source_location</strong> (<em>Object</em>) – Source location moved from.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Passed from move operation; the <strong>move_type</strong> is useful; if someone is giving
|
||||
us something (<strong>move_type==’give’</strong>) we want to ask first.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>bool</em> – If move should be allowed or not.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.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_object</span></em>, <em class="sig-param"><span class="n">source_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/tutorials/evadventure/characters.html#EvAdventureCharacter.at_object_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.at_object_receive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook called by Evennia as an object is moved here. We make sure it’s added
|
||||
to the equipment handler.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>moved_object</strong> (<em>Object</em>) – Object to move into this one (that is, into inventory).</p></li>
|
||||
<li><p><strong>source_location</strong> (<em>Object</em>) – Source location moved from.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Passed from move operation; unused here.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.at_pre_object_leave">
|
||||
<code class="sig-name descname">at_pre_object_leave</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">leaving_object</span></em>, <em class="sig-param"><span class="n">destination</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/tutorials/evadventure/characters.html#EvAdventureCharacter.at_pre_object_leave"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.at_pre_object_leave" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Hook called when dropping an item. We don’t allow to drop weilded/worn items
|
||||
(need to unwield/remove them first). Return False to</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.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_object</span></em>, <em class="sig-param"><span class="n">destination</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/tutorials/evadventure/characters.html#EvAdventureCharacter.at_object_leave"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.at_object_leave" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called just before an object leaves from inside this object</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>moved_obj</strong> (<em>Object</em>) – The object leaving</p></li>
|
||||
<li><p><strong>destination</strong> (<em>Object</em>) – Where <strong>moved_obj</strong> is going.</p></li>
|
||||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||||
overriding the call (unused by default).</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.at_defeat">
|
||||
<code class="sig-name descname">at_defeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#EvAdventureCharacter.at_defeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.at_defeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This happens when character drops <= 0 HP. For Characters, this means rolling on
|
||||
the death table.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.at_death">
|
||||
<code class="sig-name descname">at_death</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#EvAdventureCharacter.at_death"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.at_death" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when character dies.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.at_pre_loot">
|
||||
<code class="sig-name descname">at_pre_loot</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#EvAdventureCharacter.at_pre_loot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.at_pre_loot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called before allowing to loot. Return False to block enemy looting.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.at_looted">
|
||||
<code class="sig-name descname">at_looted</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looter</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#EvAdventureCharacter.at_looted"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.at_looted" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when being looted.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.add_xp">
|
||||
<code class="sig-name descname">add_xp</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">xp</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#EvAdventureCharacter.add_xp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.add_xp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add new XP.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>xp</strong> (<em>int</em>) – The amount of gained XP.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>bool</em> – If a new level was reached or not.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>level 1 -> 2 = 1000 XP
|
||||
level 2 -> 3 = 2000 XP etc</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.level_up">
|
||||
<code class="sig-name descname">level_up</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">abilities</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/characters.html#EvAdventureCharacter.level_up"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.level_up" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Perform the level-up action.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>*abilities</strong> (<em>str</em>) – A set of abilities (like ‘strength’, ‘dexterity’ (normally 3)
|
||||
to upgrade by 1. Max is usually +10.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>We block increases above a certain value, but we don’t raise an error here, that
|
||||
will need to be done earlier, when the user selects the ability to increase.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.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.tutorials.evadventure.characters.EvAdventureCharacter.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.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.tutorials.evadventure.characters.EvAdventureCharacter.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureCharacter'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.characters.get_character_sheet">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.characters.</code><code class="sig-name descname">get_character_sheet</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/tutorials/evadventure/characters.html#get_character_sheet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.characters.get_character_sheet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Generate a character sheet. This is grouped in a class in order to make
|
||||
it easier to override the look of the sheet.</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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.build_world.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.build_world</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.chargen.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.chargen</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.tutorials.evadventure.characters.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.tutorials.evadventure.characters.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.chargen.html" title="evennia.contrib.tutorials.evadventure.chargen"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.build_world.html" title="evennia.contrib.tutorials.evadventure.build_world"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.characters</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,214 @@
|
|||
|
||||
<!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.tutorials.evadventure.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>
|
||||
<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.tutorials.evadventure.combat_turnbased" href="evennia.contrib.tutorials.evadventure.combat_turnbased.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.characters" href="evennia.contrib.tutorials.evadventure.characters.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.combat_turnbased.html" title="evennia.contrib.tutorials.evadventure.combat_turnbased"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.characters.html" title="evennia.contrib.tutorials.evadventure.characters"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.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.tutorials.evadventure.chargen">
|
||||
<span id="evennia-contrib-tutorials-evadventure-chargen"></span><h1>evennia.contrib.tutorials.evadventure.chargen<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.chargen" title="Permalink to this headline">¶</a></h1>
|
||||
<p>EvAdventure character generation.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.chargen.TemporaryCharacterSheet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.chargen.</code><code class="sig-name descname">TemporaryCharacterSheet</code><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/chargen.html#TemporaryCharacterSheet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.chargen.TemporaryCharacterSheet" 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 collects all the rules for generating a new character. An instance of this class is used
|
||||
to pass around the current character state during character generation and also applied to
|
||||
the character at the end. This class instance can also be saved on the menu to make sure a user
|
||||
is not losing their half-created character.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>In standard Knave, the character’s attribute bonus is rolled randomly and will give a
|
||||
value 1-6; and there is no guarantee for ‘equal’ starting characters.</p>
|
||||
<p>Knave uses a d8 roll to get the initial hit points. We will follow the recommendation
|
||||
from the rule that we will use a minimum of 5 HP.</p>
|
||||
<p>We <em>will</em> roll random start equipment though. Contrary to standard Knave, we’ll also
|
||||
randomly assign the starting weapon among a small selection of equal-dmg weapons (since
|
||||
there is no GM to adjudicate a different choice).</p>
|
||||
</div>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.chargen.TemporaryCharacterSheet.__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/tutorials/evadventure/chargen.html#TemporaryCharacterSheet.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.chargen.TemporaryCharacterSheet.__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.tutorials.evadventure.chargen.TemporaryCharacterSheet.show_sheet">
|
||||
<code class="sig-name descname">show_sheet</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/chargen.html#TemporaryCharacterSheet.show_sheet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.chargen.TemporaryCharacterSheet.show_sheet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Show a temp character sheet, a compressed version of the real thing.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.chargen.TemporaryCharacterSheet.apply">
|
||||
<code class="sig-name descname">apply</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/chargen.html#TemporaryCharacterSheet.apply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.chargen.TemporaryCharacterSheet.apply" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Once the chargen is complete, call this create and set up the character.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.chargen.node_chargen">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.chargen.</code><code class="sig-name descname">node_chargen</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/tutorials/evadventure/chargen.html#node_chargen"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.chargen.node_chargen" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This node is the central point of chargen. We return here to see our current
|
||||
sheet and break off to edit different parts of it.</p>
|
||||
<p>In Knave, not so much can be changed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.chargen.node_change_name">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.chargen.</code><code class="sig-name descname">node_change_name</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/tutorials/evadventure/chargen.html#node_change_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.chargen.node_change_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Change the random name of the character.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.chargen.node_swap_abilities">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.chargen.</code><code class="sig-name descname">node_swap_abilities</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/tutorials/evadventure/chargen.html#node_swap_abilities"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.chargen.node_swap_abilities" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>One is allowed to swap the values of two abilities around, once.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.chargen.node_apply_character">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.chargen.</code><code class="sig-name descname">node_apply_character</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/tutorials/evadventure/chargen.html#node_apply_character"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.chargen.node_apply_character" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>End chargen and create the character. We will also puppet it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.chargen.start_chargen">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.chargen.</code><code class="sig-name descname">start_chargen</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><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/chargen.html#start_chargen"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.chargen.start_chargen" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is a start point for spinning up the chargen from a command later.</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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.characters.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.characters</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.combat_turnbased.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.combat_turnbased</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.tutorials.evadventure.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.tutorials.evadventure.chargen.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.combat_turnbased.html" title="evennia.contrib.tutorials.evadventure.combat_turnbased"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.characters.html" title="evennia.contrib.tutorials.evadventure.characters"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.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>
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -0,0 +1,579 @@
|
|||
|
||||
<!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.tutorials.evadventure.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>
|
||||
<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>
|
||||
<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.tutorials.evadventure.dungeon" href="evennia.contrib.tutorials.evadventure.dungeon.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.combat_turnbased" href="evennia.contrib.tutorials.evadventure.combat_turnbased.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.dungeon.html" title="evennia.contrib.tutorials.evadventure.dungeon"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.combat_turnbased.html" title="evennia.contrib.tutorials.evadventure.combat_turnbased"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.commands</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.tutorials.evadventure.commands">
|
||||
<span id="evennia-contrib-tutorials-evadventure-commands"></span><h1>evennia.contrib.tutorials.evadventure.commands<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.commands" title="Permalink to this headline">¶</a></h1>
|
||||
<p>EvAdventure commands and cmdsets. We don’t need that many stand-alone new
|
||||
commands since a lot of functionality is managed in menus. These commands
|
||||
are in additional to normal Evennia commands and should be added
|
||||
to the CharacterCmdSet</p>
|
||||
<dl class="simple">
|
||||
<dt>New commands:</dt><dd><p>attack/hit <target>[,…]
|
||||
inventory
|
||||
wield/wear <item>
|
||||
unwield/remove <item>
|
||||
give <item or coin> to <character>
|
||||
talk <npc></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>To install, add the <strong>EvAdventureCmdSet</strong> from this module to the default character cmdset:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># in mygame/commands/default_cmds.py</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">evennia.contrib.tutorials.evadventure.commands</span> <span class="kn">import</span> <span class="n">EvAdventureCmdSet</span> <span class="c1"># <---</span>
|
||||
|
||||
<span class="c1"># ...</span>
|
||||
|
||||
<span class="k">class</span> <span class="nc">CharacterCmdSet</span><span class="p">(</span><span class="n">CmdSet</span><span class="p">):</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">EvAdventureCmdSet</span><span class="p">)</span> <span class="c1"># <-----</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.commands.</code><code class="sig-name descname">EvAdventureCommand</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/tutorials/evadventure/commands.html#EvAdventureCommand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand" 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 EvAdventure command. This is on the form</p>
|
||||
<blockquote>
|
||||
<div><p>command <args></p>
|
||||
</div></blockquote>
|
||||
<p>where whitespace around the argument(s) are stripped.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand.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/tutorials/evadventure/commands.html#EvAdventureCommand.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Once the cmdhandler has identified this as the command we
|
||||
want, this function is run. If many of your commands have a
|
||||
similar syntax (for example ‘cmd arg1 = arg2’) you should
|
||||
simply define this once and just let other commands of the
|
||||
same form inherit from this. See the docstring of this module
|
||||
for which object properties are available to use (notably
|
||||
self.args).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'command'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand.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 EvAdventure command. This is on the form\n\n command <args>\n\n where whitespace around the argument(s) are stripped.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.commands.</code><code class="sig-name descname">CmdAttackTurnBased</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/tutorials/evadventure/commands.html#CmdAttackTurnBased"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand" title="evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand</span></code></a></p>
|
||||
<p>Attack a target or join an existing combat.</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>attack <target>
|
||||
attack <target>, <target>, …</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>If the target is involved in combat already, you’ll join combat with
|
||||
the first target you specify. Attacking multiple will draw them all into
|
||||
combat.</p>
|
||||
<p>This will start/join turn-based, combat, where you have a limited
|
||||
time to decide on your next action from a menu of options.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'attack'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['hit']</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased.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/tutorials/evadventure/commands.html#CmdAttackTurnBased.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Once the cmdhandler has identified this as the command we
|
||||
want, this function is run. If many of your commands have a
|
||||
similar syntax (for example ‘cmd arg1 = arg2’) you should
|
||||
simply define this once and just let other commands of the
|
||||
same form inherit from this. See the docstring of this module
|
||||
for which object properties are available to use (notably
|
||||
self.args).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased.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/tutorials/evadventure/commands.html#CmdAttackTurnBased.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased.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
|
||||
set in self.parse())</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hit', 'category': 'general', 'key': 'attack', 'no_prefix': ' hit', 'tags': '', 'text': "\n Attack a target or join an existing combat.\n\n Usage:\n attack <target>\n attack <target>, <target>, ...\n\n If the target is involved in combat already, you'll join combat with\n the first target you specify. Attacking multiple will draw them all into\n combat.\n\n This will start/join turn-based, combat, where you have a limited\n time to decide on your next action from a menu of options.\n\n "}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdAttackTurnBased.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdInventory">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.commands.</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/tutorials/evadventure/commands.html#CmdInventory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdInventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand" title="evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand</span></code></a></p>
|
||||
<p>View your inventory</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>inventory</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdInventory.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'inventory'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdInventory.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdInventory.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['inv', 'i']</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdInventory.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.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/tutorials/evadventure/commands.html#CmdInventory.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdInventory.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
|
||||
set in self.parse())</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdInventory.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdInventory.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdInventory.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdInventory.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdInventory.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'no_prefix': ' inv i', 'tags': '', 'text': '\n View your inventory\n\n Usage:\n inventory\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdInventory.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.commands.</code><code class="sig-name descname">CmdWieldOrWear</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/tutorials/evadventure/commands.html#CmdWieldOrWear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand" title="evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand</span></code></a></p>
|
||||
<p>Wield a weapon/shield, or wear a piece of armor or a helmet.</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>wield <item>
|
||||
wear <item></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>The item will automatically end up in the suitable spot, replacing whatever
|
||||
was there previously.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'wield'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['wear']</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear.out_txts">
|
||||
<code class="sig-name descname">out_txts</code><em class="property"> = {<WieldLocation.BACKPACK: 'backpack'>: 'You shuffle the position of {key} around in your backpack.', <WieldLocation.TWO_HANDS: 'two_handed_weapons'>: 'You hold {key} with both hands.', <WieldLocation.WEAPON_HAND: 'weapon_hand'>: 'You hold {key} in your strongest hand, ready for action.', <WieldLocation.SHIELD_HAND: 'shield_hand'>: 'You hold {key} in your off hand, ready to protect you.', <WieldLocation.BODY: 'body'>: 'You strap {key} on yourself.', <WieldLocation.HEAD: 'head'>: 'You put {key} on your head.'}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear.out_txts" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear.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/tutorials/evadventure/commands.html#CmdWieldOrWear.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear.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
|
||||
set in self.parse())</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'wear', 'category': 'general', 'key': 'wield', 'no_prefix': ' wear', 'tags': '', 'text': '\n Wield a weapon/shield, or wear a piece of armor or a helmet.\n\n Usage:\n wield <item>\n wear <item>\n\n The item will automatically end up in the suitable spot, replacing whatever\n was there previously.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdWieldOrWear.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdRemove">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.commands.</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/tutorials/evadventure/commands.html#CmdRemove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand" title="evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand</span></code></a></p>
|
||||
<p>Remove a remove a weapon/shield, armor or helmet.</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>remove <item>
|
||||
unwield <item>
|
||||
unwear <item></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>To remove an item from the backpack, use <a href="#id1"><span class="problematic" id="id2">|</span></a>wdrop|n instead.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdRemove.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'remove'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdRemove.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['unwield', 'unwear']</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.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/tutorials/evadventure/commands.html#CmdRemove.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.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
|
||||
set in self.parse())</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdRemove.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdRemove.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdRemove.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'unwield unwear', 'category': 'general', 'key': 'remove', 'no_prefix': ' unwield unwear', 'tags': '', 'text': '\n Remove a remove a weapon/shield, armor or helmet.\n\n Usage:\n remove <item>\n unwield <item>\n unwear <item>\n\n To remove an item from the backpack, use |wdrop|n instead.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.node_give">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.commands.</code><code class="sig-name descname">node_give</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/tutorials/evadventure/commands.html#node_give"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.node_give" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This will show to the giver until receiver accepts/declines. It allows them
|
||||
to rescind their offer.</p>
|
||||
<p>The <strong>caller</strong> here is the one giving the item. We also make sure to feed
|
||||
the ‘item’ and ‘receiver’ into the Evmenu.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.node_receive">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.commands.</code><code class="sig-name descname">node_receive</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/tutorials/evadventure/commands.html#node_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.node_receive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Will show to the receiver and allow them to accept/decline the offer for
|
||||
as long as the giver didn’t rescind it.</p>
|
||||
<p>The <strong>caller</strong> here is the one receiving the item. We also make sure to feed
|
||||
the ‘item’ and ‘giver’ into the EvMenu.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.node_end">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.commands.</code><code class="sig-name descname">node_end</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/tutorials/evadventure/commands.html#node_end"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.node_end" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdGive">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.commands.</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/tutorials/evadventure/commands.html#CmdGive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdGive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand" title="evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand</span></code></a></p>
|
||||
<p>Give item or money to another person. Items need to be accepted before
|
||||
they change hands. Money changes hands immediately with no wait.</p>
|
||||
<dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>give <item> to <receiver>
|
||||
give <number of coins> [coins] to receiver</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>If item name includes ‘ to ‘, surround it in quotes.</p>
|
||||
<p class="rubric">Examples</p>
|
||||
<p>give apple to ranger
|
||||
give “road to happiness” to sad ranger
|
||||
give 10 coins to ranger
|
||||
give 12 to ranger</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdGive.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'give'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdGive.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdGive.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/tutorials/evadventure/commands.html#CmdGive.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdGive.parse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Parsing is a little more complex for this command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.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/tutorials/evadventure/commands.html#CmdGive.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdGive.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
|
||||
set in self.parse())</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdGive.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdGive.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdGive.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdGive.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdGive.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdGive.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.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 item or money to another person. Items need to be accepted before\n they change hands. Money changes hands immediately with no wait.\n\n Usage:\n give <item> to <receiver>\n give <number of coins> [coins] to receiver\n\n If item name includes \' to \', surround it in quotes.\n\n Examples:\n give apple to ranger\n give "road to happiness" to sad ranger\n give 10 coins to ranger\n give 12 to ranger\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdGive.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdTalk">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.commands.</code><code class="sig-name descname">CmdTalk</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/tutorials/evadventure/commands.html#CmdTalk"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdTalk" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand" title="evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.commands.EvAdventureCommand</span></code></a></p>
|
||||
<p>Start a conversations with shop keepers and other NPCs in the world.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong><npc></strong> (<em>talk</em>) – </p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdTalk.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'talk'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdTalk.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdTalk.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/tutorials/evadventure/commands.html#CmdTalk.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdTalk.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
|
||||
set in self.parse())</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdTalk.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdTalk.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdTalk.help_category">
|
||||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdTalk.help_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdTalk.lock_storage">
|
||||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdTalk.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdTalk.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'talk', 'no_prefix': ' ', 'tags': '', 'text': '\n Start a conversations with shop keepers and other NPCs in the world.\n\n Args:\n talk <npc>\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdTalk.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.EvAdventureCmdSet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.commands.</code><code class="sig-name descname">EvAdventureCmdSet</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/tutorials/evadventure/commands.html#EvAdventureCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCmdSet" 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 all commands in one cmdset which can be added in one go to the DefaultCharacter cmdset.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.EvAdventureCmdSet.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'evadventure'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.EvAdventureCmdSet.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/tutorials/evadventure/commands.html#EvAdventureCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCmdSet.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.tutorials.evadventure.commands.EvAdventureCmdSet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.commands.EvAdventureCmdSet'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.EvAdventureCmdSet.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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.combat_turnbased.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.combat_turnbased</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.dungeon.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.dungeon</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.tutorials.evadventure.commands.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.tutorials.evadventure.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>
|
||||
</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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.dungeon.html" title="evennia.contrib.tutorials.evadventure.dungeon"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.combat_turnbased.html" title="evennia.contrib.tutorials.evadventure.combat_turnbased"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.commands</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,738 @@
|
|||
|
||||
<!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.tutorials.evadventure.dungeon — 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>
|
||||
<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.tutorials.evadventure.enums" href="evennia.contrib.tutorials.evadventure.enums.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.commands" href="evennia.contrib.tutorials.evadventure.commands.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.enums.html" title="evennia.contrib.tutorials.evadventure.enums"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.commands.html" title="evennia.contrib.tutorials.evadventure.commands"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.dungeon</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.tutorials.evadventure.dungeon">
|
||||
<span id="evennia-contrib-tutorials-evadventure-dungeon"></span><h1>evennia.contrib.tutorials.evadventure.dungeon<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.dungeon" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Dungeon system</p>
|
||||
<p>This creates a procedurally generated dungeon.</p>
|
||||
<p>The dungone originates in an entrance room with exits that spawn a new dungeon connection every X
|
||||
minutes. As long as characters go through the same exit within that time, they will all end up in
|
||||
the same dungeon ‘branch’, otherwise they will go into separate, un-connected dungeon ‘branches’.
|
||||
They can always go back to the start room, but this will become a one-way exit back.</p>
|
||||
<p>When moving through the dungeon, a new room is not generated until characters
|
||||
decided to go in that direction. Each room is tagged with the specific ‘instance’
|
||||
id of that particular branch of dungon. When no characters remain in the branch,
|
||||
the branch is deleted.</p>
|
||||
<p>Each room in the dungeon starts with a Tag <strong>not_clear</strong>; while this is set, all exits out
|
||||
of the room (not the one they came from) is blocked. When whatever problem the room
|
||||
offers has been solved (such as a puzzle or a battle), the tag is removed and the player(s)
|
||||
can choose which exit to leave through.</p>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.random">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.dungeon.</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.tutorials.evadventure.dungeon.random" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.dungeon.</code><code class="sig-name descname">EvAdventureDungeonRoom</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/tutorials/evadventure/dungeon.html#EvAdventureDungeonRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.tutorials.evadventure.rooms.html#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom" title="evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom</span></code></a></p>
|
||||
<p>Dangerous dungeon room.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.allow_combat">
|
||||
<code class="sig-name descname">allow_combat</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.allow_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.allow_death">
|
||||
<code class="sig-name descname">allow_death</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.allow_death" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.back_exit">
|
||||
<code class="sig-name descname">back_exit</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.back_exit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.dungeon_orchestrator">
|
||||
<code class="sig-name descname">dungeon_orchestrator</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.dungeon_orchestrator" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.xy_coords">
|
||||
<code class="sig-name descname">xy_coords</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.xy_coords" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.is_room_clear">
|
||||
<em class="property">property </em><code class="sig-name descname">is_room_clear</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.is_room_clear" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.clear_room">
|
||||
<code class="sig-name descname">clear_room</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/dungeon.html#EvAdventureDungeonRoom.clear_room"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.clear_room" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.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/tutorials/evadventure/dungeon.html#EvAdventureDungeonRoom.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set the <strong>not_clear</strong> tag on the room. This is removed when the room is
|
||||
‘cleared’, whatever that means for each room.</p>
|
||||
<p>We put this here rather than in the room-creation code so we can override
|
||||
easier (for example we may want an empty room which auto-clears).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.get_display_footer">
|
||||
<code class="sig-name descname">get_display_footer</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/tutorials/evadventure/dungeon.html#EvAdventureDungeonRoom.get_display_footer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.get_display_footer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Show if the room is ‘cleared’ or not as part of its description.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.tutorials.evadventure.rooms.html#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.DoesNotExist" title="evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.tutorials.evadventure.rooms.html#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureDungeonRoom'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.dungeon.</code><code class="sig-name descname">EvAdventureDungeonExit</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/tutorials/evadventure/dungeon.html#EvAdventureDungeonExit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultExit" title="evennia.objects.objects.DefaultExit"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultExit</span></code></a></p>
|
||||
<p>Dungeon exit. This will not create the target room until it’s traversed.
|
||||
It must be created referencing the dungeon_orchestrator it belongs to.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit.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/tutorials/evadventure/dungeon.html#EvAdventureDungeonExit.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>We want to block progressing forward unless the room is clear.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit.at_traverse">
|
||||
<code class="sig-name descname">at_traverse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">traversing_object</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/tutorials/evadventure/dungeon.html#EvAdventureDungeonExit.at_traverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit.at_traverse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when traversing. <strong>target_location</strong> will be None if the
|
||||
target was not yet created.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit.at_failed_traverse">
|
||||
<code class="sig-name descname">at_failed_traverse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">traversing_object</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/tutorials/evadventure/dungeon.html#EvAdventureDungeonExit.at_failed_traverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit.at_failed_traverse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when failing to traverse.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultExit.DoesNotExist" title="evennia.objects.objects.DefaultExit.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultExit.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultExit.MultipleObjectsReturned" title="evennia.objects.objects.DefaultExit.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultExit.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureDungeonExit'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonExit.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.room_generator">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.dungeon.</code><code class="sig-name descname">room_generator</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">dungeon_orchestrator</span></em>, <em class="sig-param"><span class="n">depth</span></em>, <em class="sig-param"><span class="n">coords</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/dungeon.html#room_generator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.room_generator" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Plugin room generator</p>
|
||||
<p>This default one returns the same empty room.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>dungeon_orchestrator</strong> (<a class="reference internal" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator" title="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator"><em>EvAdventureDungeonOrchestrator</em></a>) – The current orchestrator.</p></li>
|
||||
<li><p><strong>depth</strong> (<em>int</em>) – The ‘depth’ of the dungeon (radial distance from start room) this
|
||||
new room will be placed at.</p></li>
|
||||
<li><p><strong>coords</strong> (<em>tuple</em>) – The <strong>(x,y)</strong> coords that the new room will be created at.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.dungeon.</code><code class="sig-name descname">EvAdventureDungeonOrchestrator</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/tutorials/evadventure/dungeon.html#EvAdventureDungeonOrchestrator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator" 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>One script is created per dungeon ‘branch’ created. The orchestrator is
|
||||
responsible for determining what is created next when a character enters an
|
||||
exit within the dungeon.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.max_unexplored_exits">
|
||||
<code class="sig-name descname">max_unexplored_exits</code><em class="property"> = 2</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.max_unexplored_exits" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.max_new_exits_per_room">
|
||||
<code class="sig-name descname">max_new_exits_per_room</code><em class="property"> = 2</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.max_new_exits_per_room" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.rooms">
|
||||
<code class="sig-name descname">rooms</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.rooms" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.unvisited_exits">
|
||||
<code class="sig-name descname">unvisited_exits</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.unvisited_exits" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.highest_depth">
|
||||
<code class="sig-name descname">highest_depth</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.highest_depth" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.last_updated">
|
||||
<code class="sig-name descname">last_updated</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.last_updated" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.room_generator">
|
||||
<code class="sig-name descname">room_generator</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.room_generator" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.xy_grid">
|
||||
<code class="sig-name descname">xy_grid</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.xy_grid" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.start_room">
|
||||
<code class="sig-name descname">start_room</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.start_room" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.register_exit_traversed">
|
||||
<code class="sig-name descname">register_exit_traversed</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/tutorials/evadventure/dungeon.html#EvAdventureDungeonOrchestrator.register_exit_traversed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.register_exit_traversed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Tell the system the given exit was traversed. This allows us to track how many unvisited
|
||||
paths we have so as to not have it grow exponentially.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.create_out_exit">
|
||||
<code class="sig-name descname">create_out_exit</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">location</span></em>, <em class="sig-param"><span class="n">exit_direction</span><span class="o">=</span><span class="default_value">'north'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/dungeon.html#EvAdventureDungeonOrchestrator.create_out_exit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.create_out_exit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create outgoing exit from a room. The target room is not yet created.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.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/tutorials/evadventure/dungeon.html#EvAdventureDungeonOrchestrator.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Clean up the entire dungeon along with the orchestrator.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.new_room">
|
||||
<code class="sig-name descname">new_room</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">from_exit</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/dungeon.html#EvAdventureDungeonOrchestrator.new_room"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.new_room" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new Dungeon room leading from the provided exit.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>from_exit</strong> (<em>Exit</em>) – The exit leading to this new room.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.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.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.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.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureDungeonOrchestrator'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonOrchestrator.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.dungeon.</code><code class="sig-name descname">EvAdventureDungeonStartRoomExit</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/tutorials/evadventure/dungeon.html#EvAdventureDungeonStartRoomExit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultExit" title="evennia.objects.objects.DefaultExit"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultExit</span></code></a></p>
|
||||
<p>Traversing this exit will either lead to an existing dungeon branch or create
|
||||
a new one.</p>
|
||||
<p>Since exits need to have a destination, we start out having them loop back to
|
||||
the same location and change this whenever someone actually traverse them. The
|
||||
act of passing through creates a room on the other side.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit.reset_exit">
|
||||
<code class="sig-name descname">reset_exit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/dungeon.html#EvAdventureDungeonStartRoomExit.reset_exit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit.reset_exit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Flush the exit, so next traversal creates a new dungeon branch.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit.at_traverse">
|
||||
<code class="sig-name descname">at_traverse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">traversing_object</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/tutorials/evadventure/dungeon.html#EvAdventureDungeonStartRoomExit.at_traverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit.at_traverse" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>When traversing create a new orchestrator if one is not already assigned.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultExit.DoesNotExist" title="evennia.objects.objects.DefaultExit.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultExit.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultExit.MultipleObjectsReturned" title="evennia.objects.objects.DefaultExit.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultExit.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureDungeonStartRoomExit'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoomExit.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.dungeon.</code><code class="sig-name descname">EvAdventureStartRoomResetter</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/tutorials/evadventure/dungeon.html#EvAdventureStartRoomResetter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter" 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>Simple ticker-script. Introduces a chance of the room’s exits cycling every interval.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter.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/tutorials/evadventure/dungeon.html#EvAdventureStartRoomResetter.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter.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.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter.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/tutorials/evadventure/dungeon.html#EvAdventureStartRoomResetter.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called every time the script repeats.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter.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.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter.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.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureStartRoomResetter'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureStartRoomResetter.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.dungeon.</code><code class="sig-name descname">EvAdventureDungeonBranchDeleter</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/tutorials/evadventure/dungeon.html#EvAdventureDungeonBranchDeleter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter" 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>Cleanup script. After some time a dungeon branch will ‘collapse’, forcing all players in it
|
||||
back to the start room.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter.branch_max_life">
|
||||
<code class="sig-name descname">branch_max_life</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter.branch_max_life" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter.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/tutorials/evadventure/dungeon.html#EvAdventureDungeonBranchDeleter.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter.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.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter.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/tutorials/evadventure/dungeon.html#EvAdventureDungeonBranchDeleter.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Go through all dungeon-orchestrators and find which ones are too old.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter.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.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter.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.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureDungeonBranchDeleter'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranchDeleter.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.dungeon.</code><code class="sig-name descname">EvAdventureDungeonStartRoom</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/tutorials/evadventure/dungeon.html#EvAdventureDungeonStartRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom" title="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom</span></code></a></p>
|
||||
<p>The start room is the only permanent part of the dungeon. Exits leading from this room (except
|
||||
one leading back outside) each create/links to a separate dungeon branch/instance.</p>
|
||||
<ul class="simple">
|
||||
<li><dl class="simple">
|
||||
<dt>A script will reset each exit every 5 mins; after that time, entering the exit will spawn</dt><dd><p>a new branch-instance instead of leading to the one before.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
<li><dl class="simple">
|
||||
<dt>Another script will check age of branch instance every hour; once an instance has been</dt><dd><p>inactive for a week, it will ‘collapse’, forcing everyone inside back to the start room.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
</ul>
|
||||
<p>The actual exits should be created in the build script.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.recycle_time">
|
||||
<code class="sig-name descname">recycle_time</code><em class="property"> = 300</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.recycle_time" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.branch_check_time">
|
||||
<code class="sig-name descname">branch_check_time</code><em class="property"> = 3600</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.branch_check_time" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.branch_max_life">
|
||||
<code class="sig-name descname">branch_max_life</code><em class="property"> = 604800</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.branch_max_life" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.room_generator">
|
||||
<code class="sig-name descname">room_generator</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.room_generator" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.get_display_footer">
|
||||
<code class="sig-name descname">get_display_footer</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/tutorials/evadventure/dungeon.html#EvAdventureDungeonStartRoom.get_display_footer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.get_display_footer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Show if the room is ‘cleared’ or not as part of its description.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.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/tutorials/evadventure/dungeon.html#EvAdventureDungeonStartRoom.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set the <strong>not_clear</strong> tag on the room. This is removed when the room is
|
||||
‘cleared’, whatever that means for each room.</p>
|
||||
<p>We put this here rather than in the room-creation code so we can override
|
||||
easier (for example we may want an empty room which auto-clears).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.at_object_receive">
|
||||
<code class="sig-name descname">at_object_receive</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">source_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/tutorials/evadventure/dungeon.html#EvAdventureDungeonStartRoom.at_object_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.at_object_receive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Make sure to clean the dungeon branch-tag from characters when leaving a dungeon branch.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.DoesNotExist" title="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonRoom.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureDungeonStartRoom'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonStartRoom.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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.commands.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.commands</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.enums.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.enums</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.tutorials.evadventure.dungeon.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.tutorials.evadventure.dungeon.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.enums.html" title="evennia.contrib.tutorials.evadventure.enums"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.commands.html" title="evennia.contrib.tutorials.evadventure.commands"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.dungeon</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,312 @@
|
|||
|
||||
<!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.tutorials.evadventure.enums — 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>
|
||||
<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.tutorials.evadventure.equipment" href="evennia.contrib.tutorials.evadventure.equipment.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.dungeon" href="evennia.contrib.tutorials.evadventure.dungeon.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.equipment.html" title="evennia.contrib.tutorials.evadventure.equipment"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.dungeon.html" title="evennia.contrib.tutorials.evadventure.dungeon"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.enums</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.tutorials.evadventure.enums">
|
||||
<span id="evennia-contrib-tutorials-evadventure-enums"></span><h1>evennia.contrib.tutorials.evadventure.enums<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.enums" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Enums are constants representing different things in EvAdventure. The advantage
|
||||
of using an Enum over, say, a string is that if you make a typo using an unknown
|
||||
enum, Python will give you an error while a typo in a string may go through silently.</p>
|
||||
<p>It’s used as a direct reference:</p>
|
||||
<blockquote>
|
||||
<div><p>from enums import Ability</p>
|
||||
<dl class="simple">
|
||||
<dt>if abi is Ability.STR:</dt><dd><p># …</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<p>To get the <strong>value</strong> of an enum (must always be hashable, useful for Attribute lookups), use
|
||||
<strong>Ability.STR.value</strong> (which would return ‘strength’ in our case).</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.enums.</code><code class="sig-name descname">Ability</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/enums.html#Ability"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
|
||||
<p>The six base abilities (defense is always bonus + 10)</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.STR">
|
||||
<code class="sig-name descname">STR</code><em class="property"> = 'strength'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.STR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.DEX">
|
||||
<code class="sig-name descname">DEX</code><em class="property"> = 'dexterity'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.DEX" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.CON">
|
||||
<code class="sig-name descname">CON</code><em class="property"> = 'constitution'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.CON" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.INT">
|
||||
<code class="sig-name descname">INT</code><em class="property"> = 'intelligence'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.INT" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.WIS">
|
||||
<code class="sig-name descname">WIS</code><em class="property"> = 'wisdom'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.WIS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.CHA">
|
||||
<code class="sig-name descname">CHA</code><em class="property"> = 'charisma'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.CHA" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.ARMOR">
|
||||
<code class="sig-name descname">ARMOR</code><em class="property"> = 'armor'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.ARMOR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.CRITICAL_FAILURE">
|
||||
<code class="sig-name descname">CRITICAL_FAILURE</code><em class="property"> = 'critical_failure'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.CRITICAL_FAILURE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.CRITICAL_SUCCESS">
|
||||
<code class="sig-name descname">CRITICAL_SUCCESS</code><em class="property"> = 'critical_success'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.CRITICAL_SUCCESS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.ALLEGIANCE_HOSTILE">
|
||||
<code class="sig-name descname">ALLEGIANCE_HOSTILE</code><em class="property"> = 'hostile'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.ALLEGIANCE_HOSTILE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.ALLEGIANCE_NEUTRAL">
|
||||
<code class="sig-name descname">ALLEGIANCE_NEUTRAL</code><em class="property"> = 'neutral'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.ALLEGIANCE_NEUTRAL" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.Ability.ALLEGIANCE_FRIENDLY">
|
||||
<code class="sig-name descname">ALLEGIANCE_FRIENDLY</code><em class="property"> = 'friendly'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.Ability.ALLEGIANCE_FRIENDLY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.WieldLocation">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.enums.</code><code class="sig-name descname">WieldLocation</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/enums.html#WieldLocation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.WieldLocation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
|
||||
<p>Wield (or wear) locations.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.WieldLocation.BACKPACK">
|
||||
<code class="sig-name descname">BACKPACK</code><em class="property"> = 'backpack'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.WieldLocation.BACKPACK" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.WieldLocation.WEAPON_HAND">
|
||||
<code class="sig-name descname">WEAPON_HAND</code><em class="property"> = 'weapon_hand'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.WieldLocation.WEAPON_HAND" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.WieldLocation.SHIELD_HAND">
|
||||
<code class="sig-name descname">SHIELD_HAND</code><em class="property"> = 'shield_hand'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.WieldLocation.SHIELD_HAND" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.WieldLocation.TWO_HANDS">
|
||||
<code class="sig-name descname">TWO_HANDS</code><em class="property"> = 'two_handed_weapons'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.WieldLocation.TWO_HANDS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.WieldLocation.BODY">
|
||||
<code class="sig-name descname">BODY</code><em class="property"> = 'body'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.WieldLocation.BODY" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.WieldLocation.HEAD">
|
||||
<code class="sig-name descname">HEAD</code><em class="property"> = 'head'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.WieldLocation.HEAD" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.enums.</code><code class="sig-name descname">ObjType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/enums.html#ObjType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
|
||||
<p>Object types</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.WEAPON">
|
||||
<code class="sig-name descname">WEAPON</code><em class="property"> = 'weapon'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.WEAPON" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.ARMOR">
|
||||
<code class="sig-name descname">ARMOR</code><em class="property"> = 'armor'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.ARMOR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.SHIELD">
|
||||
<code class="sig-name descname">SHIELD</code><em class="property"> = 'shield'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.SHIELD" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.HELMET">
|
||||
<code class="sig-name descname">HELMET</code><em class="property"> = 'helmet'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.HELMET" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.CONSUMABLE">
|
||||
<code class="sig-name descname">CONSUMABLE</code><em class="property"> = 'consumable'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.CONSUMABLE" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.GEAR">
|
||||
<code class="sig-name descname">GEAR</code><em class="property"> = 'gear'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.GEAR" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.MAGIC">
|
||||
<code class="sig-name descname">MAGIC</code><em class="property"> = 'magic'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.MAGIC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.QUEST">
|
||||
<code class="sig-name descname">QUEST</code><em class="property"> = 'quest'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.QUEST" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.enums.ObjType.TREASURE">
|
||||
<code class="sig-name descname">TREASURE</code><em class="property"> = 'treasure'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.enums.ObjType.TREASURE" 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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.dungeon.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.dungeon</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.equipment.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.equipment</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.tutorials.evadventure.enums.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.tutorials.evadventure.enums.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.equipment.html" title="evennia.contrib.tutorials.evadventure.equipment"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.dungeon.html" title="evennia.contrib.tutorials.evadventure.dungeon"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.enums</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,386 @@
|
|||
|
||||
<!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.tutorials.evadventure.equipment — 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>
|
||||
<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.tutorials.evadventure.npcs" href="evennia.contrib.tutorials.evadventure.npcs.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.enums" href="evennia.contrib.tutorials.evadventure.enums.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.npcs.html" title="evennia.contrib.tutorials.evadventure.npcs"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.enums.html" title="evennia.contrib.tutorials.evadventure.enums"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.equipment</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.tutorials.evadventure.equipment">
|
||||
<span id="evennia-contrib-tutorials-evadventure-equipment"></span><h1>evennia.contrib.tutorials.evadventure.equipment<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.equipment" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Knave has a system of Slots for its inventory.</p>
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentError">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.equipment.</code><code class="sig-name descname">EquipmentError</code><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">TypeError</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.equipment.</code><code class="sig-name descname">EquipmentHandler</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/tutorials/evadventure/equipment.html#EquipmentHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler" 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>_Knave_ puts a lot of emphasis on the inventory. You have CON_DEFENSE inventory
|
||||
slots. Some things, like torches can fit multiple in one slot, other (like
|
||||
big weapons and armor) use more than one slot. The items carried and wielded has a big impact
|
||||
on character customization - even magic requires carrying a runestone per spell.</p>
|
||||
<p>The inventory also doubles as a measure of negative effects. Getting soaked in mud
|
||||
or slime could gunk up some of your inventory slots and make the items there unusuable
|
||||
until you clean them.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.save_attribute">
|
||||
<code class="sig-name descname">save_attribute</code><em class="property"> = 'inventory_slots'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.save_attribute" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.__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/tutorials/evadventure/equipment.html#EquipmentHandler.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.__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.tutorials.evadventure.equipment.EquipmentHandler.count_slots">
|
||||
<code class="sig-name descname">count_slots</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.count_slots"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.count_slots" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Count slot usage. This is fetched from the .size Attribute of the
|
||||
object. The size can also be partial slots.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.max_slots">
|
||||
<em class="property">property </em><code class="sig-name descname">max_slots</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.max_slots" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The max amount of equipment slots (‘carrying capacity’) is based on
|
||||
the constitution defense.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.validate_slot_usage">
|
||||
<code class="sig-name descname">validate_slot_usage</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/tutorials/evadventure/equipment.html#EquipmentHandler.validate_slot_usage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.validate_slot_usage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Check if obj can fit in equipment, based on its size.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>obj</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><em>EvAdventureObject</em></a>) – The object to add.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raises</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentError" title="evennia.contrib.tutorials.evadventure.equipment.EquipmentError"><strong>EquipmentError</strong></a> – If there’s not enough room.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_current_slot">
|
||||
<code class="sig-name descname">get_current_slot</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/tutorials/evadventure/equipment.html#EquipmentHandler.get_current_slot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_current_slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Check which slot-type the given object is in.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>obj</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><em>EvAdventureObject</em></a>) – The object to check.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>WieldLocation</em> – A location the object is in. None if the object
|
||||
is not in the inventory at all.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.armor">
|
||||
<em class="property">property </em><code class="sig-name descname">armor</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.armor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Armor provided by actually worn equipment/shield. For body armor
|
||||
this is a base value, like 12, for shield/helmet, it’s a bonus, like +1.
|
||||
We treat values and bonuses equal and just add them up. This value
|
||||
can thus be 0, the ‘unarmored’ default should be handled by the calling
|
||||
method.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><p><em>int</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>Armor from equipment. Note that this is the +bonus of Armor, not the</dt><dd><p>’defense’ (to get that one adds 10).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.weapon">
|
||||
<em class="property">property </em><code class="sig-name descname">weapon</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.weapon" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Conveniently get the currently active weapon or rune stone.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>obj or None</em> – The weapon. None if unarmored.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_loadout">
|
||||
<code class="sig-name descname">display_loadout</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.display_loadout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_loadout" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get a visual representation of your current loadout.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>str</em> – The current loadout.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_backpack">
|
||||
<code class="sig-name descname">display_backpack</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.display_backpack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_backpack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get a visual representation of the backpack’s contents.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_slot_usage">
|
||||
<code class="sig-name descname">display_slot_usage</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.display_slot_usage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.display_slot_usage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get a slot usage/max string for display.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>str</em> – The usage string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.move">
|
||||
<code class="sig-name descname">move</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/tutorials/evadventure/equipment.html#EquipmentHandler.move"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.move" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Moves item to the place it things it should be in - this makes use of the object’s wield
|
||||
slot to decide where it goes. The item is assumed to already be in the backpack.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>obj</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><em>EvAdventureObject</em></a>) – Thing to use.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raises</dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentError" title="evennia.contrib.tutorials.evadventure.equipment.EquipmentError"><strong>EquipmentError</strong></a> – If there’s no room in inventory. It will contains the details
|
||||
of the error, suitable to echo to user.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>This will cleanly move any ‘colliding’ items to the backpack to
|
||||
make the use possible (such as moving sword + shield to backpack when wielding
|
||||
a two-handed weapon). If wanting to warn the user about this, it needs to happen
|
||||
before this call.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.add">
|
||||
<code class="sig-name descname">add</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/tutorials/evadventure/equipment.html#EquipmentHandler.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Put something in the backpack specifically (even if it could be wield/worn).</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>obj</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><em>EvAdventureObject</em></a>) – The object to add.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>This will not change the object’s <strong>.location</strong>, this must be done
|
||||
by the calling code.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.remove">
|
||||
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj_or_slot</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Remove specific object or objects from a slot.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>obj_or_slot</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><em>EvAdventureObject</em></a><em> or </em><a class="reference internal" href="evennia.contrib.tutorials.evadventure.enums.html#evennia.contrib.tutorials.evadventure.enums.WieldLocation" title="evennia.contrib.tutorials.evadventure.enums.WieldLocation"><em>WieldLocation</em></a>) – The specific object or
|
||||
location to empty. If this is WieldLocation.BACKPACK, all items
|
||||
in the backpack will be emptied and returned!</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>list</em> – A list of 0, 1 or more objects emptied from the inventory.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>This will not change the object’s <strong>.location</strong>, this must be done separately
|
||||
by the calling code.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_wieldable_objects_from_backpack">
|
||||
<code class="sig-name descname">get_wieldable_objects_from_backpack</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.get_wieldable_objects_from_backpack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_wieldable_objects_from_backpack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get all wieldable weapons (or spell runes) from backpack. This is useful in order to
|
||||
have a list to select from when swapping your wielded loadout.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>list</em> – A list of objects with a suitable <strong>inventory_use_slot</strong>. We don’t check
|
||||
quality, so this may include broken items (we may want to visually show them
|
||||
in the list after all).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_wearable_objects_from_backpack">
|
||||
<code class="sig-name descname">get_wearable_objects_from_backpack</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.get_wearable_objects_from_backpack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_wearable_objects_from_backpack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get all wearable items (armor or helmets) from backpack. This is useful in order to
|
||||
have a list to select from when swapping your worn loadout.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>list</em> – A list of objects with a suitable <strong>inventory_use_slot</strong>. We don’t check
|
||||
quality, so this may include broken items (we may want to visually show them
|
||||
in the list after all).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_usable_objects_from_backpack">
|
||||
<code class="sig-name descname">get_usable_objects_from_backpack</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/equipment.html#EquipmentHandler.get_usable_objects_from_backpack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.get_usable_objects_from_backpack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get all ‘usable’ items (like potions) from backpack. This is useful for getting a
|
||||
list to select from.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>list</em> – A list of objects that are usable.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.all">
|
||||
<code class="sig-name descname">all</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">only_objs</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/tutorials/evadventure/equipment.html#EquipmentHandler.all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.equipment.EquipmentHandler.all" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get all objects in inventory, regardless of location.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Keyword Arguments</dt>
|
||||
<dd class="field-odd"><p><strong>only_objs</strong> (<em>bool</em>) – Only return a flat list of objects, not tuples.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>list</em> – A list of item tuples <strong>[(item, WieldLocation),…]</strong>
|
||||
starting with the wielded ones, backpack content last. If <strong>only_objs</strong> is set,
|
||||
this will just be a flat list of objects.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.enums.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.enums</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.npcs.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.npcs</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.tutorials.evadventure.equipment.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.tutorials.evadventure.equipment.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.npcs.html" title="evennia.contrib.tutorials.evadventure.npcs"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.enums.html" title="evennia.contrib.tutorials.evadventure.enums"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.equipment</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>
|
||||
181
docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.html
Normal file
181
docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.html
Normal file
|
|
@ -0,0 +1,181 @@
|
|||
|
||||
<!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.tutorials.evadventure — 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>
|
||||
<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.tutorials.evadventure.build_techdemo" href="evennia.contrib.tutorials.evadventure.build_techdemo.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.bodyfunctions.tests" href="evennia.contrib.tutorials.bodyfunctions.tests.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.build_techdemo.html" title="evennia.contrib.tutorials.evadventure.build_techdemo"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.bodyfunctions.tests.html" title="evennia.contrib.tutorials.bodyfunctions.tests"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" accesskey="U">evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure</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.tutorials.evadventure">
|
||||
<span id="evennia-contrib-tutorials-evadventure"></span><h1>evennia.contrib.tutorials.evadventure<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure" title="Permalink to this headline">¶</a></h1>
|
||||
<p>EvAdventure - a complete game in Evennia.</p>
|
||||
<p>This is an implementation of, and reference code to, the game created in the
|
||||
documentation’s beginner tutorial.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.build_techdemo.html">evennia.contrib.tutorials.evadventure.build_techdemo</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.build_world.html">evennia.contrib.tutorials.evadventure.build_world</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.characters.html">evennia.contrib.tutorials.evadventure.characters</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.chargen.html">evennia.contrib.tutorials.evadventure.chargen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.combat_turnbased.html">evennia.contrib.tutorials.evadventure.combat_turnbased</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.commands.html">evennia.contrib.tutorials.evadventure.commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.dungeon.html">evennia.contrib.tutorials.evadventure.dungeon</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.enums.html">evennia.contrib.tutorials.evadventure.enums</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.equipment.html">evennia.contrib.tutorials.evadventure.equipment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.npcs.html">evennia.contrib.tutorials.evadventure.npcs</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html">evennia.contrib.tutorials.evadventure.objects</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.quests.html">evennia.contrib.tutorials.evadventure.quests</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.random_tables.html">evennia.contrib.tutorials.evadventure.random_tables</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.rooms.html">evennia.contrib.tutorials.evadventure.rooms</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.rules.html">evennia.contrib.tutorials.evadventure.rules</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.shops.html">evennia.contrib.tutorials.evadventure.shops</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.utils.html">evennia.contrib.tutorials.evadventure.utils</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.html">evennia.contrib.tutorials.evadventure.tests</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.mixins.html">evennia.contrib.tutorials.evadventure.tests.mixins</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_characters.html">evennia.contrib.tutorials.evadventure.tests.test_characters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_combat.html">evennia.contrib.tutorials.evadventure.tests.test_combat</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_commands.html">evennia.contrib.tutorials.evadventure.tests.test_commands</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_dungeon.html">evennia.contrib.tutorials.evadventure.tests.test_dungeon</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_equipment.html">evennia.contrib.tutorials.evadventure.tests.test_equipment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_quests.html">evennia.contrib.tutorials.evadventure.tests.test_quests</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_rules.html">evennia.contrib.tutorials.evadventure.tests.test_rules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_utils.html">evennia.contrib.tutorials.evadventure.tests.test_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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.bodyfunctions.tests.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.bodyfunctions.tests</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.build_techdemo.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.build_techdemo</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.tutorials.evadventure.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.tutorials.evadventure.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.build_techdemo.html" title="evennia.contrib.tutorials.evadventure.build_techdemo"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.bodyfunctions.tests.html" title="evennia.contrib.tutorials.bodyfunctions.tests"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure</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>
|
||||
682
docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.npcs.html
Normal file
682
docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.npcs.html
Normal file
|
|
@ -0,0 +1,682 @@
|
|||
|
||||
<!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.tutorials.evadventure.npcs — 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>
|
||||
<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.tutorials.evadventure.objects" href="evennia.contrib.tutorials.evadventure.objects.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.equipment" href="evennia.contrib.tutorials.evadventure.equipment.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.objects.html" title="evennia.contrib.tutorials.evadventure.objects"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.equipment.html" title="evennia.contrib.tutorials.evadventure.equipment"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.npcs</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.tutorials.evadventure.npcs">
|
||||
<span id="evennia-contrib-tutorials-evadventure-npcs"></span><h1>evennia.contrib.tutorials.evadventure.npcs<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.npcs" title="Permalink to this headline">¶</a></h1>
|
||||
<p>EvAdventure NPCs. This includes both friends and enemies, only separated by their AI.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.npcs.</code><code class="sig-name descname">EvAdventureNPC</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/tutorials/evadventure/npcs.html#EvAdventureNPC"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.tutorials.evadventure.characters.html#evennia.contrib.tutorials.evadventure.characters.LivingMixin" title="evennia.contrib.tutorials.evadventure.characters.LivingMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.characters.LivingMixin</span></code></a>, <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 the base class for all non-player entities, including monsters. These
|
||||
generally don’t advance in level but uses a simplified, abstract measure of how
|
||||
dangerous or competent they are - the ‘hit dice’ (HD).</p>
|
||||
<p>HD indicates how much health they have and how hard they hit. In _Knave_, HD also
|
||||
defaults to being the bonus for all abilities. HP is 4 x Hit die (this can then be
|
||||
customized per-entity of course).</p>
|
||||
<p>Morale is set explicitly per-NPC, usually between 7 and 9.</p>
|
||||
<p>Monsters don’t use equipment in the way PCs do, instead they have a fixed armor
|
||||
value, and their Abilities are dynamically generated from the HD (hit_dice).</p>
|
||||
<p>If wanting monsters or NPCs that can level and work the same as PCs, base them off the
|
||||
EvAdventureCharacter class instead.</p>
|
||||
<p>The weapon of the npc is stored as an Attribute instead of implementing a full
|
||||
inventory/equipment system. This means that the normal inventory can be used for
|
||||
non-combat purposes (or for loot to get when killing an enemy).</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.is_pc">
|
||||
<code class="sig-name descname">is_pc</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.is_pc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.hit_dice">
|
||||
<code class="sig-name descname">hit_dice</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.hit_dice" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.armor">
|
||||
<code class="sig-name descname">armor</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.armor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.morale">
|
||||
<code class="sig-name descname">morale</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.morale" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.hp_multiplier">
|
||||
<code class="sig-name descname">hp_multiplier</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.hp_multiplier" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.hp">
|
||||
<code class="sig-name descname">hp</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.hp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.allegiance">
|
||||
<code class="sig-name descname">allegiance</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.allegiance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.is_idle">
|
||||
<code class="sig-name descname">is_idle</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.is_idle" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.weapon">
|
||||
<code class="sig-name descname">weapon</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.weapon" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.coins">
|
||||
<code class="sig-name descname">coins</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.coins" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.strength">
|
||||
<em class="property">property </em><code class="sig-name descname">strength</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.strength" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.dexterity">
|
||||
<em class="property">property </em><code class="sig-name descname">dexterity</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.dexterity" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.constitution">
|
||||
<em class="property">property </em><code class="sig-name descname">constitution</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.constitution" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.intelligence">
|
||||
<em class="property">property </em><code class="sig-name descname">intelligence</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.intelligence" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.wisdom">
|
||||
<em class="property">property </em><code class="sig-name descname">wisdom</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.wisdom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.charisma">
|
||||
<em class="property">property </em><code class="sig-name descname">charisma</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.charisma" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.hp_max">
|
||||
<em class="property">property </em><code class="sig-name descname">hp_max</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.hp_max" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.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/tutorials/evadventure/npcs.html#EvAdventureNPC.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Start with max health.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.ai_combat_next_action">
|
||||
<code class="sig-name descname">ai_combat_next_action</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/npcs.html#EvAdventureNPC.ai_combat_next_action"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.ai_combat_next_action" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The combat engine should ask this method in order to
|
||||
get the next action the npc should perform in combat.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.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.tutorials.evadventure.npcs.EvAdventureNPC.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.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.tutorials.evadventure.npcs.EvAdventureNPC.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureNPC'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.npcs.</code><code class="sig-name descname">EvAdventureTalkativeNPC</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/tutorials/evadventure/npcs.html#EvAdventureTalkativeNPC"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC" title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC</span></code></a></p>
|
||||
<p>Talkative NPCs can be addressed by <strong>talk [to] <npc></strong>. This opens a chat menu with
|
||||
communication options. The menu is created with the npc and we override the .create
|
||||
to allow passing in the menu nodes.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.menudata">
|
||||
<code class="sig-name descname">menudata</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.menudata" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.menu_kwargs">
|
||||
<code class="sig-name descname">menu_kwargs</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.menu_kwargs" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.hi_text">
|
||||
<code class="sig-name descname">hi_text</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.hi_text" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.at_damage">
|
||||
<code class="sig-name descname">at_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">damage</span></em>, <em class="sig-param"><span class="n">attacker</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/tutorials/evadventure/npcs.html#EvAdventureTalkativeNPC.at_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.at_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Talkative NPCs are generally immortal (we don’t deduct HP here by default).”</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.create">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span></em>, <em class="sig-param"><span class="n">account</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/tutorials/evadventure/npcs.html#EvAdventureTalkativeNPC.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Overriding the creation of the NPC, allowing some extra <strong>**kwargs</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>key</strong> (<em>str</em>) – Name of the new object.</p></li>
|
||||
<li><p><strong>account</strong> (<em>Account</em><em>, </em><em>optional</em>) – Account to attribute this object to.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Keyword Arguments</dt>
|
||||
<dd class="field-even"><ul class="simple">
|
||||
<li><p><strong>description</strong> (<em>str</em>) – Brief description for this object (same as default Evennia)</p></li>
|
||||
<li><p><strong>ip</strong> (<em>str</em>) – IP address of creator (for object auditing) (same as default Evennia).</p></li>
|
||||
<li><p><strong>menudata</strong> (<em>dict</em><em> or </em><em>str</em>) – The <strong>menudata</strong> argument to <strong>EvMenu</strong>. This is either a dict of
|
||||
<strong>{“nodename”: <node_callable>,…}</strong> or the python-path to a module containing
|
||||
such nodes (see EvMenu docs). This will be used to generate the chat menu
|
||||
chat menu for the character that talks to the NPC (which means the <strong>at_talk</strong> hook
|
||||
is called (by our custom <strong>talk</strong> command).</p></li>
|
||||
<li><p><strong>menu_kwargs</strong> (<em>dict</em>) – This will be passed as <strong>**kwargs</strong> into <strong>EvMenu</strong> when it
|
||||
is created. Make sure this dict can be pickled to an Attribute.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>tuple</em> – <strong>(new_character, errors)</strong>. On error, the <strong>new_character</strong> is <strong>None</strong> and
|
||||
<strong>errors</strong> is a <strong>list</strong> of error strings (an empty list otherwise).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.at_talk">
|
||||
<code class="sig-name descname">at_talk</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">talker</span></em>, <em class="sig-param"><span class="n">startnode</span><span class="o">=</span><span class="default_value">'node_start'</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/tutorials/evadventure/npcs.html#EvAdventureTalkativeNPC.at_talk"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.at_talk" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called by the <strong>talk</strong> command when another entity addresses us.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>talker</strong> (<em>Object</em>) – The one talking to us.</p></li>
|
||||
<li><p><strong>startnode</strong> (<em>str</em><em>, </em><em>optional</em>) – Allows to start in a different location in the menu tree.
|
||||
The given node must exist in the tree.</p></li>
|
||||
<li><p><strong>session</strong> (<a class="reference internal" href="evennia.server.session.html#evennia.server.session.Session" title="evennia.server.session.Session"><em>Session</em></a><em>, </em><em>optional</em>) – The talker’s current session, allows for routing
|
||||
correctly in multi-session modes.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – This will be passed into the <strong>EvMenu</strong> creation and appended and <strong>menu_kwargs</strong>
|
||||
given to the NPC at creation.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>We pass <strong>npc=self</strong> into the EvMenu for easy back-reference. This will appear in the
|
||||
<strong>**kwargs</strong> of the start node.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.DoesNotExist" title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureTalkativeNPC'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.node_start">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.npcs.</code><code class="sig-name descname">node_start</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/tutorials/evadventure/npcs.html#node_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.node_start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is the intended start menu node for the Talkative NPC interface. It will
|
||||
use on-npc Attributes to build its message and will also pick its options
|
||||
based on nodes named <strong>node_start_*</strong> are available in the node tree.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureQuestGiver">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.npcs.</code><code class="sig-name descname">EvAdventureQuestGiver</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/tutorials/evadventure/npcs.html#EvAdventureQuestGiver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureQuestGiver" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC" title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC</span></code></a></p>
|
||||
<p>An NPC that acts as a dispenser of quests.</p>
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureQuestGiver.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureQuestGiver.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.DoesNotExist" title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureQuestGiver.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureQuestGiver.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureQuestGiver.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.npcs.EvAdventureQuestGiver'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureQuestGiver.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureQuestGiver.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureQuestGiver'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureQuestGiver.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.npcs.</code><code class="sig-name descname">EvAdventureShopKeeper</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/tutorials/evadventure/npcs.html#EvAdventureShopKeeper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC" title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC</span></code></a></p>
|
||||
<p>ShopKeeper NPC.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.upsell_factor">
|
||||
<code class="sig-name descname">upsell_factor</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.upsell_factor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.miser_factor">
|
||||
<code class="sig-name descname">miser_factor</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.miser_factor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.common_ware_prototypes">
|
||||
<code class="sig-name descname">common_ware_prototypes</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.common_ware_prototypes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.at_damage">
|
||||
<code class="sig-name descname">at_damage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">damage</span></em>, <em class="sig-param"><span class="n">attacker</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/tutorials/evadventure/npcs.html#EvAdventureShopKeeper.at_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.at_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Immortal - we don’t deduct any damage here.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.DoesNotExist" title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureShopKeeper'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.npcs.</code><code class="sig-name descname">EvAdventureMob</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/tutorials/evadventure/npcs.html#EvAdventureMob"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC" title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC</span></code></a></p>
|
||||
<p>Mob (mobile) NPC; this is usually an enemy.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.loot_chance">
|
||||
<code class="sig-name descname">loot_chance</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.loot_chance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.ai_combat_next_action">
|
||||
<code class="sig-name descname">ai_combat_next_action</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">combathandler</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/npcs.html#EvAdventureMob.ai_combat_next_action"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.ai_combat_next_action" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called to get the next action in combat.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>combathandler</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.combat_turnbased.html#evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureCombatHandler" title="evennia.contrib.tutorials.evadventure.combat_turnbased.EvAdventureCombatHandler"><em>EvAdventureCombatHandler</em></a>) – The currently active combathandler.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>tuple</em> – A tuple <strong>(str, tuple, dict)</strong>, being the <strong>action_key</strong>, and the <strong>*args</strong> and
|
||||
<strong>**kwargs</strong> for that action. The action-key is that of a CombatAction available to the
|
||||
combatant in the current combat handler.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.at_defeat">
|
||||
<code class="sig-name descname">at_defeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/npcs.html#EvAdventureMob.at_defeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.at_defeat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Mobs die right away when defeated, no death-table rolls.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.at_do_loot">
|
||||
<code class="sig-name descname">at_do_loot</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looted</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/npcs.html#EvAdventureMob.at_do_loot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.at_do_loot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when mob gets to loot a PC.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.DoesNotExist" title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.npcs.EvAdventureNPC.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureMob'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.npcs.EvAdventureMob.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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.equipment.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.equipment</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.objects.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.objects</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.tutorials.evadventure.npcs.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.tutorials.evadventure.npcs.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.objects.html" title="evennia.contrib.tutorials.evadventure.objects"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.equipment.html" title="evennia.contrib.tutorials.evadventure.equipment"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.npcs</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,938 @@
|
|||
|
||||
<!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.tutorials.evadventure.objects — 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>
|
||||
<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.tutorials.evadventure.quests" href="evennia.contrib.tutorials.evadventure.quests.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.npcs" href="evennia.contrib.tutorials.evadventure.npcs.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.quests.html" title="evennia.contrib.tutorials.evadventure.quests"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.npcs.html" title="evennia.contrib.tutorials.evadventure.npcs"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.objects</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.tutorials.evadventure.objects">
|
||||
<span id="evennia-contrib-tutorials-evadventure-objects"></span><h1>evennia.contrib.tutorials.evadventure.objects<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.objects" title="Permalink to this headline">¶</a></h1>
|
||||
<p>All items in the game inherit from a base object. The properties (what you can do
|
||||
with an object, such as wear, wield, eat, drink, kill etc) are all controlled by
|
||||
Tags.</p>
|
||||
<p>Every object has one of a few <strong>obj_type</strong>-category tags:
|
||||
- weapon
|
||||
- armor
|
||||
- shield
|
||||
- helmet
|
||||
- consumable (potions, torches etc)
|
||||
- magic (runestones, magic items)
|
||||
- quest (quest-items)
|
||||
- treasure (valuable to sell)</p>
|
||||
<p>It’s possible for an item to have more than one tag, such as a golden helmet (helmet+treasure) or
|
||||
rune sword (weapon+quest).</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.objects.</code><code class="sig-name descname">EvAdventureObject</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/tutorials/evadventure/objects.html#EvAdventureObject"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" 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>
|
||||
<p>Base in-game entity.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.inventory_use_slot">
|
||||
<code class="sig-name descname">inventory_use_slot</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.inventory_use_slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.size">
|
||||
<code class="sig-name descname">size</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.size" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.value">
|
||||
<code class="sig-name descname">value</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.value" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.obj_type">
|
||||
<code class="sig-name descname">obj_type</code><em class="property"> = 'gear'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.obj_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.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/tutorials/evadventure/objects.html#EvAdventureObject.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.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.tutorials.evadventure.objects.EvAdventureObject.get_display_header">
|
||||
<code class="sig-name descname">get_display_header</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/tutorials/evadventure/objects.html#EvAdventureObject.get_display_header"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.get_display_header" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ‘header’ component of the object description. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The header display string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.get_display_desc">
|
||||
<code class="sig-name descname">get_display_desc</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/tutorials/evadventure/objects.html#EvAdventureObject.get_display_desc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.get_display_desc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ‘desc’ component of the object description. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The desc display string..</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.has_obj_type">
|
||||
<code class="sig-name descname">has_obj_type</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">objtype</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/objects.html#EvAdventureObject.has_obj_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.has_obj_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Check if object is of a particular type.</p>
|
||||
<p>typeobj_enum (enum.ObjType): A type to check, like enums.TypeObj.TREASURE.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.get_help">
|
||||
<code class="sig-name descname">get_help</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/objects.html#EvAdventureObject.get_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.get_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get help text for the item.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>str</em> – The help text, by default taken from the <strong>.help_text</strong> property.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.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.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.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.tutorials.evadventure.objects.EvAdventureObject.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.objects.EvAdventureObject'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureObject'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.objects.</code><code class="sig-name descname">EvAdventureObjectFiller</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/tutorials/evadventure/objects.html#EvAdventureObjectFiller"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject</span></code></a></p>
|
||||
<p>In _Knave_, the inventory slots act as an extra measure of how you are affected by
|
||||
various averse effects. For example, mud or water could fill up some of your inventory
|
||||
slots and make the equipment there unusable until you cleaned it. Inventory is also
|
||||
used to track how long you can stay under water etc - the fewer empty slots you have,
|
||||
the less time you can stay under water due to carrying so much stuff with you.</p>
|
||||
<p>This class represents such an effect filling up an empty slot. It has a quality of 0,
|
||||
meaning it’s unusable.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller.obj_type">
|
||||
<code class="sig-name descname">obj_type</code><em class="property"> = 'quest'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller.obj_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller.quality">
|
||||
<code class="sig-name descname">quality</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller.quality" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureObjectFiller'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObjectFiller.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.objects.</code><code class="sig-name descname">EvAdventureQuestObject</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/tutorials/evadventure/objects.html#EvAdventureQuestObject"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject</span></code></a></p>
|
||||
<p>A quest object. These cannot be sold and only be used for quest resolution.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject.obj_type">
|
||||
<code class="sig-name descname">obj_type</code><em class="property"> = 'quest'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject.obj_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject.value">
|
||||
<code class="sig-name descname">value</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject.value" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureQuestObject'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureQuestObject.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.objects.</code><code class="sig-name descname">EvAdventureTreasure</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/tutorials/evadventure/objects.html#EvAdventureTreasure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject</span></code></a></p>
|
||||
<p>A ‘treasure’ is mainly useful to sell for coin.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure.obj_type">
|
||||
<code class="sig-name descname">obj_type</code><em class="property"> = 'treasure'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure.obj_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure.value">
|
||||
<code class="sig-name descname">value</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure.value" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureTreasure'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureTreasure.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.objects.</code><code class="sig-name descname">EvAdventureConsumable</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/tutorials/evadventure/objects.html#EvAdventureConsumable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject</span></code></a></p>
|
||||
<p>Item that can be ‘used up’, like a potion or food. Weapons, armor etc does not
|
||||
have a limited usage in this way.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.obj_type">
|
||||
<code class="sig-name descname">obj_type</code><em class="property"> = 'consumable'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.obj_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.size">
|
||||
<code class="sig-name descname">size</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.size" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.uses">
|
||||
<code class="sig-name descname">uses</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.uses" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.at_use">
|
||||
<code class="sig-name descname">at_use</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">user</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/tutorials/evadventure/objects.html#EvAdventureConsumable.at_use"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.at_use" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Consume a ‘use’ of this item. Once it reaches 0 uses, it should normally
|
||||
not be usable anymore and probably be deleted.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>user</strong> (<em>Object</em>) – The one using the item.</p></li>
|
||||
<li><p><strong>*args</strong> – Extra arguments depending on the usage and item.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – <p>Extra arguments depending on the usage and item.</p>
|
||||
</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.at_post_use">
|
||||
<code class="sig-name descname">at_post_use</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">user</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/tutorials/evadventure/objects.html#EvAdventureConsumable.at_post_use"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.at_post_use" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called after this item was used.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>user</strong> (<em>Object</em>) – The one using the item.</p></li>
|
||||
<li><p><strong>*args</strong> – Optional arguments.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – <p>Optional arguments.</p>
|
||||
</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureConsumable'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.objects.</code><code class="sig-name descname">WeaponEmptyHand</code><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/objects.html#WeaponEmptyHand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand" 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 is a dummy-class loaded when you wield no weapons. We won’t create any db-object for it.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand.obj_type">
|
||||
<code class="sig-name descname">obj_type</code><em class="property"> = 'weapon'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand.obj_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'Empty Fists'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand.inventory_use_slot">
|
||||
<code class="sig-name descname">inventory_use_slot</code><em class="property"> = 'weapon_hand'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand.inventory_use_slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand.attack_type">
|
||||
<code class="sig-name descname">attack_type</code><em class="property"> = 'strength'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand.attack_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand.defense_type">
|
||||
<code class="sig-name descname">defense_type</code><em class="property"> = 'armor'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand.defense_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand.damage_roll">
|
||||
<code class="sig-name descname">damage_roll</code><em class="property"> = '1d4'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand.damage_roll" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand.quality">
|
||||
<code class="sig-name descname">quality</code><em class="property"> = 100000</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.WeaponEmptyHand.quality" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.objects.</code><code class="sig-name descname">EvAdventureWeapon</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/tutorials/evadventure/objects.html#EvAdventureWeapon"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject</span></code></a></p>
|
||||
<p>Base weapon class for all EvAdventure weapons.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.obj_type">
|
||||
<code class="sig-name descname">obj_type</code><em class="property"> = 'weapon'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.obj_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.inventory_use_slot">
|
||||
<code class="sig-name descname">inventory_use_slot</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.inventory_use_slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.quality">
|
||||
<code class="sig-name descname">quality</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.quality" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.attack_type">
|
||||
<code class="sig-name descname">attack_type</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.attack_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.defense_type">
|
||||
<code class="sig-name descname">defense_type</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.defense_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.damage_roll">
|
||||
<code class="sig-name descname">damage_roll</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.damage_roll" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureWeapon'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.objects.</code><code class="sig-name descname">EvAdventureRunestone</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/tutorials/evadventure/objects.html#EvAdventureRunestone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon</span></code></a>, <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable</span></code></a></p>
|
||||
<p>Base class for magic runestones. In _Knave_, every spell is represented by a rune stone
|
||||
that takes up an inventory slot. It is wielded as a weapon in order to create the specific
|
||||
magical effect provided by the stone. Normally each stone can only be used once per day but
|
||||
they are quite powerful (and scales with caster level).</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.obj_type">
|
||||
<code class="sig-name descname">obj_type</code><em class="property"> = (<ObjType.WEAPON: 'weapon'>, <ObjType.MAGIC: 'magic'>)</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.obj_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.inventory_use_slot">
|
||||
<code class="sig-name descname">inventory_use_slot</code><em class="property"> = 'two_handed_weapons'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.inventory_use_slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.quality">
|
||||
<code class="sig-name descname">quality</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.quality" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.attack_type">
|
||||
<code class="sig-name descname">attack_type</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.attack_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.defense_type">
|
||||
<code class="sig-name descname">defense_type</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.defense_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.damage_roll">
|
||||
<code class="sig-name descname">damage_roll</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.damage_roll" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.at_post_use">
|
||||
<code class="sig-name descname">at_post_use</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">user</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/tutorials/evadventure/objects.html#EvAdventureRunestone.at_post_use"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.at_post_use" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called after the spell was cast</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.refresh">
|
||||
<code class="sig-name descname">refresh</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/objects.html#EvAdventureRunestone.refresh"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.refresh" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.DoesNotExist" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.DoesNotExist</span></code></a>, <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.DoesNotExist" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureWeapon.MultipleObjectsReturned</span></code></a>, <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureConsumable.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureRunestone'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureRunestone.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.objects.</code><code class="sig-name descname">EvAdventureArmor</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/tutorials/evadventure/objects.html#EvAdventureArmor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject</span></code></a></p>
|
||||
<p>Base class for all wearable Armors.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.obj_type">
|
||||
<code class="sig-name descname">obj_type</code><em class="property"> = 'armor'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.obj_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.inventory_use_slot">
|
||||
<code class="sig-name descname">inventory_use_slot</code><em class="property"> = 'body'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.inventory_use_slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.armor">
|
||||
<code class="sig-name descname">armor</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.armor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.quality">
|
||||
<code class="sig-name descname">quality</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.quality" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Attribute property descriptor. Allows for specifying Attributes as Django-like ‘fields’
|
||||
on the class level. Note that while one can set a lock on the Attribute,
|
||||
there is no way to <em>check</em> said lock when accessing via the property - use
|
||||
the full AttributeHandler if you need to do access checks.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureObject.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureArmor'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureShield">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.objects.</code><code class="sig-name descname">EvAdventureShield</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/tutorials/evadventure/objects.html#EvAdventureShield"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureShield" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor</span></code></a></p>
|
||||
<p>Base class for all Shields.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureShield.obj_type">
|
||||
<code class="sig-name descname">obj_type</code><em class="property"> = 'shield'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureShield.obj_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureShield.inventory_use_slot">
|
||||
<code class="sig-name descname">inventory_use_slot</code><em class="property"> = 'shield_hand'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureShield.inventory_use_slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureShield.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureShield.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.DoesNotExist" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureShield.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureShield.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureShield.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.objects.EvAdventureShield'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureShield.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureShield.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureShield'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureShield.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.objects.</code><code class="sig-name descname">EvAdventureHelmet</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/tutorials/evadventure/objects.html#EvAdventureHelmet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor</span></code></a></p>
|
||||
<p>Base class for all Helmets.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet.obj_type">
|
||||
<code class="sig-name descname">obj_type</code><em class="property"> = 'helmet'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet.obj_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet.inventory_use_slot">
|
||||
<code class="sig-name descname">inventory_use_slot</code><em class="property"> = 'head'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet.inventory_use_slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.DoesNotExist" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.objects.EvAdventureArmor.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureHelmet'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.objects.EvAdventureHelmet.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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.npcs.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.npcs</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.quests.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.quests</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.tutorials.evadventure.objects.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.tutorials.evadventure.objects.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.quests.html" title="evennia.contrib.tutorials.evadventure.quests"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.npcs.html" title="evennia.contrib.tutorials.evadventure.npcs"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.objects</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,419 @@
|
|||
|
||||
<!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.tutorials.evadventure.quests — 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>
|
||||
<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.tutorials.evadventure.random_tables" href="evennia.contrib.tutorials.evadventure.random_tables.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.objects" href="evennia.contrib.tutorials.evadventure.objects.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.random_tables.html" title="evennia.contrib.tutorials.evadventure.random_tables"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.objects.html" title="evennia.contrib.tutorials.evadventure.objects"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.quests</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.tutorials.evadventure.quests">
|
||||
<span id="evennia-contrib-tutorials-evadventure-quests"></span><h1>evennia.contrib.tutorials.evadventure.quests<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.quests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>A simple quest system for EvAdventure.</p>
|
||||
<p>A quest is represented by a quest-handler sitting as
|
||||
.quest on a Character. Individual Quests are objects
|
||||
that track the state and can have multiple steps, each
|
||||
of which are checked off during the quest’s progress.</p>
|
||||
<p>The player can use the quest handler to track the
|
||||
progress of their quests.</p>
|
||||
<p>A quest ending can mean a reward or the start of
|
||||
another quest.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.quests.</code><code class="sig-name descname">EvAdventureQuest</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">quester</span></em>, <em class="sig-param"><span class="n">start_step</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/tutorials/evadventure/quests.html#EvAdventureQuest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest" 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 represents a single questing unit of quest.</p>
|
||||
<dl class="simple">
|
||||
<dt>Properties:</dt><dd><p>name (str): Main identifier for the quest.
|
||||
category (str, optional): This + name must be globally unique.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>it ends - it then pauses after the last completed step.</p>
|
||||
<p>Each step of the quest is represented by a <strong>.step_<stepname></strong> method. This should check
|
||||
the status of the quest-step and update the <strong>.current_step</strong> or call <strong>.complete()</strong>. There
|
||||
are also <strong>.help_<stepname></strong> which is either a class-level help string or a method
|
||||
returning a help text. All properties should be stored on the quester.</p>
|
||||
<p>Example:
|
||||
py
|
||||
class MyQuest(EvAdventureQuest):</p>
|
||||
<blockquote>
|
||||
<div><p>‘’’A quest with two steps that ar’’’</p>
|
||||
<p>start_step = “A”</p>
|
||||
<p>help_A = “You need a ‘_quest_A_flag’ on yourself to finish this step!”
|
||||
help_B = “Finally, you need more than 4 items in your inventory!”</p>
|
||||
<dl class="simple">
|
||||
<dt>def step_A(self, <a href="#id1"><span class="problematic" id="id2">*</span></a>args, <a href="#id3"><span class="problematic" id="id4">**</span></a>kwargs):</dt><dd><dl class="simple">
|
||||
<dt>if self.quester.db._quest_A_flag == True:</dt><dd><p>self.quester.msg(“Completed the first step of the quest.”)
|
||||
self.current_step = “end”
|
||||
self.progress()</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
<dt>def step_end(self, <a href="#id5"><span class="problematic" id="id6">*</span></a>args, <a href="#id7"><span class="problematic" id="id8">**</span></a>kwargs):</dt><dd><dl class="simple">
|
||||
<dt>if len(self.quester.contents) > 4:</dt><dd><p>self.quester.msg(“Quest complete!”)
|
||||
self.complete()</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = 'basequest'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.desc">
|
||||
<code class="sig-name descname">desc</code><em class="property"> = 'This is the base quest class'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.desc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.start_step">
|
||||
<code class="sig-name descname">start_step</code><em class="property"> = 'start'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.start_step" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.completed_text">
|
||||
<code class="sig-name descname">completed_text</code><em class="property"> = 'This quest is completed!'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.completed_text" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.abandoned_text">
|
||||
<code class="sig-name descname">abandoned_text</code><em class="property"> = 'This quest is abandoned.'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.abandoned_text" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.help_start">
|
||||
<code class="sig-name descname">help_start</code><em class="property"> = 'You need to start first'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.help_start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.help_end">
|
||||
<code class="sig-name descname">help_end</code><em class="property"> = 'You need to end the quest'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.help_end" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">quester</span></em>, <em class="sig-param"><span class="n">start_step</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/tutorials/evadventure/quests.html#EvAdventureQuest.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.__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.tutorials.evadventure.quests.EvAdventureQuest.questhandler">
|
||||
<em class="property">property </em><code class="sig-name descname">questhandler</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.questhandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.current_step">
|
||||
<em class="property">property </em><code class="sig-name descname">current_step</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.current_step" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.abandon">
|
||||
<code class="sig-name descname">abandon</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/quests.html#EvAdventureQuest.abandon"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.abandon" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Call when quest is abandoned.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.complete">
|
||||
<code class="sig-name descname">complete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/quests.html#EvAdventureQuest.complete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.complete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Call this to end the quest.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.progress">
|
||||
<code class="sig-name descname">progress</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/tutorials/evadventure/quests.html#EvAdventureQuest.progress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.progress" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is called whenever the environment expects a quest may need stepping. This will
|
||||
determine which quest-step we are on and run <strong>step_<stepname></strong>, which in turn will figure
|
||||
out if the step is complete or not.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>*args</strong> – Will be passed into the step method.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – <p>Will be passed into the step method.</p>
|
||||
</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.help">
|
||||
<code class="sig-name descname">help</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/quests.html#EvAdventureQuest.help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.help" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is used to get help (or a reminder) of what needs to be done to complete the current
|
||||
quest-step.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>str</em> – The help text for the current step.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.step_start">
|
||||
<code class="sig-name descname">step_start</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/tutorials/evadventure/quests.html#EvAdventureQuest.step_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.step_start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Example step that completes immediately.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.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/tutorials/evadventure/quests.html#EvAdventureQuest.cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest.cleanup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is called both when completing the quest, or when it is abandoned prematurely.
|
||||
Make sure to cleanup any quest-related data stored when following the quest.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.quests.</code><code class="sig-name descname">EvAdventureQuestHandler</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/tutorials/evadventure/quests.html#EvAdventureQuestHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler" 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 Character, as <strong>.quests</strong>.</p>
|
||||
<p>It’s initiated using a lazy property on the Character:</p>
|
||||
<p>@lazy_property
|
||||
def quests(self):</p>
|
||||
<blockquote>
|
||||
<div><p>return EvAdventureQuestHandler(self)</p>
|
||||
</div></blockquote>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.quest_storage_attribute_key">
|
||||
<code class="sig-name descname">quest_storage_attribute_key</code><em class="property"> = '_quests'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.quest_storage_attribute_key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.quest_storage_attribute_category">
|
||||
<code class="sig-name descname">quest_storage_attribute_category</code><em class="property"> = 'evadventure'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.quest_storage_attribute_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.__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/tutorials/evadventure/quests.html#EvAdventureQuestHandler.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.__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.tutorials.evadventure.quests.EvAdventureQuestHandler.has">
|
||||
<code class="sig-name descname">has</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">quest_key</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/quests.html#EvAdventureQuestHandler.has"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.has" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Check if a given quest is registered with the Character.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>quest_key</strong> (<em>str</em>) – The name of the quest to check for.</p></li>
|
||||
<li><p><strong>quest_category</strong> (<em>str</em><em>, </em><em>optional</em>) – Quest category, if any.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>bool</em> – If the character is following this quest or not.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.get">
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">quest_key</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/quests.html#EvAdventureQuestHandler.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the quest stored on character, if any.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>quest_key</strong> (<em>str</em>) – The name of the quest to check for.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>EvAdventureQuest or None</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>The quest stored, or None if</dt><dd><p>Character is not on this quest.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.add">
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">quest</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/quests.html#EvAdventureQuestHandler.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add a new quest</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>quest</strong> (<a class="reference internal" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest" title="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuest"><em>EvAdventureQuest</em></a>) – The quest class to start.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.remove">
|
||||
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">quest_key</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/quests.html#EvAdventureQuestHandler.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Remove a quest. If not complete, it will be abandoned.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>quest_key</strong> (<em>str</em>) – The quest to remove.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.get_help">
|
||||
<code class="sig-name descname">get_help</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">quest_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/tutorials/evadventure/quests.html#EvAdventureQuestHandler.get_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.get_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get help text for a quest or for all quests. The help text is
|
||||
a combination of the description of the quest and the help-text
|
||||
of the current step.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>quest_key</strong> (<em>str</em><em>, </em><em>optional</em>) – The quest-key. If not given, get help for all
|
||||
quests in handler.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>list</em> – Help texts, one for each quest, or only one if <strong>quest_key</strong> is given.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.progress">
|
||||
<code class="sig-name descname">progress</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">quest_key</span><span class="o">=</span><span class="default_value">None</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/tutorials/evadventure/quests.html#EvAdventureQuestHandler.progress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.quests.EvAdventureQuestHandler.progress" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Check progress of a given quest or all quests.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>quest_key</strong> (<em>str</em><em>, </em><em>optional</em>) – If given, check the progress of this quest (if we have it),
|
||||
otherwise check progress on all quests.</p></li>
|
||||
<li><p><strong>*args</strong> – Will be passed into each quest’s <strong>progress</strong> call.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – <p>Will be passed into each quest’s <strong>progress</strong> call.</p>
|
||||
</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.objects.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.objects</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.random_tables.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.random_tables</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.tutorials.evadventure.quests.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.tutorials.evadventure.quests.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.random_tables.html" title="evennia.contrib.tutorials.evadventure.random_tables"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.objects.html" title="evennia.contrib.tutorials.evadventure.objects"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.quests</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,144 @@
|
|||
|
||||
<!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.tutorials.evadventure.random_tables — 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>
|
||||
<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.tutorials.evadventure.rooms" href="evennia.contrib.tutorials.evadventure.rooms.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.quests" href="evennia.contrib.tutorials.evadventure.quests.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.rooms.html" title="evennia.contrib.tutorials.evadventure.rooms"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.quests.html" title="evennia.contrib.tutorials.evadventure.quests"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.random_tables</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.tutorials.evadventure.random_tables">
|
||||
<span id="evennia-contrib-tutorials-evadventure-random-tables"></span><h1>evennia.contrib.tutorials.evadventure.random_tables<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.random_tables" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Random tables - adopted from _Knave_.</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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.quests.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.quests</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.rooms.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.rooms</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.tutorials.evadventure.random_tables.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.tutorials.evadventure.random_tables.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.rooms.html" title="evennia.contrib.tutorials.evadventure.rooms"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.quests.html" title="evennia.contrib.tutorials.evadventure.quests"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.random_tables</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,249 @@
|
|||
|
||||
<!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.tutorials.evadventure.rooms — 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>
|
||||
<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.tutorials.evadventure.rules" href="evennia.contrib.tutorials.evadventure.rules.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.random_tables" href="evennia.contrib.tutorials.evadventure.random_tables.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.rules.html" title="evennia.contrib.tutorials.evadventure.rules"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.random_tables.html" title="evennia.contrib.tutorials.evadventure.random_tables"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.rooms</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.tutorials.evadventure.rooms">
|
||||
<span id="evennia-contrib-tutorials-evadventure-rooms"></span><h1>evennia.contrib.tutorials.evadventure.rooms<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.rooms" title="Permalink to this headline">¶</a></h1>
|
||||
<p>EvAdventure rooms.</p>
|
||||
<p>The base EvAdventure room has a modified display header that shows a little mini-map.</p>
|
||||
<p>All EvAdventure rooms inherit from this room, and it is integral to combat as well as
|
||||
the dungeon generation. But one can also mix with other non-EvAdventure rooms (you will
|
||||
just not be able to fight in them).</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.rooms.</code><code class="sig-name descname">EvAdventureRoom</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/tutorials/evadventure/rooms.html#EvAdventureRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom" 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>Simple room supporting some EvAdventure-specifics.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.allow_combat">
|
||||
<code class="sig-name descname">allow_combat</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.allow_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.allow_pvp">
|
||||
<code class="sig-name descname">allow_pvp</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.allow_pvp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.allow_death">
|
||||
<code class="sig-name descname">allow_death</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.allow_death" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.format_appearance">
|
||||
<code class="sig-name descname">format_appearance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">appearance</span></em>, <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/tutorials/evadventure/rooms.html#EvAdventureRoom.format_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.format_appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Don’t left-strip the appearance string</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.get_display_header">
|
||||
<code class="sig-name descname">get_display_header</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/tutorials/evadventure/rooms.html#EvAdventureRoom.get_display_header"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.get_display_header" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Display the current location as a mini-map.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.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.tutorials.evadventure.rooms.EvAdventureRoom.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.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.tutorials.evadventure.rooms.EvAdventureRoom.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventureRoom'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.typename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.rooms.</code><code class="sig-name descname">EvAdventurePvPRoom</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/tutorials/evadventure/rooms.html#EvAdventurePvPRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom" title="evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom</span></code></a></p>
|
||||
<p>Room where PvP can happen, but noone gets killed.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom.allow_combat">
|
||||
<code class="sig-name descname">allow_combat</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom.allow_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom.allow_pvp">
|
||||
<code class="sig-name descname">allow_pvp</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom.allow_pvp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom.get_display_footer">
|
||||
<code class="sig-name descname">get_display_footer</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/tutorials/evadventure/rooms.html#EvAdventurePvPRoom.get_display_footer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom.get_display_footer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Show if the room is ‘cleared’ or not as part of its description.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.DoesNotExist" title="evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.DoesNotExist</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom.MultipleObjectsReturned">
|
||||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.MultipleObjectsReturned" title="evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.rooms.EvAdventureRoom.MultipleObjectsReturned</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom.path">
|
||||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom.path" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom.typename">
|
||||
<code class="sig-name descname">typename</code><em class="property"> = 'EvAdventurePvPRoom'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rooms.EvAdventurePvPRoom.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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.random_tables.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.random_tables</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.rules.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.rules</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.tutorials.evadventure.rooms.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.tutorials.evadventure.rooms.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.rules.html" title="evennia.contrib.tutorials.evadventure.rules"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.random_tables.html" title="evennia.contrib.tutorials.evadventure.random_tables"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.rooms</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,345 @@
|
|||
|
||||
<!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.tutorials.evadventure.rules — 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>
|
||||
<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.tutorials.evadventure.shops" href="evennia.contrib.tutorials.evadventure.shops.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.rooms" href="evennia.contrib.tutorials.evadventure.rooms.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.shops.html" title="evennia.contrib.tutorials.evadventure.shops"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.rooms.html" title="evennia.contrib.tutorials.evadventure.rooms"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.rules</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.tutorials.evadventure.rules">
|
||||
<span id="evennia-contrib-tutorials-evadventure-rules"></span><h1>evennia.contrib.tutorials.evadventure.rules<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.rules" title="Permalink to this headline">¶</a></h1>
|
||||
<p>MUD ruleset based on the _Knave_ OSR tabletop RPG by Ben Milton (modified for MUD use).</p>
|
||||
<p>The rules are divided into a set of classes. While each class (except chargen) could
|
||||
also have been stand-alone functions, having them as classes makes it a little easier
|
||||
to use them as the base for your own variation (tweaking values etc).</p>
|
||||
<ul class="simple">
|
||||
<li><p>Roll-engine: Class with methods for making all dice rolls needed by the rules. Knave only
|
||||
has a few resolution rolls, but we define helper methods for different actions the
|
||||
character will be able to do in-code.</p></li>
|
||||
<li><p>Character generation - this is a container used for holding, tweaking and setting
|
||||
all character data during character generation. At the end it will save itself
|
||||
onto the Character for permanent storage.</p></li>
|
||||
<li><p>Improvement - this container holds rules used with experience to improve the
|
||||
character over time.</p></li>
|
||||
<li><p>Charsheet - a container with tools for visually displaying the character sheet in-game.</p></li>
|
||||
</ul>
|
||||
<p>This module presents several singletons to import</p>
|
||||
<ul class="simple">
|
||||
<li><p><strong>dice</strong> - the <strong>EvAdventureRollEngine</strong> for all random resolution and table-rolling.</p></li>
|
||||
<li><p><strong>character_sheet</strong> - the <strong>EvAdventureCharacterSheet</strong> visualizer.</p></li>
|
||||
<li><p><strong>improvement</strong> - the EvAdventureImprovement** class for handling char xp and leveling.</p></li>
|
||||
</ul>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.rules.</code><code class="sig-name descname">EvAdventureRollEngine</code><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/rules.html#EvAdventureRollEngine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine" 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 groups all dice rolls of EvAdventure. These could all have been normal functions, but we
|
||||
are group them in a class to make them easier to partially override and replace later.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.roll">
|
||||
<code class="sig-name descname">roll</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">roll_string</span></em>, <em class="sig-param"><span class="n">max_number</span><span class="o">=</span><span class="default_value">10</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/rules.html#EvAdventureRollEngine.roll"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.roll" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>NOTE: In evennia/contribs/rpg/dice/ is a more powerful dice roller with
|
||||
more features, such as modifiers, secret rolls etc. This is much simpler and only
|
||||
gets a simple sum of normal rpg-dice.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>roll_string</strong> (<em>str</em>) – A roll using standard rpg syntax, <number>d<diesize>, like
|
||||
1d6, 2d10 etc. Max die-size is 1000.</p></li>
|
||||
<li><p><strong>max_number</strong> (<em>int</em>) – The max number of dice to roll. Defaults to 10, which is usually
|
||||
more than enough.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>int</em> – The rolled result - sum of all dice rolled.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raises</dt>
|
||||
<dd class="field-odd"><p><strong>TypeError</strong> – If roll_string is not on the right format or otherwise doesn’t validate.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>Since we may see user input to this function, we make sure to validate the inputs (we
|
||||
wouldn’t bother much with that if it was just for developer use).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.roll_with_advantage_or_disadvantage">
|
||||
<code class="sig-name descname">roll_with_advantage_or_disadvantage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">advantage</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">disadvantage</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/tutorials/evadventure/rules.html#EvAdventureRollEngine.roll_with_advantage_or_disadvantage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.roll_with_advantage_or_disadvantage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Base roll of d20, or 2d20, based on dis/advantage given.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>bonus</strong> (<em>int</em>) – The ability bonus to apply, like strength or charisma.</p></li>
|
||||
<li><p><strong>advantage</strong> (<em>bool</em>) – Roll 2d20 and use the bigger number.</p></li>
|
||||
<li><p><strong>disadvantage</strong> (<em>bool</em>) – Roll 2d20 and use the smaller number.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>Disadvantage and advantage cancel each other out.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.saving_throw">
|
||||
<code class="sig-name descname">saving_throw</code><span class="sig-paren">(</span><em class="sig-param">character</em>, <em class="sig-param">bonus_type=<Ability.STR: 'strength'></em>, <em class="sig-param">target=15</em>, <em class="sig-param">advantage=False</em>, <em class="sig-param">disadvantage=False</em>, <em class="sig-param">modifier=0</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/rules.html#EvAdventureRollEngine.saving_throw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.saving_throw" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A saving throw without a clear enemy to beat. In _Knave_ all unopposed saving
|
||||
throws always tries to beat 15, so (d20 + bonus + modifier) > 15.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>character</strong> (<em>Object</em>) – The one attempting to save themselves.</p></li>
|
||||
<li><p><strong>bonus_type</strong> (<em>enum.Ability</em>) – The ability bonus to apply, like strength or
|
||||
charisma.</p></li>
|
||||
<li><p><strong>target</strong> (<em>int</em><em>, </em><em>optional</em>) – Used for opposed throws (in Knave any regular
|
||||
saving through must always beat 15).</p></li>
|
||||
<li><p><strong>advantage</strong> (<em>bool</em><em>, </em><em>optional</em>) – Roll 2d20 and use the bigger number.</p></li>
|
||||
<li><p><strong>disadvantage</strong> (<em>bool</em><em>, </em><em>optional</em>) – Roll 2d20 and use the smaller number.</p></li>
|
||||
<li><p><strong>modifier</strong> (<em>int</em><em>, </em><em>optional</em>) – An additional +/- modifier to the roll.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>tuple</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>A tuple <strong>(bool, str, str)</strong>. The bool indicates if the save was passed or not.</dt><dd><p>The second element is the quality of the roll - None (normal),
|
||||
“critical fail” and “critical success”. Last element is a text detailing
|
||||
the roll, for display purposes.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>Advantage and disadvantage cancel each other out.</p>
|
||||
<p class="rubric">Example</p>
|
||||
<p>Trying to overcome the effects of poison, roll d20 + Constitution-bonus above 15.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.opposed_saving_throw">
|
||||
<code class="sig-name descname">opposed_saving_throw</code><span class="sig-paren">(</span><em class="sig-param">attacker</em>, <em class="sig-param">defender</em>, <em class="sig-param">attack_type=<Ability.STR: 'strength'></em>, <em class="sig-param">defense_type=<Ability.ARMOR: 'armor'></em>, <em class="sig-param">advantage=False</em>, <em class="sig-param">disadvantage=False</em>, <em class="sig-param">modifier=0</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/rules.html#EvAdventureRollEngine.opposed_saving_throw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.opposed_saving_throw" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>An saving throw that tries to beat an active opposing side.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>attacker</strong> (<em>Character</em>) – The attacking party.</p></li>
|
||||
<li><p><strong>defender</strong> (<em>Character</em>) – The one defending.</p></li>
|
||||
<li><p><strong>attack_type</strong> (<em>str</em>) – Which ability to use in the attack, like ‘strength’ or ‘willpower’.
|
||||
Minimum is always 1.</p></li>
|
||||
<li><p><strong>defense_type</strong> (<em>str</em>) – Which ability to defend with, in addition to ‘armor’.
|
||||
Minimum is always 11 (bonus + 10 is always the defense in _Knave_).</p></li>
|
||||
<li><p><strong>advantage</strong> (<em>bool</em>) – Roll 2d20 and use the bigger number.</p></li>
|
||||
<li><p><strong>disadvantage</strong> (<em>bool</em>) – Roll 2d20 and use the smaller number.</p></li>
|
||||
<li><p><strong>modifier</strong> (<em>int</em>) – An additional +/- modifier to the roll.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>tuple</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>(bool, str, str): If the attack succeed or not. The second element is the</dt><dd><p>quality of the roll - None (normal), “critical fail” and “critical success”. Last
|
||||
element is a text that summarizes the details of the roll.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>Advantage and disadvantage cancel each other out.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.roll_random_table">
|
||||
<code class="sig-name descname">roll_random_table</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">dieroll</span></em>, <em class="sig-param"><span class="n">table_choices</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/rules.html#EvAdventureRollEngine.roll_random_table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.roll_random_table" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Make a roll on a random table.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>dieroll</strong> (<em>str</em>) – The dice to roll, like 1d6, 1d20, 3d6 etc).</p></li>
|
||||
<li><p><strong>table_choices</strong> (<em>iterable</em>) – If a list of single elements, the die roll
|
||||
should fully encompass the table, like a 1d20 roll for a table
|
||||
with 20 elements. If each element is a tuple, the first element
|
||||
of the tuple is assumed to be a string ‘X-Y’ indicating the
|
||||
range of values that should match the roll.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>Any</em> – The result of the random roll.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Example</p>
|
||||
<p><strong>roll table_choices = [(‘1-5’, “Blue”), (‘6-9’: “Red”), (‘10’, “Purple”)]</strong></p>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>If the roll is outside of the listing, the closest edge value is used.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.morale_check">
|
||||
<code class="sig-name descname">morale_check</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">defender</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/rules.html#EvAdventureRollEngine.morale_check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.morale_check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A morale check is done for NPCs/monsters. It’s done with a 2d6 against
|
||||
their morale.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>defender</strong> (<em>NPC</em>) – The entity trying to defend its morale.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>bool</em> – False if morale roll failed, True otherwise.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.heal_from_rest">
|
||||
<code class="sig-name descname">heal_from_rest</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/tutorials/evadventure/rules.html#EvAdventureRollEngine.heal_from_rest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.heal_from_rest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A meal and a full night’s rest allow for regaining 1d8 + Const bonus HP.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>character</strong> (<em>Character</em>) – The one resting.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.death_map">
|
||||
<code class="sig-name descname">death_map</code><em class="property"> = {'addled': 'intelligence', 'disfigured': 'charisma', 'rattled': 'wisdom', 'sickly': 'constitution', 'unsteady': 'dexterity', 'weakened': 'strength'}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.death_map" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.roll_death">
|
||||
<code class="sig-name descname">roll_death</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/tutorials/evadventure/rules.html#EvAdventureRollEngine.roll_death"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.rules.EvAdventureRollEngine.roll_death" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Happens when hitting <= 0 hp. unless dead,</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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.rooms.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.rooms</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.shops.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.shops</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.tutorials.evadventure.rules.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.tutorials.evadventure.rules.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.shops.html" title="evennia.contrib.tutorials.evadventure.shops"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.rooms.html" title="evennia.contrib.tutorials.evadventure.rooms"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.rules</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,310 @@
|
|||
|
||||
<!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.tutorials.evadventure.shops — 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>
|
||||
<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.tutorials.evadventure.utils" href="evennia.contrib.tutorials.evadventure.utils.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.rules" href="evennia.contrib.tutorials.evadventure.rules.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.utils.html" title="evennia.contrib.tutorials.evadventure.utils"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.rules.html" title="evennia.contrib.tutorials.evadventure.rules"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.shops</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.tutorials.evadventure.shops">
|
||||
<span id="evennia-contrib-tutorials-evadventure-shops"></span><h1>evennia.contrib.tutorials.evadventure.shops<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.shops" title="Permalink to this headline">¶</a></h1>
|
||||
<p>EvAdventure Shop system.</p>
|
||||
<p>A shop is run by an NPC. It can provide one or more of several possible services:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Buy from a pre-set list of (possibly randomized) items. Cost is based on the item’s value,
|
||||
adjusted by how stingy the shopkeeper is. When bought this way, the item is
|
||||
generated on the fly and passed to the player character’s inventory. Inventory files are
|
||||
a list of prototypes, normally from a prototype-file. A random selection of items from each
|
||||
inventory file is available.</p></li>
|
||||
<li><p>Sell items to the shop for a certain percent of their value. One could imagine being able
|
||||
to buy back items again, but we will instead _destroy_ sold items, so as to remove them
|
||||
from circulation. In-game we can say it’s because the merchants collect the best stuff
|
||||
to sell to collectors in the big city later. Each merchant buys a certain subset of items
|
||||
based on their tags.</p></li>
|
||||
<li><p>Buy a service. For a cost, a certain action is performed for the character; this applies
|
||||
immediately when bought. The most notable services are healing and converting coin to XP.</p></li>
|
||||
<li><p>Buy rumors - this is echoed to the player for a price. Different merchants could have
|
||||
different rumors (or randomized ones).</p></li>
|
||||
<li><p>Quest - gain or hand in a quest for a merchant.</p></li>
|
||||
</ul>
|
||||
<p>All shops are menu-driven. One starts talking to the npc and will then end up in their shop
|
||||
interface.</p>
|
||||
<p>This is a series of menu nodes meant to be added as a mapping via
|
||||
<strong>EvAdventureShopKeeper.create(menudata={},…)</strong>.</p>
|
||||
<p>To make this pluggable, the shopkeeper start page will analyze the available nodes
|
||||
and auto-add options to all nodes in the three named <strong>node_start_*</strong>. The last part of the
|
||||
node name will be the name of the option capitalized, with underscores replaced by spaces, so
|
||||
<strong>node_start_sell_items</strong> will become a top-level option <strong>Sell items</strong>.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.shops.</code><code class="sig-name descname">BuyItem</code><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/shops.html#BuyItem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem" 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>Storage container for storing generic info about an item for sale. This means it can be used
|
||||
both for real objects and for prototypes without constantly having to track which is which.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.key">
|
||||
<code class="sig-name descname">key</code><em class="property"> = ''</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.desc">
|
||||
<code class="sig-name descname">desc</code><em class="property"> = ''</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.desc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.obj_type">
|
||||
<code class="sig-name descname">obj_type</code><em class="property"> = 'gear'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.obj_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.size">
|
||||
<code class="sig-name descname">size</code><em class="property"> = 1</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.size" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.value">
|
||||
<code class="sig-name descname">value</code><em class="property"> = 0</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.value" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.use_slot">
|
||||
<code class="sig-name descname">use_slot</code><em class="property"> = 'backpack'</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.use_slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.uses">
|
||||
<code class="sig-name descname">uses</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.uses" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.quality">
|
||||
<code class="sig-name descname">quality</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.quality" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.attack_type">
|
||||
<code class="sig-name descname">attack_type</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.attack_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.defense_type">
|
||||
<code class="sig-name descname">defense_type</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.defense_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.damage_roll">
|
||||
<code class="sig-name descname">damage_roll</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.damage_roll" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.obj">
|
||||
<code class="sig-name descname">obj</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.obj" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.prototype">
|
||||
<code class="sig-name descname">prototype</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.prototype" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.create_from_obj">
|
||||
<em class="property">static </em><code class="sig-name descname">create_from_obj</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">shopkeeper</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/shops.html#BuyItem.create_from_obj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.create_from_obj" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Build a new BuyItem container from a real db obj.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>obj</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><em>EvAdventureObject</em></a>) – An object to analyze.</p></li>
|
||||
<li><p><strong>shopkeeper</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.npcs.html#evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper" title="evennia.contrib.tutorials.evadventure.npcs.EvAdventureShopKeeper"><em>EvAdventureShopKeeper</em></a>) – The shopkeeper.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>BuyItem</em> – A general representation of the original data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.create_from_prototype">
|
||||
<em class="property">static </em><code class="sig-name descname">create_from_prototype</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">self</span></em>, <em class="sig-param"><span class="n">prototype_or_key</span></em>, <em class="sig-param"><span class="n">shopkeeper</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/shops.html#BuyItem.create_from_prototype"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.create_from_prototype" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Build a new BuyItem container from a prototype.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>prototype</strong> (<em>dict</em><em> or </em><em>key</em>) – An Evennia prototype dict or the key of one
|
||||
registered with the system. This is assumed to be a full prototype,
|
||||
including having parsed and included parentage.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>BuyItem</em> – A general representation of the original data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.get_detail">
|
||||
<code class="sig-name descname">get_detail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/shops.html#BuyItem.get_detail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.get_detail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get more info when looking at the item.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.to_obj">
|
||||
<code class="sig-name descname">to_obj</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/shops.html#BuyItem.to_obj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.to_obj" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Convert this into an actual database object that we can trade. This either means
|
||||
using the stored <strong>.prototype</strong> to spawn a new instance of the object, or to
|
||||
use the <strong>.obj</strong> reference to get the already existing object.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.BuyItem.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → None<a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.BuyItem.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.node_confirm_buy">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.shops.</code><code class="sig-name descname">node_confirm_buy</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/tutorials/evadventure/shops.html#node_confirm_buy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.node_confirm_buy" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Menu node reached when a user selects an item in the buy menu. The <strong>item</strong> passed
|
||||
along in <strong>**kwargs</strong> is the selected item (see <strong>_select_ware_to_buy</strong>, where this is injected).</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.shops.node_confirm_sell">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.shops.</code><code class="sig-name descname">node_confirm_sell</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/tutorials/evadventure/shops.html#node_confirm_sell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.shops.node_confirm_sell" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>In this node we confirm the sell by first investigating the item we are about to sell.</p>
|
||||
<p>We have <strong>item</strong> and <strong>value</strong> available in kwargs here, added by <strong>_select_ware_to_sell</strong> earler.</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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.rules.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.rules</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.utils.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.utils</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.tutorials.evadventure.shops.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.tutorials.evadventure.shops.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.utils.html" title="evennia.contrib.tutorials.evadventure.utils"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.rules.html" title="evennia.contrib.tutorials.evadventure.rules"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.shops</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.tutorials.evadventure.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>
|
||||
<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.tutorials.evadventure.tests.mixins" href="evennia.contrib.tutorials.evadventure.tests.mixins.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.utils" href="evennia.contrib.tutorials.evadventure.utils.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.mixins.html" title="evennia.contrib.tutorials.evadventure.tests.mixins"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.utils.html" title="evennia.contrib.tutorials.evadventure.utils"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.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.tutorials.evadventure.tests">
|
||||
<span id="evennia-contrib-tutorials-evadventure-tests"></span><h1>evennia.contrib.tutorials.evadventure.tests<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.mixins.html">evennia.contrib.tutorials.evadventure.tests.mixins</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_characters.html">evennia.contrib.tutorials.evadventure.tests.test_characters</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_combat.html">evennia.contrib.tutorials.evadventure.tests.test_combat</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_commands.html">evennia.contrib.tutorials.evadventure.tests.test_commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_dungeon.html">evennia.contrib.tutorials.evadventure.tests.test_dungeon</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_equipment.html">evennia.contrib.tutorials.evadventure.tests.test_equipment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_quests.html">evennia.contrib.tutorials.evadventure.tests.test_quests</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_rules.html">evennia.contrib.tutorials.evadventure.tests.test_rules</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_utils.html">evennia.contrib.tutorials.evadventure.tests.test_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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.utils.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.utils</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.mixins.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.tests.mixins</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.tutorials.evadventure.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.tutorials.evadventure.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.mixins.html" title="evennia.contrib.tutorials.evadventure.tests.mixins"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.utils.html" title="evennia.contrib.tutorials.evadventure.utils"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.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,158 @@
|
|||
|
||||
<!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.tutorials.evadventure.tests.mixins — 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>
|
||||
<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.tutorials.evadventure.tests.test_characters" href="evennia.contrib.tutorials.evadventure.tests.test_characters.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.tests" href="evennia.contrib.tutorials.evadventure.tests.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_characters.html" title="evennia.contrib.tutorials.evadventure.tests.test_characters"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.html" title="evennia.contrib.tutorials.evadventure.tests"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" accesskey="U">evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.mixins</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.tutorials.evadventure.tests.mixins">
|
||||
<span id="evennia-contrib-tutorials-evadventure-tests-mixins"></span><h1>evennia.contrib.tutorials.evadventure.tests.mixins<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.tests.mixins" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Helpers for testing evadventure modules.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.tests.mixins.</code><code class="sig-name descname">EvAdventureMixin</code><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/mixins.html#EvAdventureMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin" 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>Provides a set of pre-made characters.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin.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/tutorials/evadventure/tests/mixins.html#EvAdventureMixin.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin.setUp" 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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.tests</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_characters.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.tests.test_characters</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.tutorials.evadventure.tests.mixins.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.tutorials.evadventure.tests.mixins.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_characters.html" title="evennia.contrib.tutorials.evadventure.tests.test_characters"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.html" title="evennia.contrib.tutorials.evadventure.tests"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" >evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.mixins</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,179 @@
|
|||
|
||||
<!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.tutorials.evadventure.tests.test_characters — 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>
|
||||
<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.tutorials.evadventure.tests.test_combat" href="evennia.contrib.tutorials.evadventure.tests.test_combat.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.tests.mixins" href="evennia.contrib.tutorials.evadventure.tests.mixins.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_combat.html" title="evennia.contrib.tutorials.evadventure.tests.test_combat"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.mixins.html" title="evennia.contrib.tutorials.evadventure.tests.mixins"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" accesskey="U">evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_characters</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.tutorials.evadventure.tests.test_characters">
|
||||
<span id="evennia-contrib-tutorials-evadventure-tests-test-characters"></span><h1>evennia.contrib.tutorials.evadventure.tests.test_characters<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.tests.test_characters" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Test characters.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_characters.TestCharacters">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.tests.test_characters.</code><code class="sig-name descname">TestCharacters</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/tutorials/evadventure/tests/test_characters.html#TestCharacters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_characters.TestCharacters" 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.tutorials.evadventure.tests.test_characters.TestCharacters.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/tutorials/evadventure/tests/test_characters.html#TestCharacters.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_characters.TestCharacters.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.tutorials.evadventure.tests.test_characters.TestCharacters.test_abilities">
|
||||
<code class="sig-name descname">test_abilities</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_characters.html#TestCharacters.test_abilities"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_characters.TestCharacters.test_abilities" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_characters.TestCharacters.test_heal">
|
||||
<code class="sig-name descname">test_heal</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_characters.html#TestCharacters.test_heal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_characters.TestCharacters.test_heal" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Make sure we don’t heal too much</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_characters.TestCharacters.test_at_damage">
|
||||
<code class="sig-name descname">test_at_damage</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_characters.html#TestCharacters.test_at_damage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_characters.TestCharacters.test_at_damage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_characters.TestCharacters.test_at_pay">
|
||||
<code class="sig-name descname">test_at_pay</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_characters.html#TestCharacters.test_at_pay"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_characters.TestCharacters.test_at_pay" 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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.mixins.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.tests.mixins</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_combat.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.tests.test_combat</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.tutorials.evadventure.tests.test_characters.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.tutorials.evadventure.tests.test_characters.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_combat.html" title="evennia.contrib.tutorials.evadventure.tests.test_combat"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.mixins.html" title="evennia.contrib.tutorials.evadventure.tests.mixins"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" >evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_characters</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,307 @@
|
|||
|
||||
<!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.tutorials.evadventure.tests.test_combat — 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>
|
||||
<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.tutorials.evadventure.tests.test_commands" href="evennia.contrib.tutorials.evadventure.tests.test_commands.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.tests.test_characters" href="evennia.contrib.tutorials.evadventure.tests.test_characters.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_commands.html" title="evennia.contrib.tutorials.evadventure.tests.test_commands"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_characters.html" title="evennia.contrib.tutorials.evadventure.tests.test_characters"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" accesskey="U">evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_combat</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.tutorials.evadventure.tests.test_combat">
|
||||
<span id="evennia-contrib-tutorials-evadventure-tests-test-combat"></span><h1>evennia.contrib.tutorials.evadventure.tests.test_combat<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.tests.test_combat" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Test EvAdventure combat.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.tests.test_combat.</code><code class="sig-name descname">EvAdventureTurnbasedCombatHandlerTest</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/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.mixins.html#evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin" title="evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin</span></code></a>, <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 methods on the turn-based combat handler.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.maxDiff">
|
||||
<code class="sig-name descname">maxDiff</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.maxDiff" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.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/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.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.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.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/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.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.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_remove_combatant">
|
||||
<code class="sig-name descname">test_remove_combatant</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.test_remove_combatant"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_remove_combatant" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_start_turn">
|
||||
<code class="sig-name descname">test_start_turn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.test_start_turn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_start_turn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_end_of_turn__empty">
|
||||
<code class="sig-name descname">test_end_of_turn__empty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.test_end_of_turn__empty"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_end_of_turn__empty" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_add_combatant">
|
||||
<code class="sig-name descname">test_add_combatant</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.test_add_combatant"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_add_combatant" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_start_combat">
|
||||
<code class="sig-name descname">test_start_combat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.test_start_combat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_start_combat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_combat_summary">
|
||||
<code class="sig-name descname">test_combat_summary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.test_combat_summary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_combat_summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.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/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.test_msg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_msg" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_gain_advantage">
|
||||
<code class="sig-name descname">test_gain_advantage</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.test_gain_advantage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_gain_advantage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_gain_disadvantage">
|
||||
<code class="sig-name descname">test_gain_disadvantage</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.test_gain_disadvantage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_gain_disadvantage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_flee">
|
||||
<code class="sig-name descname">test_flee</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.test_flee"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_flee" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_unflee">
|
||||
<code class="sig-name descname">test_unflee</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.test_unflee"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_unflee" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_register_and_run_action">
|
||||
<code class="sig-name descname">test_register_and_run_action</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.test_register_and_run_action"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_register_and_run_action" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_get_available_actions">
|
||||
<code class="sig-name descname">test_get_available_actions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatHandlerTest.test_get_available_actions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_get_available_actions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.tests.test_combat.</code><code class="sig-name descname">EvAdventureTurnbasedCombatActionTest</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/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatActionTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.mixins.html#evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin" title="evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin</span></code></a>, <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 actions in turn_based combat.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.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/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatActionTest.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.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.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_do_nothing">
|
||||
<code class="sig-name descname">test_do_nothing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatActionTest.test_do_nothing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_do_nothing" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_attack__miss">
|
||||
<code class="sig-name descname">test_attack__miss</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatActionTest.test_attack__miss"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_attack__miss" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_attack__success__still_alive">
|
||||
<code class="sig-name descname">test_attack__success__still_alive</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatActionTest.test_attack__success__still_alive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_attack__success__still_alive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_attack__success__kill">
|
||||
<code class="sig-name descname">test_attack__success__kill</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatActionTest.test_attack__success__kill"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_attack__success__kill" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_stunt_fail">
|
||||
<code class="sig-name descname">test_stunt_fail</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatActionTest.test_stunt_fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_stunt_fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_stunt_advantage__success">
|
||||
<code class="sig-name descname">test_stunt_advantage__success</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatActionTest.test_stunt_advantage__success"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_stunt_advantage__success" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_stunt_disadvantage__success">
|
||||
<code class="sig-name descname">test_stunt_disadvantage__success</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatActionTest.test_stunt_disadvantage__success"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_stunt_disadvantage__success" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_use_item">
|
||||
<code class="sig-name descname">test_use_item</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatActionTest.test_use_item"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_use_item" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use up a potion during combat.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_swap_wielded_weapon_or_spell">
|
||||
<code class="sig-name descname">test_swap_wielded_weapon_or_spell</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatActionTest.test_swap_wielded_weapon_or_spell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_swap_wielded_weapon_or_spell" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>First draw a weapon (from empty fists), then swap that out to another weapon, then
|
||||
swap to a spell rune.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_flee__success">
|
||||
<code class="sig-name descname">test_flee__success</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatActionTest.test_flee__success"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_flee__success" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test fleeing twice, leading to leaving combat.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_flee__blocked">
|
||||
<code class="sig-name descname">test_flee__blocked</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_combat.html#EvAdventureTurnbasedCombatActionTest.test_flee__blocked"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatActionTest.test_flee__blocked" 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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_characters.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.tests.test_characters</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_commands.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.tests.test_commands</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.tutorials.evadventure.tests.test_combat.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.tutorials.evadventure.tests.test_combat.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_commands.html" title="evennia.contrib.tutorials.evadventure.tests.test_commands"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_characters.html" title="evennia.contrib.tutorials.evadventure.tests.test_characters"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" >evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_combat</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,193 @@
|
|||
|
||||
<!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.tutorials.evadventure.tests.test_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>
|
||||
<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>
|
||||
<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.tutorials.evadventure.tests.test_dungeon" href="evennia.contrib.tutorials.evadventure.tests.test_dungeon.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.tests.test_combat" href="evennia.contrib.tutorials.evadventure.tests.test_combat.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_dungeon.html" title="evennia.contrib.tutorials.evadventure.tests.test_dungeon"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_combat.html" title="evennia.contrib.tutorials.evadventure.tests.test_combat"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" accesskey="U">evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_commands</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.tutorials.evadventure.tests.test_commands">
|
||||
<span id="evennia-contrib-tutorials-evadventure-tests-test-commands"></span><h1>evennia.contrib.tutorials.evadventure.tests.test_commands<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.tests.test_commands" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Test the EvAdventure commands.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.tests.test_commands.</code><code class="sig-name descname">TestEvAdventureCommands</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/tutorials/evadventure/tests/test_commands.html#TestEvAdventureCommands"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.mixins.html#evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin" title="evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin</span></code></a>, <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaCommandTest" title="evennia.utils.test_resources.BaseEvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaCommandTest</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.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/tutorials/evadventure/tests/test_commands.html#TestEvAdventureCommands.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.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.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.test_inventory">
|
||||
<code class="sig-name descname">test_inventory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_commands.html#TestEvAdventureCommands.test_inventory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.test_inventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.test_attack">
|
||||
<code class="sig-name descname">test_attack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_join_combat</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_commands.html#TestEvAdventureCommands.test_attack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.test_attack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.test_wield_or_wear">
|
||||
<code class="sig-name descname">test_wield_or_wear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_commands.html#TestEvAdventureCommands.test_wield_or_wear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.test_wield_or_wear" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.test_remove">
|
||||
<code class="sig-name descname">test_remove</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_commands.html#TestEvAdventureCommands.test_remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.test_remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.test_give__coins">
|
||||
<code class="sig-name descname">test_give__coins</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_commands.html#TestEvAdventureCommands.test_give__coins"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.test_give__coins" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.test_give__item">
|
||||
<code class="sig-name descname">test_give__item</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_EvMenu</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_commands.html#TestEvAdventureCommands.test_give__item"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.test_give__item" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.test_talk">
|
||||
<code class="sig-name descname">test_talk</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_EvMenu</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_commands.html#TestEvAdventureCommands.test_talk"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_commands.TestEvAdventureCommands.test_talk" 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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_combat.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.tests.test_combat</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_dungeon.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.tests.test_dungeon</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.tutorials.evadventure.tests.test_commands.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.tutorials.evadventure.tests.test_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>
|
||||
</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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_dungeon.html" title="evennia.contrib.tutorials.evadventure.tests.test_dungeon"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_combat.html" title="evennia.contrib.tutorials.evadventure.tests.test_combat"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" >evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_commands</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,171 @@
|
|||
|
||||
<!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.tutorials.evadventure.tests.test_dungeon — 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>
|
||||
<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.tutorials.evadventure.tests.test_equipment" href="evennia.contrib.tutorials.evadventure.tests.test_equipment.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.tests.test_commands" href="evennia.contrib.tutorials.evadventure.tests.test_commands.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_equipment.html" title="evennia.contrib.tutorials.evadventure.tests.test_equipment"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_commands.html" title="evennia.contrib.tutorials.evadventure.tests.test_commands"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" accesskey="U">evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_dungeon</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.tutorials.evadventure.tests.test_dungeon">
|
||||
<span id="evennia-contrib-tutorials-evadventure-tests-test-dungeon"></span><h1>evennia.contrib.tutorials.evadventure.tests.test_dungeon<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.tests.test_dungeon" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Test Dungeon orchestrator / procedurally generated dungeon rooms.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_dungeon.TestDungeon">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.tests.test_dungeon.</code><code class="sig-name descname">TestDungeon</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/tutorials/evadventure/tests/test_dungeon.html#TestDungeon"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_dungeon.TestDungeon" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.mixins.html#evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin" title="evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin</span></code></a>, <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 with a starting room and a character moving through the dungeon,
|
||||
generating more and more rooms as they go.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_dungeon.TestDungeon.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/tutorials/evadventure/tests/test_dungeon.html#TestDungeon.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_dungeon.TestDungeon.setUp" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a start room with exits leading away from it</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_dungeon.TestDungeon.test_start_room">
|
||||
<code class="sig-name descname">test_start_room</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_dungeon.html#TestDungeon.test_start_room"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_dungeon.TestDungeon.test_start_room" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Test move through one of the start room exits.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_dungeon.TestDungeon.test_different_start_directions">
|
||||
<code class="sig-name descname">test_different_start_directions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_dungeon.html#TestDungeon.test_different_start_directions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_dungeon.TestDungeon.test_different_start_directions" 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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_commands.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.tests.test_commands</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_equipment.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.tests.test_equipment</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.tutorials.evadventure.tests.test_dungeon.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.tutorials.evadventure.tests.test_dungeon.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_equipment.html" title="evennia.contrib.tutorials.evadventure.tests.test_equipment"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_commands.html" title="evennia.contrib.tutorials.evadventure.tests.test_commands"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" >evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_dungeon</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,278 @@
|
|||
|
||||
<!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.tutorials.evadventure.tests.test_equipment — 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>
|
||||
<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.tutorials.evadventure.tests.test_quests" href="evennia.contrib.tutorials.evadventure.tests.test_quests.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.tests.test_dungeon" href="evennia.contrib.tutorials.evadventure.tests.test_dungeon.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_quests.html" title="evennia.contrib.tutorials.evadventure.tests.test_quests"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_dungeon.html" title="evennia.contrib.tutorials.evadventure.tests.test_dungeon"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" accesskey="U">evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_equipment</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.tutorials.evadventure.tests.test_equipment">
|
||||
<span id="evennia-contrib-tutorials-evadventure-tests-test-equipment"></span><h1>evennia.contrib.tutorials.evadventure.tests.test_equipment<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.tests.test_equipment" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Test the EvAdventure equipment handler.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.tests.test_equipment.</code><code class="sig-name descname">TestEquipment</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/tutorials/evadventure/tests/test_equipment.html#TestEquipment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.mixins.html#evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin" title="evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin</span></code></a>, <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.tutorials.evadventure.tests.test_equipment.TestEquipment.test_count_slots">
|
||||
<code class="sig-name descname">test_count_slots</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_equipment.html#TestEquipment.test_count_slots"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_count_slots" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_max_slots">
|
||||
<code class="sig-name descname">test_max_slots</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_equipment.html#TestEquipment.test_max_slots"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_max_slots" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_add__remove">
|
||||
<code class="sig-name descname">test_add__remove</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_equipment.html#TestEquipment.test_add__remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_add__remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move__get_current_slot">
|
||||
<code class="sig-name descname">test_move__get_current_slot</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_equipment.html#TestEquipment.test_move__get_current_slot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move__get_current_slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_get_wearable_or_wieldable_objects_from_backpack">
|
||||
<code class="sig-name descname">test_get_wearable_or_wieldable_objects_from_backpack</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_equipment.html#TestEquipment.test_get_wearable_or_wieldable_objects_from_backpack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_get_wearable_or_wieldable_objects_from_backpack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_equipmenthandler_max_slots">
|
||||
<code class="sig-name descname">test_equipmenthandler_max_slots</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_equipment.html#TestEquipment.test_equipmenthandler_max_slots"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_equipmenthandler_max_slots" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_validate_slot_usage">
|
||||
<code class="sig-name descname">test_validate_slot_usage</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_validate_slot_usage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move">
|
||||
<code class="sig-name descname">test_move</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.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/tutorials/evadventure/tests/test_equipment.html#TestEquipment.test_add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_two_handed_exclusive">
|
||||
<code class="sig-name descname">test_two_handed_exclusive</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_equipment.html#TestEquipment.test_two_handed_exclusive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_two_handed_exclusive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Two-handed weapons can’t be used together with weapon+shield</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_remove__with_obj">
|
||||
<code class="sig-name descname">test_remove__with_obj</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_equipment.html#TestEquipment.test_remove__with_obj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_remove__with_obj" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_remove__with_slot">
|
||||
<code class="sig-name descname">test_remove__with_slot</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_equipment.html#TestEquipment.test_remove__with_slot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_remove__with_slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_properties">
|
||||
<code class="sig-name descname">test_properties</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_equipment.html#TestEquipment.test_properties"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_properties" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move_0_helmet">
|
||||
<code class="sig-name descname">test_move_0_helmet</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move_0_helmet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move_1_shield">
|
||||
<code class="sig-name descname">test_move_1_shield</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move_1_shield" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move_2_armor">
|
||||
<code class="sig-name descname">test_move_2_armor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move_2_armor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move_3_weapon">
|
||||
<code class="sig-name descname">test_move_3_weapon</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move_3_weapon" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move_4_big_weapon">
|
||||
<code class="sig-name descname">test_move_4_big_weapon</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move_4_big_weapon" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move_5_item">
|
||||
<code class="sig-name descname">test_move_5_item</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_move_5_item" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_validate_slot_usage_0">
|
||||
<code class="sig-name descname">test_validate_slot_usage_0</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_validate_slot_usage_0" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_validate_slot_usage_1">
|
||||
<code class="sig-name descname">test_validate_slot_usage_1</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_validate_slot_usage_1" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_validate_slot_usage_2">
|
||||
<code class="sig-name descname">test_validate_slot_usage_2</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_validate_slot_usage_2" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_validate_slot_usage_3">
|
||||
<code class="sig-name descname">test_validate_slot_usage_3</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_validate_slot_usage_3" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_validate_slot_usage_4">
|
||||
<code class="sig-name descname">test_validate_slot_usage_4</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_validate_slot_usage_4" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_validate_slot_usage_5">
|
||||
<code class="sig-name descname">test_validate_slot_usage_5</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_validate_slot_usage_5" 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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_dungeon.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.tests.test_dungeon</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_quests.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.tests.test_quests</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.tutorials.evadventure.tests.test_equipment.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.tutorials.evadventure.tests.test_equipment.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_quests.html" title="evennia.contrib.tutorials.evadventure.tests.test_quests"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_dungeon.html" title="evennia.contrib.tutorials.evadventure.tests.test_dungeon"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" >evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_equipment</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,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.tutorials.evadventure.tests.test_quests — 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>
|
||||
<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.tutorials.evadventure.tests.test_rules" href="evennia.contrib.tutorials.evadventure.tests.test_rules.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.tests.test_equipment" href="evennia.contrib.tutorials.evadventure.tests.test_equipment.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_rules.html" title="evennia.contrib.tutorials.evadventure.tests.test_rules"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_equipment.html" title="evennia.contrib.tutorials.evadventure.tests.test_equipment"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" accesskey="U">evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_quests</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.tutorials.evadventure.tests.test_quests">
|
||||
<span id="evennia-contrib-tutorials-evadventure-tests-test-quests"></span><h1>evennia.contrib.tutorials.evadventure.tests.test_quests<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.tests.test_quests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Testing Quest functionality.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_quests.EvAdventureQuestTest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.tests.test_quests.</code><code class="sig-name descname">EvAdventureQuestTest</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/tutorials/evadventure/tests/test_quests.html#EvAdventureQuestTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_quests.EvAdventureQuestTest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.mixins.html#evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin" title="evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.evadventure.tests.mixins.EvAdventureMixin</span></code></a>, <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 questing.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_quests.EvAdventureQuestTest.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/tutorials/evadventure/tests/test_quests.html#EvAdventureQuestTest.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_quests.EvAdventureQuestTest.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.tutorials.evadventure.tests.test_quests.EvAdventureQuestTest.test_help">
|
||||
<code class="sig-name descname">test_help</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_quests.html#EvAdventureQuestTest.test_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_quests.EvAdventureQuestTest.test_help" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get help</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_quests.EvAdventureQuestTest.test_progress__fail">
|
||||
<code class="sig-name descname">test_progress__fail</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_quests.html#EvAdventureQuestTest.test_progress__fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_quests.EvAdventureQuestTest.test_progress__fail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Check progress without having any.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_quests.EvAdventureQuestTest.test_progress">
|
||||
<code class="sig-name descname">test_progress</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_quests.html#EvAdventureQuestTest.test_progress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_quests.EvAdventureQuestTest.test_progress" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Fulfill the quest steps in sequess</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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_equipment.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.tests.test_equipment</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_rules.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.tests.test_rules</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.tutorials.evadventure.tests.test_quests.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.tutorials.evadventure.tests.test_quests.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_rules.html" title="evennia.contrib.tutorials.evadventure.tests.test_rules"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_equipment.html" title="evennia.contrib.tutorials.evadventure.tests.test_equipment"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" >evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_quests</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,204 @@
|
|||
|
||||
<!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.tutorials.evadventure.tests.test_rules — 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>
|
||||
<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.tutorials.evadventure.tests.test_utils" href="evennia.contrib.tutorials.evadventure.tests.test_utils.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.tests.test_quests" href="evennia.contrib.tutorials.evadventure.tests.test_quests.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_utils.html" title="evennia.contrib.tutorials.evadventure.tests.test_utils"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_quests.html" title="evennia.contrib.tutorials.evadventure.tests.test_quests"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" accesskey="U">evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_rules</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.tutorials.evadventure.tests.test_rules">
|
||||
<span id="evennia-contrib-tutorials-evadventure-tests-test-rules"></span><h1>evennia.contrib.tutorials.evadventure.tests.test_rules<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.tests.test_rules" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Test the rules and chargen.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.tests.test_rules.</code><code class="sig-name descname">EvAdventureRollEngineTest</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/tutorials/evadventure/tests/test_rules.html#EvAdventureRollEngineTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest" 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 the roll engine in the rules module. This is the core of any RPG.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.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/tutorials/evadventure/tests/test_rules.html#EvAdventureRollEngineTest.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.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.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_roll">
|
||||
<code class="sig-name descname">test_roll</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_rules.html#EvAdventureRollEngineTest.test_roll"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_roll" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_roll_limits">
|
||||
<code class="sig-name descname">test_roll_limits</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_rules.html#EvAdventureRollEngineTest.test_roll_limits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_roll_limits" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_roll_with_advantage_disadvantage">
|
||||
<code class="sig-name descname">test_roll_with_advantage_disadvantage</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_rules.html#EvAdventureRollEngineTest.test_roll_with_advantage_disadvantage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_roll_with_advantage_disadvantage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_saving_throw">
|
||||
<code class="sig-name descname">test_saving_throw</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_rules.html#EvAdventureRollEngineTest.test_saving_throw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_saving_throw" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_opposed_saving_throw">
|
||||
<code class="sig-name descname">test_opposed_saving_throw</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_rules.html#EvAdventureRollEngineTest.test_opposed_saving_throw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_opposed_saving_throw" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_roll_random_table">
|
||||
<code class="sig-name descname">test_roll_random_table</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_rules.html#EvAdventureRollEngineTest.test_roll_random_table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_roll_random_table" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_morale_check">
|
||||
<code class="sig-name descname">test_morale_check</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_rules.html#EvAdventureRollEngineTest.test_morale_check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_morale_check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_heal_from_rest">
|
||||
<code class="sig-name descname">test_heal_from_rest</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_rules.html#EvAdventureRollEngineTest.test_heal_from_rest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_heal_from_rest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_roll_death">
|
||||
<code class="sig-name descname">test_roll_death</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_randint</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_rules.html#EvAdventureRollEngineTest.test_roll_death"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_rules.EvAdventureRollEngineTest.test_roll_death" 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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_quests.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.tests.test_quests</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_utils.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.tests.test_utils</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.tutorials.evadventure.tests.test_rules.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.tutorials.evadventure.tests.test_rules.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_utils.html" title="evennia.contrib.tutorials.evadventure.tests.test_utils"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_quests.html" title="evennia.contrib.tutorials.evadventure.tests.test_quests"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" >evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_rules</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,157 @@
|
|||
|
||||
<!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.tutorials.evadventure.tests.test_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>
|
||||
<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>
|
||||
<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.tutorials.mirror" href="evennia.contrib.tutorials.mirror.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.tests.test_rules" href="evennia.contrib.tutorials.evadventure.tests.test_rules.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="right" >
|
||||
<a href="evennia.contrib.tutorials.mirror.html" title="evennia.contrib.tutorials.mirror"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_rules.html" title="evennia.contrib.tutorials.evadventure.tests.test_rules"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" accesskey="U">evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_utils</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.tutorials.evadventure.tests.test_utils">
|
||||
<span id="evennia-contrib-tutorials-evadventure-tests-test-utils"></span><h1>evennia.contrib.tutorials.evadventure.tests.test_utils<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.tests.test_utils" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Tests of the utils module.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.tests.test_utils.TestUtils">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.tests.test_utils.</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/tutorials/evadventure/tests/test_utils.html#TestUtils"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_utils.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.tutorials.evadventure.tests.test_utils.TestUtils.test_get_obj_stats">
|
||||
<code class="sig-name descname">test_get_obj_stats</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/tests/test_utils.html#TestUtils.test_get_obj_stats"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.tests.test_utils.TestUtils.test_get_obj_stats" 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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_rules.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.tests.test_rules</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.mirror.html"
|
||||
title="next chapter">evennia.contrib.tutorials.mirror</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.tutorials.evadventure.tests.test_utils.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.tutorials.evadventure.tests.test_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>
|
||||
</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="right" >
|
||||
<a href="evennia.contrib.tutorials.mirror.html" title="evennia.contrib.tutorials.mirror"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_rules.html" title="evennia.contrib.tutorials.evadventure.tests.test_rules"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-7"><a href="evennia.contrib.tutorials.evadventure.tests.html" >evennia.contrib.tutorials.evadventure.tests</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.tests.test_utils</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.tutorials.evadventure.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>
|
||||
<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>
|
||||
<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.tutorials.evadventure.tests" href="evennia.contrib.tutorials.evadventure.tests.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.shops" href="evennia.contrib.tutorials.evadventure.shops.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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.html" title="evennia.contrib.tutorials.evadventure.tests"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.shops.html" title="evennia.contrib.tutorials.evadventure.shops"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" accesskey="U">evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.utils</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.tutorials.evadventure.utils">
|
||||
<span id="evennia-contrib-tutorials-evadventure-utils"></span><h1>evennia.contrib.tutorials.evadventure.utils<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.utils" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Various utilities.</p>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.utils.get_obj_stats">
|
||||
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.utils.</code><code class="sig-name descname">get_obj_stats</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">owner</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/tutorials/evadventure/utils.html#get_obj_stats"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.utils.get_obj_stats" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get a string of stats about the object.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>obj</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><em>EvAdventureObject</em></a>) – The object to get stats for.</p></li>
|
||||
<li><p><strong>owner</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.characters.html#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter" title="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter"><em>EvAdventureCharacter</em></a><em>, </em><em>optional</em>) – If given, it allows us to
|
||||
also get information about if the item is currently worn/wielded.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – A stat string to show about the object.</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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.shops.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.shops</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.html"
|
||||
title="next chapter">evennia.contrib.tutorials.evadventure.tests</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.tutorials.evadventure.utils.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.tutorials.evadventure.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>
|
||||
</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="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.html" title="evennia.contrib.tutorials.evadventure.tests"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.evadventure.shops.html" title="evennia.contrib.tutorials.evadventure.shops"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.evadventure.html" >evennia.contrib.tutorials.evadventure</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.evadventure.utils</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>
|
||||
|
|
@ -64,6 +64,38 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.bodyfunctions.tests.html">evennia.contrib.tutorials.bodyfunctions.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.html">evennia.contrib.tutorials.evadventure</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.build_techdemo.html">evennia.contrib.tutorials.evadventure.build_techdemo</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.build_world.html">evennia.contrib.tutorials.evadventure.build_world</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.characters.html">evennia.contrib.tutorials.evadventure.characters</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.chargen.html">evennia.contrib.tutorials.evadventure.chargen</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.combat_turnbased.html">evennia.contrib.tutorials.evadventure.combat_turnbased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.commands.html">evennia.contrib.tutorials.evadventure.commands</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.dungeon.html">evennia.contrib.tutorials.evadventure.dungeon</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.enums.html">evennia.contrib.tutorials.evadventure.enums</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.equipment.html">evennia.contrib.tutorials.evadventure.equipment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.npcs.html">evennia.contrib.tutorials.evadventure.npcs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html">evennia.contrib.tutorials.evadventure.objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.quests.html">evennia.contrib.tutorials.evadventure.quests</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.random_tables.html">evennia.contrib.tutorials.evadventure.random_tables</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.rooms.html">evennia.contrib.tutorials.evadventure.rooms</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.rules.html">evennia.contrib.tutorials.evadventure.rules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.shops.html">evennia.contrib.tutorials.evadventure.shops</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.utils.html">evennia.contrib.tutorials.evadventure.utils</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.html">evennia.contrib.tutorials.evadventure.tests</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.mixins.html">evennia.contrib.tutorials.evadventure.tests.mixins</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_characters.html">evennia.contrib.tutorials.evadventure.tests.test_characters</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_combat.html">evennia.contrib.tutorials.evadventure.tests.test_combat</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_commands.html">evennia.contrib.tutorials.evadventure.tests.test_commands</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_dungeon.html">evennia.contrib.tutorials.evadventure.tests.test_dungeon</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_equipment.html">evennia.contrib.tutorials.evadventure.tests.test_equipment</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_quests.html">evennia.contrib.tutorials.evadventure.tests.test_quests</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_rules.html">evennia.contrib.tutorials.evadventure.tests.test_rules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_utils.html">evennia.contrib.tutorials.evadventure.tests.test_utils</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorials.mirror.html">evennia.contrib.tutorials.mirror</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorials.mirror.mirror.html">evennia.contrib.tutorials.mirror.mirror</a></li>
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@
|
|||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="evennia.contrib.tutorials.mirror.mirror" href="evennia.contrib.tutorials.mirror.mirror.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.bodyfunctions.tests" href="evennia.contrib.tutorials.bodyfunctions.tests.html" />
|
||||
<link rel="prev" title="evennia.contrib.tutorials.evadventure.tests.test_utils" href="evennia.contrib.tutorials.evadventure.tests.test_utils.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
|
|
@ -33,7 +33,7 @@
|
|||
<a href="evennia.contrib.tutorials.mirror.mirror.html" title="evennia.contrib.tutorials.mirror.mirror"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.bodyfunctions.tests.html" title="evennia.contrib.tutorials.bodyfunctions.tests"
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_utils.html" title="evennia.contrib.tutorials.evadventure.tests.test_utils"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
|
|
@ -82,8 +82,8 @@
|
|||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.bodyfunctions.tests.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.bodyfunctions.tests</a></p>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.evadventure.tests.test_utils.html"
|
||||
title="previous chapter">evennia.contrib.tutorials.evadventure.tests.test_utils</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.tutorials.mirror.mirror.html"
|
||||
title="next chapter">evennia.contrib.tutorials.mirror.mirror</a></p>
|
||||
|
|
@ -127,7 +127,7 @@
|
|||
<a href="evennia.contrib.tutorials.mirror.mirror.html" title="evennia.contrib.tutorials.mirror.mirror"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.tutorials.bodyfunctions.tests.html" title="evennia.contrib.tutorials.bodyfunctions.tests"
|
||||
<a href="evennia.contrib.tutorials.evadventure.tests.test_utils.html" title="evennia.contrib.tutorials.evadventure.tests.test_utils"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
|
|
|
|||
|
|
@ -96,7 +96,7 @@ such as when closing the lid and un-blinding a character.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['press button', 'press', 'push']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['push', 'press', 'press button']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -125,7 +125,7 @@ check if the lid is open or closed.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press button press push', 'category': 'general', 'key': 'push button', 'no_prefix': ' press button press push', 'tags': '', 'text': '\n Push the red button (lid closed)\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'push press press button', 'category': 'general', 'key': 'push button', 'no_prefix': ' push press press button', 'tags': '', 'text': '\n Push the red button (lid closed)\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -195,7 +195,7 @@ check if the lid is open or closed.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdSmashGlass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['smash lid', 'smash', 'break lid']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdSmashGlass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['smash', 'smash lid', 'break lid']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdSmashGlass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -222,7 +222,7 @@ break.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdSmashGlass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'smash lid smash break lid', 'category': 'general', 'key': 'smash glass', 'no_prefix': ' smash lid smash break lid', 'tags': '', 'text': '\n Smash the protective glass.\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdSmashGlass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'smash smash lid break lid', 'category': 'general', 'key': 'smash glass', 'no_prefix': ' smash smash lid break lid', 'tags': '', 'text': '\n Smash the protective glass.\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdSmashGlass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -322,7 +322,7 @@ be mutually exclusive.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['press button', 'press', 'push']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['push', 'press', 'press button']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -351,7 +351,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press button press push', 'category': 'general', 'key': 'push button', 'no_prefix': ' press button press push', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'push press press button', 'category': 'general', 'key': 'push button', 'no_prefix': ' push press press button', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -449,7 +449,7 @@ be mutually exclusive.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['listen', 'feel', 'get', 'examine', 'ex', 'l']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['examine', 'feel', 'get', 'ex', 'listen', 'l']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -475,7 +475,7 @@ be mutually exclusive.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'listen feel get examine ex l', 'category': 'general', 'key': 'look', 'no_prefix': ' listen feel get examine ex l', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'examine feel get ex listen l', 'category': 'general', 'key': 'look', 'no_prefix': ' examine feel get ex listen l', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -507,7 +507,7 @@ shift green root up/down</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['shiftroot', 'move', 'pull', 'push']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['push', 'move', 'shiftroot', 'pull']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -543,7 +543,7 @@ yellow/green - horizontal roots</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'shiftroot move pull push', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' shiftroot move pull push', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'push move shiftroot pull', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' push move shiftroot pull', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -560,7 +560,7 @@ yellow/green - horizontal roots</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['press button', 'push button', 'button']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['push button', 'press button', 'button']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -586,7 +586,7 @@ yellow/green - horizontal roots</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press button push button button', 'category': 'tutorialworld', 'key': 'press', 'no_prefix': ' press button push button button', 'tags': '', 'text': '\n Presses a button.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'push button press button button', 'category': 'tutorialworld', 'key': 'press', 'no_prefix': ' push button press button button', 'tags': '', 'text': '\n Presses a button.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -730,7 +730,7 @@ parry - forgoes your attack but will make you harder to hit on next</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['fight', 'thrust', 'kill', 'parry', 'chop', 'hit', 'bash', 'pierce', 'slash', 'stab', 'defend']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['parry', 'chop', 'hit', 'thrust', 'kill', 'pierce', 'bash', 'stab', 'defend', 'slash', 'fight']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -756,7 +756,7 @@ parry - forgoes your attack but will make you harder to hit on next</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'fight thrust kill parry chop hit bash pierce slash stab defend', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' fight thrust kill parry chop hit bash pierce slash stab defend', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab <enemy>\n slash <enemy>\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'parry chop hit thrust kill pierce bash stab defend slash fight', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' parry chop hit thrust kill pierce bash stab defend slash fight', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab <enemy>\n slash <enemy>\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -199,7 +199,7 @@ code except for adding in the details.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -214,7 +214,7 @@ code except for adding in the details.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n looks at the room and on details\n\n Usage:\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects\n in your vicinity.\n\n Tutorial: This is a child of the default Look command, that also\n allows us to look at "details" in the room. These details are\n things to examine and offers some extra description without\n actually having to be actual database objects. It uses the\n return_detail() hook on TutorialRooms for this.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n looks at the room and on details\n\n Usage:\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects\n in your vicinity.\n\n Tutorial: This is a child of the default Look command, that also\n allows us to look at "details" in the room. These details are\n things to examine and offers some extra description without\n actually having to be actual database objects. It uses the\n return_detail() hook on TutorialRooms for this.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -767,7 +767,7 @@ if they fall off the bridge.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?', 'h']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.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.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -793,7 +793,7 @@ if they fall off the bridge.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '? h', 'category': 'tutorial world', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.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': 'tutorial world', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -919,7 +919,7 @@ to find something.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['feel', 'fiddle', 'feel around', 'search', 'l']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['fiddle', 'feel', 'search', 'feel around', 'l']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -947,7 +947,7 @@ random chance of eventually finding a light source.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'feel fiddle feel around search l', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' feel fiddle feel around search l', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'fiddle feel search feel around l', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' fiddle feel search feel around l', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@
|
|||
<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.utils.random_string_generator" href="evennia.contrib.utils.random_string_generator.html" />
|
||||
<link rel="next" title="evennia.contrib.utils.name_generator" href="evennia.contrib.utils.name_generator.html" />
|
||||
<link rel="prev" title="evennia.contrib.utils.fieldfill" href="evennia.contrib.utils.fieldfill.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.utils.random_string_generator.html" title="evennia.contrib.utils.random_string_generator"
|
||||
<a href="evennia.contrib.utils.name_generator.html" title="evennia.contrib.utils.name_generator"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.utils.fieldfill.html" title="evennia.contrib.utils.fieldfill"
|
||||
|
|
@ -440,8 +440,8 @@ send</p>
|
|||
<p class="topless"><a href="evennia.contrib.utils.fieldfill.html"
|
||||
title="previous chapter">evennia.contrib.utils.fieldfill</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.utils.random_string_generator.html"
|
||||
title="next chapter">evennia.contrib.utils.random_string_generator</a></p>
|
||||
<p class="topless"><a href="evennia.contrib.utils.name_generator.html"
|
||||
title="next chapter">evennia.contrib.utils.name_generator</a></p>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
|
|
@ -479,7 +479,7 @@ send</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.utils.random_string_generator.html" title="evennia.contrib.utils.random_string_generator"
|
||||
<a href="evennia.contrib.utils.name_generator.html" title="evennia.contrib.utils.name_generator"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.utils.fieldfill.html" title="evennia.contrib.utils.fieldfill"
|
||||
|
|
|
|||
|
|
@ -64,6 +64,11 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html">evennia.contrib.utils.fieldfill.fieldfill</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.utils.name_generator.html">evennia.contrib.utils.name_generator</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.name_generator.namegen.html">evennia.contrib.utils.name_generator.namegen</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.name_generator.tests.html">evennia.contrib.utils.name_generator.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.html">evennia.contrib.utils.random_string_generator</a><ul>
|
||||
<li class="toctree-l2"><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-l2"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.tests.html">evennia.contrib.utils.random_string_generator.tests</a></li>
|
||||
|
|
|
|||
147
docs/1.0-dev/api/evennia.contrib.utils.name_generator.html
Normal file
147
docs/1.0-dev/api/evennia.contrib.utils.name_generator.html
Normal file
|
|
@ -0,0 +1,147 @@
|
|||
|
||||
<!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.utils.name_generator — 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>
|
||||
<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.utils.name_generator.namegen" href="evennia.contrib.utils.name_generator.namegen.html" />
|
||||
<link rel="prev" title="evennia.contrib.utils.fieldfill.fieldfill" href="evennia.contrib.utils.fieldfill.fieldfill.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="right" >
|
||||
<a href="evennia.contrib.utils.name_generator.namegen.html" title="evennia.contrib.utils.name_generator.namegen"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.utils.fieldfill.fieldfill.html" title="evennia.contrib.utils.fieldfill.fieldfill"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.utils.html" accesskey="U">evennia.contrib.utils</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.utils.name_generator</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.utils.name_generator">
|
||||
<span id="evennia-contrib-utils-name-generator"></span><h1>evennia.contrib.utils.name_generator<a class="headerlink" href="#module-evennia.contrib.utils.name_generator" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.utils.name_generator.namegen.html">evennia.contrib.utils.name_generator.namegen</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.utils.name_generator.tests.html">evennia.contrib.utils.name_generator.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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.utils.fieldfill.fieldfill.html"
|
||||
title="previous chapter">evennia.contrib.utils.fieldfill.fieldfill</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.utils.name_generator.namegen.html"
|
||||
title="next chapter">evennia.contrib.utils.name_generator.namegen</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.utils.name_generator.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.utils.name_generator.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="right" >
|
||||
<a href="evennia.contrib.utils.name_generator.namegen.html" title="evennia.contrib.utils.name_generator.namegen"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.utils.fieldfill.fieldfill.html" title="evennia.contrib.utils.fieldfill.fieldfill"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.utils.html" >evennia.contrib.utils</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.utils.name_generator</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,272 @@
|
|||
|
||||
<!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.utils.name_generator.namegen — 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>
|
||||
<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.utils.name_generator.tests" href="evennia.contrib.utils.name_generator.tests.html" />
|
||||
<link rel="prev" title="evennia.contrib.utils.name_generator" href="evennia.contrib.utils.name_generator.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="right" >
|
||||
<a href="evennia.contrib.utils.name_generator.tests.html" title="evennia.contrib.utils.name_generator.tests"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.utils.name_generator.html" title="evennia.contrib.utils.name_generator"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.utils.html" >evennia.contrib.utils</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.utils.name_generator.html" accesskey="U">evennia.contrib.utils.name_generator</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.utils.name_generator.namegen</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.utils.name_generator.namegen">
|
||||
<span id="evennia-contrib-utils-name-generator-namegen"></span><h1>evennia.contrib.utils.name_generator.namegen<a class="headerlink" href="#module-evennia.contrib.utils.name_generator.namegen" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Random Name Generator</p>
|
||||
<p>Contribution by InspectorCaracal (2022)</p>
|
||||
<p>A module for generating random names, both real-world and fantasy. Real-world
|
||||
names can be generated either as first (personal) names, family (last) names, or
|
||||
full names (first, optional middles, and last). The name data is from [Behind the Name](<a class="reference external" href="https://www.behindthename.com/">https://www.behindthename.com/</a>)
|
||||
and used under the [CC BY-SA 4.0 license](<a class="reference external" href="https://creativecommons.org/licenses/by-sa/4.0/">https://creativecommons.org/licenses/by-sa/4.0/</a>).</p>
|
||||
<p>Fantasy names are generated from basic phonetic rules, using CVC syllable syntax.</p>
|
||||
<p>Both real-world and fantasy name generation can be extended to include additional
|
||||
information via your game’s <strong>settings.py</strong></p>
|
||||
<p>Available Methods:</p>
|
||||
<blockquote>
|
||||
<div><p>first_name - Selects a random a first (personal) name from the name lists.
|
||||
last_name - Selects a random last (family) name from the name lists.
|
||||
full_name - Generates a randomized full name, optionally including middle names, by selecting first/last names from the name lists.
|
||||
fantasy_name - Generates a completely new made-up name based on phonetic rules.</p>
|
||||
</div></blockquote>
|
||||
<p>Method examples:</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">namegen</span><span class="o">.</span><span class="n">first_name</span><span class="p">(</span><span class="n">num</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span>
|
||||
<span class="go">['Genesis', 'Tali', 'Budur', 'Dominykas', 'Kamau']</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">namegen</span><span class="o">.</span><span class="n">full_name</span><span class="p">(</span><span class="n">parts</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">surname_first</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="go">'Ó Muircheartach Torunn Dyson'</span>
|
||||
<span class="gp">>>> </span><span class="n">namegen</span><span class="o">.</span><span class="n">full_name</span><span class="p">(</span><span class="n">gender</span><span class="o">=</span><span class="s1">'f'</span><span class="p">)</span>
|
||||
<span class="go">'Wikolia Ó Deasmhumhnaigh'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">namegen</span><span class="o">.</span><span class="n">fantasy_name</span><span class="p">(</span><span class="n">num</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">style</span><span class="o">=</span><span class="s2">"fluid"</span><span class="p">)</span>
|
||||
<span class="go">['Aewalisash', 'Ayi', 'Iaa']</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Available Settings (define these in your <strong>settings.py</strong>)</p>
|
||||
<blockquote>
|
||||
<div><p>NAMEGEN_FIRST_NAMES - Option to add a new list of first (personal) names.
|
||||
NAMEGEN_LAST_NAMES - Option to add a new list of last (family) names.
|
||||
NAMEGEN_REPLACE_LISTS - Set to True if you want to use ONLY your name lists and not the ones that come with the contrib.
|
||||
NAMEGEN_FANTASY_RULES - Option to add new fantasy-name style rules.</p>
|
||||
<blockquote>
|
||||
<div><p>Must be a dictionary that includes “syllable”, “consonants”, “vowels”, and “length” - see the example.
|
||||
“start” and “end” keys are optional.</p>
|
||||
</div></blockquote>
|
||||
</div></blockquote>
|
||||
<p>Settings examples:</p>
|
||||
<dl>
|
||||
<dt>NAMEGEN_FIRST_NAMES = [</dt><dd><blockquote>
|
||||
<div><p>(“Evennia”, ‘mf’),
|
||||
(“Green Tea”, ‘f’),</p>
|
||||
</div></blockquote>
|
||||
<p>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>NAMEGEN_LAST_NAMES = [ “Beeblebrox”, “Son of Odin” ]</p>
|
||||
<dl>
|
||||
<dt>NAMEGEN_FANTASY_RULES = {</dt><dd><dl>
|
||||
<dt>“example_style”: {</dt><dd><blockquote>
|
||||
<div><p>“syllable”: “(C)VC”,
|
||||
“consonants”: [ ‘z’,’z’,’ph’,’sh’,’r’,’n’ ],
|
||||
“start”: [‘m’],
|
||||
“end”: [‘x’,’n’],
|
||||
“vowels”: [ “e”,”e”,”e”,”a”,”i”,”i”,”u”,”o”, ],
|
||||
“length”: (2,4),</p>
|
||||
</div></blockquote>
|
||||
<p>}</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>}</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.utils.name_generator.namegen.fantasy_name">
|
||||
<code class="sig-prename descclassname">evennia.contrib.utils.name_generator.namegen.</code><code class="sig-name descname">fantasy_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">num</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">style</span><span class="o">=</span><span class="default_value">'harsh'</span></em>, <em class="sig-param"><span class="n">return_list</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/utils/name_generator/namegen.html#fantasy_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.name_generator.namegen.fantasy_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Generate made-up names in one of a number of “styles”.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Keyword Arguments</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>num</strong> (<em>int</em>) – </p></li>
|
||||
<li><p><strong>style</strong> (<em>string</em>) – </p></li>
|
||||
<li><p><strong>return_list</strong> (<em>bool</em>) – which returns a string if there is only one value and a list if more.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.utils.name_generator.namegen.first_name">
|
||||
<code class="sig-prename descclassname">evennia.contrib.utils.name_generator.namegen.</code><code class="sig-name descname">first_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">num</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">gender</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">return_list</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/utils/name_generator/namegen.html#first_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.name_generator.namegen.first_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Generate first names, also known as personal names.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Keyword Arguments</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>num</strong> (<em>int</em>) – </p></li>
|
||||
<li><p><strong>gender</strong> (<em>str</em>) – all possible names. Set to “m” for masculine, “f” for feminine, “mf” for androgynous</p></li>
|
||||
<li><p><strong>return_list</strong> (<em>bool</em>) – which returns a string if there is only one value and a list if more.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.utils.name_generator.namegen.last_name">
|
||||
<code class="sig-prename descclassname">evennia.contrib.utils.name_generator.namegen.</code><code class="sig-name descname">last_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">num</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">return_list</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/utils/name_generator/namegen.html#last_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.name_generator.namegen.last_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Generate family names, also known as surnames or last names.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Keyword Arguments</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>num</strong> (<em>int</em>) – </p></li>
|
||||
<li><p><strong>return_list</strong> (<em>bool</em>) – which returns a string if there is only one value and a list if more.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.utils.name_generator.namegen.full_name">
|
||||
<code class="sig-prename descclassname">evennia.contrib.utils.name_generator.namegen.</code><code class="sig-name descname">full_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">num</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">parts</span><span class="o">=</span><span class="default_value">2</span></em>, <em class="sig-param"><span class="n">gender</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">return_list</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">surname_first</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/utils/name_generator/namegen.html#full_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.name_generator.namegen.full_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Generate complete names with a personal name, family name, and optionally middle names.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Keyword Arguments</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>num</strong> (<em>int</em>) – </p></li>
|
||||
<li><p><strong>parts</strong> (<em>int</em>) – first and last.</p></li>
|
||||
<li><p><strong>gender</strong> (<em>str</em>) – all possible names. Set to “m” for masculine, “f” for feminine, “mf” for androgynous</p></li>
|
||||
<li><p><strong>return_list</strong> (<em>bool</em>) – which returns a string if there is only one value and a list if more.</p></li>
|
||||
<li><p><strong>surname_first</strong> (<em>bool</em>) – placed at the beginning of the name instead of the end.</p></li>
|
||||
</ul>
|
||||
</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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.utils.name_generator.html"
|
||||
title="previous chapter">evennia.contrib.utils.name_generator</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.utils.name_generator.tests.html"
|
||||
title="next chapter">evennia.contrib.utils.name_generator.tests</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.utils.name_generator.namegen.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.utils.name_generator.namegen.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="right" >
|
||||
<a href="evennia.contrib.utils.name_generator.tests.html" title="evennia.contrib.utils.name_generator.tests"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.utils.name_generator.html" title="evennia.contrib.utils.name_generator"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.utils.html" >evennia.contrib.utils</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.utils.name_generator.html" >evennia.contrib.utils.name_generator</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.utils.name_generator.namegen</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>
|
||||
196
docs/1.0-dev/api/evennia.contrib.utils.name_generator.tests.html
Normal file
196
docs/1.0-dev/api/evennia.contrib.utils.name_generator.tests.html
Normal file
|
|
@ -0,0 +1,196 @@
|
|||
|
||||
<!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.utils.name_generator.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>
|
||||
<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.utils.random_string_generator" href="evennia.contrib.utils.random_string_generator.html" />
|
||||
<link rel="prev" title="evennia.contrib.utils.name_generator.namegen" href="evennia.contrib.utils.name_generator.namegen.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="right" >
|
||||
<a href="evennia.contrib.utils.random_string_generator.html" title="evennia.contrib.utils.random_string_generator"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.utils.name_generator.namegen.html" title="evennia.contrib.utils.name_generator.namegen"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.utils.html" >evennia.contrib.utils</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.utils.name_generator.html" accesskey="U">evennia.contrib.utils.name_generator</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.utils.name_generator.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.utils.name_generator.tests">
|
||||
<span id="evennia-contrib-utils-name-generator-tests"></span><h1>evennia.contrib.utils.name_generator.tests<a class="headerlink" href="#module-evennia.contrib.utils.name_generator.tests" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Tests for the Random Name Generator</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.utils.name_generator.tests.TestNameGenerator">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.utils.name_generator.tests.</code><code class="sig-name descname">TestNameGenerator</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/utils/name_generator/tests.html#TestNameGenerator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.name_generator.tests.TestNameGenerator" 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.utils.name_generator.tests.TestNameGenerator.test_fantasy_name">
|
||||
<code class="sig-name descname">test_fantasy_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/name_generator/tests.html#TestNameGenerator.test_fantasy_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.name_generator.tests.TestNameGenerator.test_fantasy_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Verify output types and lengths.</p>
|
||||
<p>fantasy_name() - str
|
||||
fantasy_name(style=”fluid”) - str
|
||||
fantasy_name(num=3) - list of length 3
|
||||
fantasy_name(return_list=True) - list of length 1</p>
|
||||
<p>raises KeyError on missing style or ValueError on num</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.utils.name_generator.tests.TestNameGenerator.test_structure_validation">
|
||||
<code class="sig-name descname">test_structure_validation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/name_generator/tests.html#TestNameGenerator.test_structure_validation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.name_generator.tests.TestNameGenerator.test_structure_validation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Verify that validation raises the correct errors for invalid inputs.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.utils.name_generator.tests.TestNameGenerator.test_first_name">
|
||||
<code class="sig-name descname">test_first_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/name_generator/tests.html#TestNameGenerator.test_first_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.name_generator.tests.TestNameGenerator.test_first_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Verify output types and lengths.</p>
|
||||
<p>first_name() - str
|
||||
first_name(num=3) - list of length 3
|
||||
first_name(gender=’f’) - str
|
||||
first_name(return_list=True) - list of length 1</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.utils.name_generator.tests.TestNameGenerator.test_last_name">
|
||||
<code class="sig-name descname">test_last_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/name_generator/tests.html#TestNameGenerator.test_last_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.name_generator.tests.TestNameGenerator.test_last_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Verify output types and lengths.</p>
|
||||
<p>last_name() - str
|
||||
last_name(num=3) - list of length 3
|
||||
last_name(return_list=True) - list of length 1</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.utils.name_generator.tests.TestNameGenerator.test_full_name">
|
||||
<code class="sig-name descname">test_full_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/name_generator/tests.html#TestNameGenerator.test_full_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.utils.name_generator.tests.TestNameGenerator.test_full_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Verify output types and lengths.</p>
|
||||
<p>full_name() - str
|
||||
full_name(num=3) - list of length 3
|
||||
full_name(gender=’f’) - str
|
||||
full_name(return_list=True) - list of length 1</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>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.utils.name_generator.namegen.html"
|
||||
title="previous chapter">evennia.contrib.utils.name_generator.namegen</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.utils.random_string_generator.html"
|
||||
title="next chapter">evennia.contrib.utils.random_string_generator</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.utils.name_generator.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.utils.name_generator.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="right" >
|
||||
<a href="evennia.contrib.utils.random_string_generator.html" title="evennia.contrib.utils.random_string_generator"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.utils.name_generator.namegen.html" title="evennia.contrib.utils.name_generator.namegen"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||||
<li class="nav-item nav-item-5"><a href="evennia.contrib.utils.html" >evennia.contrib.utils</a> »</li>
|
||||
<li class="nav-item nav-item-6"><a href="evennia.contrib.utils.name_generator.html" >evennia.contrib.utils.name_generator</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.utils.name_generator.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>
|
||||
|
|
@ -18,7 +18,7 @@
|
|||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="evennia.contrib.utils.random_string_generator.random_string_generator" href="evennia.contrib.utils.random_string_generator.random_string_generator.html" />
|
||||
<link rel="prev" title="evennia.contrib.utils.fieldfill.fieldfill" href="evennia.contrib.utils.fieldfill.fieldfill.html" />
|
||||
<link rel="prev" title="evennia.contrib.utils.name_generator.tests" href="evennia.contrib.utils.name_generator.tests.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
|
|
@ -33,7 +33,7 @@
|
|||
<a href="evennia.contrib.utils.random_string_generator.random_string_generator.html" title="evennia.contrib.utils.random_string_generator.random_string_generator"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.utils.fieldfill.fieldfill.html" title="evennia.contrib.utils.fieldfill.fieldfill"
|
||||
<a href="evennia.contrib.utils.name_generator.tests.html" title="evennia.contrib.utils.name_generator.tests"
|
||||
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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
|
|
@ -83,8 +83,8 @@
|
|||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.utils.fieldfill.fieldfill.html"
|
||||
title="previous chapter">evennia.contrib.utils.fieldfill.fieldfill</a></p>
|
||||
<p class="topless"><a href="evennia.contrib.utils.name_generator.tests.html"
|
||||
title="previous chapter">evennia.contrib.utils.name_generator.tests</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="evennia.contrib.utils.random_string_generator.random_string_generator.html"
|
||||
title="next chapter">evennia.contrib.utils.random_string_generator.random_string_generator</a></p>
|
||||
|
|
@ -128,7 +128,7 @@
|
|||
<a href="evennia.contrib.utils.random_string_generator.random_string_generator.html" title="evennia.contrib.utils.random_string_generator.random_string_generator"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="evennia.contrib.utils.fieldfill.fieldfill.html" title="evennia.contrib.utils.fieldfill.fieldfill"
|
||||
<a href="evennia.contrib.utils.name_generator.tests.html" title="evennia.contrib.utils.name_generator.tests"
|
||||
>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="../Evennia-API.html" >API Summary</a> »</li>
|
||||
|
|
|
|||
|
|
@ -56,6 +56,7 @@
|
|||
<ul class="simple">
|
||||
<li><p>evennia.ANSIString</p></li>
|
||||
<li><p>evennia.AccountDB</p></li>
|
||||
<li><p>evennia.AttributeProperty</p></li>
|
||||
<li><p>evennia.ChannelDB</p></li>
|
||||
<li><p>evennia.CmdSet</p></li>
|
||||
<li><p>evennia.Command</p></li>
|
||||
|
|
@ -82,6 +83,7 @@
|
|||
<li><p>evennia.ScriptDB</p></li>
|
||||
<li><p>evennia.TASK_HANDLER</p></li>
|
||||
<li><p>evennia.TICKER_HANDLER</p></li>
|
||||
<li><p>evennia.TagProperty</p></li>
|
||||
<li><p>evennia.ansi</p></li>
|
||||
<li><p>evennia.contrib</p></li>
|
||||
<li><p>evennia.create_account</p></li>
|
||||
|
|
@ -468,6 +470,38 @@ with ‘q’, remove the break line and restart server when finished.</p></li>
|
|||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.bodyfunctions.tests.html">evennia.contrib.tutorials.bodyfunctions.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.html">evennia.contrib.tutorials.evadventure</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.build_techdemo.html">evennia.contrib.tutorials.evadventure.build_techdemo</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.build_world.html">evennia.contrib.tutorials.evadventure.build_world</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.characters.html">evennia.contrib.tutorials.evadventure.characters</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.chargen.html">evennia.contrib.tutorials.evadventure.chargen</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.combat_turnbased.html">evennia.contrib.tutorials.evadventure.combat_turnbased</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.commands.html">evennia.contrib.tutorials.evadventure.commands</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.dungeon.html">evennia.contrib.tutorials.evadventure.dungeon</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.enums.html">evennia.contrib.tutorials.evadventure.enums</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.equipment.html">evennia.contrib.tutorials.evadventure.equipment</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.npcs.html">evennia.contrib.tutorials.evadventure.npcs</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html">evennia.contrib.tutorials.evadventure.objects</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.quests.html">evennia.contrib.tutorials.evadventure.quests</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.random_tables.html">evennia.contrib.tutorials.evadventure.random_tables</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.rooms.html">evennia.contrib.tutorials.evadventure.rooms</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.rules.html">evennia.contrib.tutorials.evadventure.rules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.shops.html">evennia.contrib.tutorials.evadventure.shops</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.utils.html">evennia.contrib.tutorials.evadventure.utils</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.html">evennia.contrib.tutorials.evadventure.tests</a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.mixins.html">evennia.contrib.tutorials.evadventure.tests.mixins</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_characters.html">evennia.contrib.tutorials.evadventure.tests.test_characters</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_combat.html">evennia.contrib.tutorials.evadventure.tests.test_combat</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_commands.html">evennia.contrib.tutorials.evadventure.tests.test_commands</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_dungeon.html">evennia.contrib.tutorials.evadventure.tests.test_dungeon</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_equipment.html">evennia.contrib.tutorials.evadventure.tests.test_equipment</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_quests.html">evennia.contrib.tutorials.evadventure.tests.test_quests</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_rules.html">evennia.contrib.tutorials.evadventure.tests.test_rules</a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorials.evadventure.tests.test_utils.html">evennia.contrib.tutorials.evadventure.tests.test_utils</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorials.mirror.html">evennia.contrib.tutorials.mirror</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.tutorials.mirror.mirror.html">evennia.contrib.tutorials.mirror.mirror</a></li>
|
||||
</ul>
|
||||
|
|
@ -505,6 +539,11 @@ with ‘q’, remove the break line and restart server when finished.</p></li>
|
|||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html">evennia.contrib.utils.fieldfill.fieldfill</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.name_generator.html">evennia.contrib.utils.name_generator</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.name_generator.namegen.html">evennia.contrib.utils.name_generator.namegen</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.name_generator.tests.html">evennia.contrib.utils.name_generator.tests</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.html">evennia.contrib.utils.random_string_generator</a><ul>
|
||||
<li class="toctree-l4"><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-l4"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.tests.html">evennia.contrib.utils.random_string_generator.tests</a></li>
|
||||
|
|
|
|||
|
|
@ -324,6 +324,18 @@ If accessing_obj has the “.obj” property (such as is the case for
|
|||
a command), then accessing_obj.obj is used instead.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.locks.lockfuncs.objloctag">
|
||||
<code class="sig-prename descclassname">evennia.locks.lockfuncs.</code><code class="sig-name descname">objloctag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">accessing_obj</span></em>, <em class="sig-param"><span class="n">accessed_obj</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/locks/lockfuncs.html#objloctag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.locks.lockfuncs.objloctag" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="simple">
|
||||
<dt>Usage:</dt><dd><p>objloctag(tagkey)
|
||||
objloctag(tagkey, category):</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Only true if <strong>accessed_obj.location</strong> has the given tag and optional category.
|
||||
If obj has no location, this lockfunc fails.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.locks.lockfuncs.is_ooc">
|
||||
<code class="sig-prename descclassname">evennia.locks.lockfuncs.</code><code class="sig-name descname">is_ooc</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">accessing_obj</span></em>, <em class="sig-param"><span class="n">accessed_obj</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/locks/lockfuncs.html#is_ooc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.locks.lockfuncs.is_ooc" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
|
|||
|
|
@ -275,58 +275,6 @@ and filtering.</p>
|
|||
location having the property destination != <strong>None</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_name">
|
||||
<code class="sig-name descname">get_display_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</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/objects/objects.html#DefaultObject.get_display_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Displays the name of the object in a viewer-aware manner.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>looker</strong> (<a class="reference internal" href="evennia.typeclasses.models.html#evennia.typeclasses.models.TypedObject" title="evennia.typeclasses.models.TypedObject"><em>TypedObject</em></a>) – The object or account that is looking
|
||||
at/getting inforamtion for this object.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>name (str)</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>A string containing the name of the object,</dt><dd><p>including the DBREF if this user is privileged to control
|
||||
said object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>This function could be extended to change how object names
|
||||
appear to users in character, but be wary. This function
|
||||
does not change an object’s keys or aliases when
|
||||
searching, and is expected to produce something useful for
|
||||
builders.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_numbered_name">
|
||||
<code class="sig-name descname">get_numbered_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">count</span></em>, <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/objects/objects.html#DefaultObject.get_numbered_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_numbered_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the numbered (singular, plural) forms of this object’s key. This is by default called
|
||||
by return_appearance and is used for grouping multiple same-named of this object. Note that
|
||||
this will be called on <em>every</em> member of a group even though the plural name will be only
|
||||
shown once. Also the singular display version, such as ‘an apple’, ‘a tree’ is determined
|
||||
from this method.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>count</strong> (<em>int</em>) – Number of objects of this type</p></li>
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Onlooker. Not used by default.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Keyword Arguments</dt>
|
||||
<dd class="field-even"><p><strong>key</strong> (<em>str</em>) – Optional key to pluralize, if given, use this instead of the object’s key.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>singular (str)</em> – The singular form to display.
|
||||
plural (str): The determined plural form of the key, including the count.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.search">
|
||||
<code class="sig-name descname">search</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">searchdata</span></em>, <em class="sig-param"><span class="n">global_search</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">use_nicks</span><span class="o">=</span><span class="default_value">True</span></em>, <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">location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">attribute_name</span><span class="o">=</span><span class="default_value">None</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">exact</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">candidates</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">use_locks</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">nofound_string</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">multimatch_string</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">use_dbref</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">stacked</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/objects.html#DefaultObject.search"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.search" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -550,7 +498,7 @@ function on.</p></li>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.msg_contents">
|
||||
<code class="sig-name descname">msg_contents</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">exclude</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">mapping</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/objects/objects.html#DefaultObject.msg_contents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.msg_contents" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">msg_contents</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">exclude</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">mapping</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">raise_funcparse_errors</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/objects/objects.html#DefaultObject.msg_contents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.msg_contents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Emits a message to all objects inside this object.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -574,6 +522,9 @@ The keys must either match **{key}</strong> or <strong>$You(key)/$you(key)</stro
|
|||
in the <strong>text</strong> string. If <strong><object></strong> doesn’t have a <strong>get_display_name</strong>
|
||||
method, it will be returned as a string. If not set, a key <strong>you</strong> will
|
||||
be auto-added to point to <strong>from_obj</strong> if given, otherwise to <strong>self</strong>.</p></li>
|
||||
<li><p><strong>raise_funcparse_errors</strong> (<em>bool</em><em>, </em><em>optional</em>) – If set, a failing <strong>$func()</strong> will
|
||||
lead to an outright error. If unset (default), the failing <strong>$func()</strong>
|
||||
will instead appear in output unparsed.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Keyword arguments will be passed on to <strong>obj.msg()</strong> for all
|
||||
messaged objects.</p></li>
|
||||
</ul>
|
||||
|
|
@ -672,7 +623,9 @@ calling <strong>move_to</strong>.</p>
|
|||
<p>The <strong>DefaultObject</strong> hooks called (if <strong>move_hooks=True</strong>) are, in order:</p>
|
||||
<blockquote>
|
||||
<div><ol class="arabic simple">
|
||||
<li><p><strong>self.at_pre_move(destination)</strong> (if this returns False, move is aborted)</p></li>
|
||||
<li><p><strong>self.at_pre_move(destination)</strong> (abort if return False)</p></li>
|
||||
<li><p><strong>source_location.at_pre_object_leave(self, destination)</strong> (abort if return False)</p></li>
|
||||
<li><p><strong>destination.at_pre_object_receive(self, source_location)</strong> (abort if return False)</p></li>
|
||||
<li><p><strong>source_location.at_object_leave(self, destination)</strong></p></li>
|
||||
<li><p><strong>self.announce_move_from(destination)</strong></p></li>
|
||||
<li><p>(move happens here)</p></li>
|
||||
|
|
@ -795,6 +748,223 @@ lock check for superuser (be careful with this one).</p></li>
|
|||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_name">
|
||||
<code class="sig-name descname">get_display_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</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/objects/objects.html#DefaultObject.get_display_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Displays the name of the object in a viewer-aware manner.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>looker</strong> (<a class="reference internal" href="evennia.typeclasses.models.html#evennia.typeclasses.models.TypedObject" title="evennia.typeclasses.models.TypedObject"><em>TypedObject</em></a>) – The object or account that is looking
|
||||
at/getting inforamtion for this object. If not given, <strong>.name</strong> will be
|
||||
returned, which can in turn be used to display colored data.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>str</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>A name to display for this object. This can contain color codes and may</dt><dd><p>be customized based on <strong>looker</strong>. By default this contains the <strong>.key</strong> of the object,
|
||||
followed by the DBREF if this user is privileged to control said object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>This function could be extended to change how object names appear to users in character,
|
||||
but be wary. This function does not change an object’s keys or aliases when searching,
|
||||
and is expected to produce something useful for builders.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_numbered_name">
|
||||
<code class="sig-name descname">get_numbered_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">count</span></em>, <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/objects/objects.html#DefaultObject.get_numbered_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_numbered_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return the numbered (singular, plural) forms of this object’s key. This is by default called
|
||||
by return_appearance and is used for grouping multiple same-named of this object. Note that
|
||||
this will be called on <em>every</em> member of a group even though the plural name will be only
|
||||
shown once. Also the singular display version, such as ‘an apple’, ‘a tree’ is determined
|
||||
from this method.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>count</strong> (<em>int</em>) – Number of objects of this type</p></li>
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Onlooker. Not used by default.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Keyword Arguments</dt>
|
||||
<dd class="field-even"><p><strong>key</strong> (<em>str</em>) – Optional key to pluralize, if given, use this instead of the object’s key.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><p><em>tuple</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>This is a tuple <strong>(str, str)</strong> with the singular and plural forms of the key</dt><dd><p>including the count.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Examples</p>
|
||||
<dl class="simple">
|
||||
<dt>::</dt><dd><p>obj.get_numbered_name(3, looker, key=”foo”) -> (“a foo”, “three foos”)</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_header">
|
||||
<code class="sig-name descname">get_display_header</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/objects/objects.html#DefaultObject.get_display_header"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_header" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ‘header’ component of the object description. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The header display string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_desc">
|
||||
<code class="sig-name descname">get_display_desc</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/objects/objects.html#DefaultObject.get_display_desc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_desc" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ‘desc’ component of the object description. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The desc display string..</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_exits">
|
||||
<code class="sig-name descname">get_display_exits</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/objects/objects.html#DefaultObject.get_display_exits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_exits" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ‘exits’ component of the object description. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The exits display data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_characters">
|
||||
<code class="sig-name descname">get_display_characters</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/objects/objects.html#DefaultObject.get_display_characters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_characters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ‘characters’ component of the object description. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The character display data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_things">
|
||||
<code class="sig-name descname">get_display_things</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/objects/objects.html#DefaultObject.get_display_things"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_things" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ‘things’ component of the object description. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The things display data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.get_display_footer">
|
||||
<code class="sig-name descname">get_display_footer</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/objects/objects.html#DefaultObject.get_display_footer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_display_footer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get the ‘footer’ component of the object description. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The footer display string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.format_appearance">
|
||||
<code class="sig-name descname">format_appearance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">appearance</span></em>, <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/objects/objects.html#DefaultObject.format_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.format_appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Final processing of the entire appearance string. Called by <strong>return_appearance</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>appearance</strong> (<em>str</em>) – The compiled appearance string.</p></li>
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The final formatted output.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.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/objects/objects.html#DefaultObject.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.return_appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Main callback used by ‘look’ for the object to describe itself.
|
||||
This formats a description. By default, this looks for the <strong>appearance_template</strong>
|
||||
string set on this class and populates it with formatting keys</p>
|
||||
<blockquote>
|
||||
<div><p>‘name’, ‘desc’, ‘exits’, ‘characters’, ‘things’ as well as
|
||||
(currently empty) ‘header’/’footer’. Each of these values are
|
||||
retrieved by a matching method <strong>.get_display_*</strong>, such as <strong>get_display_name</strong>,
|
||||
<strong>get_display_footer</strong> etc.</p>
|
||||
</div></blockquote>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking. Passed into all helper methods.</p></li>
|
||||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||||
overriding the call. This is passed into all helper methods.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>str</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>The description of this entity. By default this includes</dt><dd><p>the entity’s name, description and any contents inside it.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>To simply change the layout of how the object displays itself (like
|
||||
adding some line decorations or change colors of different sections),
|
||||
you can simply edit <strong>.appearance_template</strong>. You only need to override
|
||||
this method (and/or its helpers) if you want to change what is passed
|
||||
into the template or want the most control over output.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.at_first_save">
|
||||
<code class="sig-name descname">at_first_save</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/objects.html#DefaultObject.at_first_save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.at_first_save" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -986,7 +1156,7 @@ based on the access result.</p>
|
|||
<dt id="evennia.objects.objects.DefaultObject.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>, <em class="sig-param"><span class="n">move_type</span><span class="o">=</span><span class="default_value">'move'</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/objects/objects.html#DefaultObject.at_pre_move"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.at_pre_move" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called just before starting to move this object to
|
||||
destination.</p>
|
||||
destination. Return False to abort move.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
|
|
@ -1000,7 +1170,7 @@ overriding the call (unused by default).</p></li>
|
|||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>shouldmove (bool)</em> – If we should move or not.</p>
|
||||
<dd class="field-even"><p><em>bool</em> – If we should move or not.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
|
|
@ -1008,11 +1178,61 @@ overriding the call (unused by default).</p></li>
|
|||
before it is even started.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.at_pre_object_leave">
|
||||
<code class="sig-name descname">at_pre_object_leave</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">leaving_object</span></em>, <em class="sig-param"><span class="n">destination</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/objects/objects.html#DefaultObject.at_pre_object_leave"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.at_pre_object_leave" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called just before this object is about lose an object that was
|
||||
previously ‘inside’ it. Return False to abort move.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>leaving_object</strong> (<em>Object</em>) – The object that is about to leave.</p></li>
|
||||
<li><p><strong>destination</strong> (<em>Object</em>) – Where object is going to.</p></li>
|
||||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||||
overriding the call (unused by default).</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>bool</em> – If <strong>leaving_object</strong> should be allowed to leave or not.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="simple">
|
||||
<dt>Notes: If this method returns False, None, the move is canceled before</dt><dd><p>it even started.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.at_pre_object_receive">
|
||||
<code class="sig-name descname">at_pre_object_receive</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">arriving_object</span></em>, <em class="sig-param"><span class="n">source_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/objects/objects.html#DefaultObject.at_pre_object_receive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.at_pre_object_receive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called just before this object received another object. If this
|
||||
method returns <strong>False</strong>, the move is aborted and the moved entity
|
||||
remains where it was.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>arriving_object</strong> (<em>Object</em>) – The object moved into this one</p></li>
|
||||
<li><p><strong>source_location</strong> (<em>Object</em>) – Where <strong>moved_object</strong> came from.
|
||||
Note that this could be <strong>None</strong>.</p></li>
|
||||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||||
overriding the call (unused by default).</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>bool</em> – If False, abort move and <strong>moved_obj</strong> remains where it was.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="simple">
|
||||
<dt>Notes: If this method returns False, None, the move is canceled before</dt><dd><p>it even started.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.at_before_move">
|
||||
<code class="sig-name descname">at_before_move</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">destination</span></em>, <em class="sig-param"><span class="n">move_type</span><span class="o">=</span><span class="default_value">'move'</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.objects.objects.DefaultObject.at_before_move" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called just before starting to move this object to
|
||||
destination.</p>
|
||||
destination. Return False to abort move.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
|
|
@ -1026,7 +1246,7 @@ overriding the call (unused by default).</p></li>
|
|||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>shouldmove (bool)</em> – If we should move or not.</p>
|
||||
<dd class="field-even"><p><em>bool</em> – If we should move or not.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
|
|
@ -1370,42 +1590,6 @@ already given by the .get_display_name() (and the .name field) already.
|
|||
Per-type coloring can be applied in <strong>return_apperance</strong>.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.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/objects/objects.html#DefaultObject.return_appearance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.return_appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Main callback used by ‘look’ for the object to describe itself.
|
||||
This formats a description. By default, this looks for the <strong>appearance_template</strong>
|
||||
string set on this class and populates it with formatting keys</p>
|
||||
<blockquote>
|
||||
<div><p>‘name’, ‘desc’, ‘exits’, ‘characters’, ‘things’ as well as
|
||||
(currently empty) ‘header’/’footer’.</p>
|
||||
</div></blockquote>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>looker</strong> (<em>Object</em>) – Object doing the looking.</p></li>
|
||||
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||||
overriding the call. This is passed into the helper
|
||||
methods and into <strong>get_display_name</strong> calls.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>str</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>The description of this entity. By default this includes</dt><dd><p>the entity’s name, description and any contents inside it.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>To simply change the layout of how the object displays itself (like
|
||||
adding some line decorations or change colors of different sections),
|
||||
you can simply edit <strong>.appearance_template</strong>. You only need to override
|
||||
this method (and/or its helpers) if you want to change what is passed
|
||||
into the template or want the most control over output.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.objects.objects.DefaultObject.at_look">
|
||||
<code class="sig-name descname">at_look</code><span class="sig-paren">(</span><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/objects/objects.html#DefaultObject.at_look"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.at_look" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -1811,8 +1995,8 @@ change the default lockset and skip creator attribution.</p></li>
|
|||
</ul>
|
||||
</dd>
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>character (Object)</em> – A newly created Character of the given typeclass.
|
||||
errors (list): A list of errors in string form, if any.</p>
|
||||
<dd class="field-odd"><p><em>tuple</em> – <strong>(new_character, errors)</strong>. On error, the <strong>new_character</strong> is <strong>None</strong> and
|
||||
<strong>errors</strong> is a <strong>list</strong> of error strings (an empty list otherwise).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -88,6 +88,9 @@ in script definition and listings)</p></li>
|
|||
<li><p><strong>autostart</strong> (<em>bool</em><em>, </em><em>optional</em>) – Start the script upon adding it.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>Script</em> – The newly created Script.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
|
|
@ -114,14 +117,27 @@ in script definition and listings)</p></li>
|
|||
<dd class="field-odd"><p><strong>key</strong> (<em>str</em>) – Search criterion, the script’s key or dbref.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>scripts (list)</em> – The found scripts matching <strong>key</strong>.</p>
|
||||
<dd class="field-even"><p><em>scripts (queryset)</em> – The found scripts matching <strong>key</strong>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.scripts.scripthandler.ScriptHandler.remove">
|
||||
<code class="sig-name descname">remove</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><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripthandler.html#ScriptHandler.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripthandler.ScriptHandler.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Forcibly delete a script from this object.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>key</strong> (<em>str</em><em>, </em><em>optional</em>) – A script key or the path to a script (in the
|
||||
latter case all scripts with this path will be deleted!)
|
||||
If no key is given, delete <em>all</em> scripts on the object!</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.scripts.scripthandler.ScriptHandler.delete">
|
||||
<code class="sig-name descname">delete</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><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripthandler.html#ScriptHandler.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripthandler.ScriptHandler.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">delete</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><span class="sig-paren">)</span><a class="headerlink" href="#evennia.scripts.scripthandler.ScriptHandler.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Forcibly delete a script from this object.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
|
|||
|
|
@ -373,7 +373,7 @@ not be passed to callback.</p>
|
|||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>TaskHandlerTask</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>An object to represent a task.</dt><dd><p>Reference evennia.scripts.taskhandler.TaskHandlerTask for complete details.</p>
|
||||
<dt>An object to represent a task.</dt><dd><p>Reference <strong>evennia.scripts.taskhandler.TaskHandlerTask</strong> for complete details.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -246,6 +246,9 @@ on the class level. Since Tags are almost always used for querying, Tags are alw
|
|||
created/assigned along with the object. Make sure the property/tagname does not collide
|
||||
with an existing method/property on the class. If it does, you must use tags.add()
|
||||
instead.</p>
|
||||
<p>Note that while you _can_ check e.g. <strong>obj.tagname,this will give an AttributeError
|
||||
if the Tag is not set. Most often you want to use **obj.tags.get(“tagname”)</strong> to check
|
||||
if a tag is set on an object.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">mytag</span> <span class="o">=</span> <span class="n">TagProperty</span><span class="p">()</span> <span class="c1"># category=None</span>
|
||||
|
|
|
|||
|
|
@ -287,7 +287,7 @@ indentation.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.eveditor.CmdEditorGroup.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = [':y', ':::', ':u', ':fd', ':q!', ':dd', ':s', ':A', ':w', ':=', ':echo', ':I', ':r', '::', ':<', ':S', ':q', ':>', ':!', ':x', ':', ':h', ':wq', ':UU', ':f', ':DD', ':dw', ':i', ':p', ':uu', ':j', ':fi']</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = [':i', ':dd', ':u', ':S', ':s', ':fi', ':j', '::', ':::', ':fd', ':', ':<', ':y', ':q', ':wq', ':uu', ':dw', ':=', ':q!', ':DD', ':I', ':!', ':h', ':x', ':echo', ':w', ':>', ':UU', ':A', ':r', ':f', ':p']</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -315,7 +315,7 @@ efficient presentation.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.eveditor.CmdEditorGroup.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ':y ::: :u :fd :q! :dd :s :A :w := :echo :I :r :: :< :S :q :> :! :x : :h :wq :UU :f :DD :dw :i :p :uu :j :fi', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :y ::: :u :fd :q! :dd :s :A :w := :echo :I :r :: :< :S :q :> :! :x : :h :wq :UU :f :DD :dw :i :p :uu :j :fi', 'tags': '', 'text': '\n Commands for the editor\n '}</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ':i :dd :u :S :s :fi :j :: ::: :fd : :< :y :q :wq :uu :dw := :q! :DD :I :! :h :x :echo :w :> :UU :A :r :f :p', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :i :dd :u :S :s :fi :j :: ::: :fd : :< :y :q :wq :uu :dw := :q! :DD :I :! :h :x :echo :w :> :UU :A :r :f :p', 'tags': '', 'text': '\n Commands for the editor\n '}</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -104,7 +104,7 @@ character’s width.</p>
|
|||
<span class="c1"># create a new form from the template</span>
|
||||
<span class="n">form</span> <span class="o">=</span> <span class="n">EvForm</span><span class="p">(</span><span class="s2">"path/to/testform.py"</span><span class="p">)</span>
|
||||
|
||||
<span class="p">(</span><span class="n">MudForm</span> <span class="n">can</span> <span class="n">also</span> <span class="n">take</span> <span class="n">a</span> <span class="n">dictionary</span> <span class="n">holding</span>
|
||||
<span class="p">(</span><span class="n">EvForm</span> <span class="n">can</span> <span class="n">also</span> <span class="n">take</span> <span class="n">a</span> <span class="n">dictionary</span> <span class="n">holding</span>
|
||||
<span class="n">the</span> <span class="n">required</span> <span class="n">keys</span> <span class="n">FORMCHAR</span><span class="p">,</span> <span class="n">TABLECHAR</span> <span class="ow">and</span> <span class="n">FORM</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># add data to each tagged form cell</span>
|
||||
|
|
|
|||
|
|
@ -954,7 +954,7 @@ single question.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.evmenu.CmdYesNoQuestion.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['abort', 'a', 'yes', 'no', 'n', '__nomatch_command', 'y']</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['no', 'a', 'y', '__nomatch_command', 'yes', 'n', 'abort']</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -980,7 +980,7 @@ single question.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'abort a yes no n __nomatch_command y', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' abort a yes no n __nomatch_command y', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'no a y __nomatch_command yes n abort', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' no a y __nomatch_command yes n abort', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -1036,11 +1036,12 @@ single question.</p>
|
|||
<dl class="py function">
|
||||
<dt id="evennia.utils.evmenu.ask_yes_no">
|
||||
<code class="sig-prename descclassname">evennia.utils.evmenu.</code><code class="sig-name descname">ask_yes_no</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">prompt</span><span class="o">=</span><span class="default_value">'Yes or No {options}?'</span></em>, <em class="sig-param"><span class="n">yes_action</span><span class="o">=</span><span class="default_value">'Yes'</span></em>, <em class="sig-param"><span class="n">no_action</span><span class="o">=</span><span class="default_value">'No'</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">allow_abort</span><span class="o">=</span><span class="default_value">False</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">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/utils/evmenu.html#ask_yes_no"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.evmenu.ask_yes_no" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A helper question for asking a simple yes/no question. This will cause
|
||||
<dd><p>A helper function for asking a simple yes/no question. This will cause
|
||||
the system to pause and wait for input from the player.</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>Object</em>) – The entity being asked.</p></li>
|
||||
<li><p><strong>prompt</strong> (<em>str</em>) – The yes/no question to ask. This takes an optional formatting
|
||||
marker <strong>{options}</strong> which will be filled with ‘Y/N’, ‘[Y]/N’ or
|
||||
‘Y/[N]’ depending on the setting of <strong>default</strong>. If <strong>allow_abort</strong> is set,
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ the <strong>caller.msg()</strong> construct every time the page is updated.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.evmore.CmdMore.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['abort', 'top', 'end', 'a', 'q', 'e', 'n', 'next', 'quit', 'p', 'previous', 't']</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['next', 'p', 'a', 't', 'e', 'previous', 'q', 'end', 'quit', 'top', 'n', 'abort']</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -114,7 +114,7 @@ the <strong>caller.msg()</strong> construct every time the page is updated.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.evmore.CmdMore.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'abort top end a q e n next quit p previous t', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' abort top end a q e n next quit p previous t', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'next p a t e previous q end quit top n abort', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' next p a t e previous q end quit top n abort', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -313,7 +313,26 @@ as the input.</p>
|
|||
<dl class="py function">
|
||||
<dt id="evennia.utils.funcparser.funcparser_callable_toint">
|
||||
<code class="sig-prename descclassname">evennia.utils.funcparser.</code><code class="sig-name descname">funcparser_callable_toint</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/utils/funcparser.html#funcparser_callable_toint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.funcparser.funcparser_callable_toint" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Usage: toint(43.0) -> 43</p>
|
||||
<dd><p>Usage: $toint(43.0) -> 43</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.utils.funcparser.funcparser_callable_int2str">
|
||||
<code class="sig-prename descclassname">evennia.utils.funcparser.</code><code class="sig-name descname">funcparser_callable_int2str</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/utils/funcparser.html#funcparser_callable_int2str"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.funcparser.funcparser_callable_int2str" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Usage: $int2str(1) -> ‘one’ etc, up to 12->twelve.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>number</strong> (<em>int</em>) – The number. If not an int, will be converted.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Uses the int2str utility function.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.utils.funcparser.funcparser_callable_an">
|
||||
<code class="sig-prename descclassname">evennia.utils.funcparser.</code><code class="sig-name descname">funcparser_callable_an</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/utils/funcparser.html#funcparser_callable_an"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.funcparser.funcparser_callable_an" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Usage: $an(thing) -> a thing</p>
|
||||
<p>Adds a/an depending on if the first letter of the given word is a consonant or not.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
|
|
@ -538,6 +557,29 @@ to <strong>|n</strong> (reset-color).</p></li>
|
|||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.utils.funcparser.funcparser_callable_pluralize">
|
||||
<code class="sig-prename descclassname">evennia.utils.funcparser.</code><code class="sig-name descname">funcparser_callable_pluralize</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/utils/funcparser.html#funcparser_callable_pluralize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.funcparser.funcparser_callable_pluralize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>FuncParser callable. Handles pluralization of a word.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>singular_word</strong> (<em>str</em>) – The base (singular) word to optionally pluralize</p></li>
|
||||
<li><p><strong>number</strong> (<em>int</em>) – The number of elements; if 1 (or 0), use <strong>singular_word</strong> as-is,
|
||||
otherwise use plural form.</p></li>
|
||||
<li><p><strong>plural_word</strong> (<em>str</em><em>, </em><em>optional</em>) – If given, this will be used if <strong>number</strong>
|
||||
is greater than one. If not given, we simply add ‘s’ to the end of
|
||||
<strong>singular_word</strong>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Example</p>
|
||||
<ul class="simple">
|
||||
<li><p><strong>$pluralize(thing, 2)</strong> -> “things”</p></li>
|
||||
<li><p><strong>$pluralize(goose, 18, geese)</strong> -> “geese”</p></li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.utils.funcparser.funcparser_callable_search">
|
||||
<code class="sig-prename descclassname">evennia.utils.funcparser.</code><code class="sig-name descname">funcparser_callable_search</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">caller</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">access</span><span class="o">=</span><span class="default_value">'control'</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/utils/funcparser.html#funcparser_callable_search"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.funcparser.funcparser_callable_search" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
|
|||
|
|
@ -214,7 +214,7 @@ return 300 (5 minutes).</p>
|
|||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>callback</strong> (<em>function</em>) – The callback function that will be called. Note
|
||||
that the callback must be a module-level function, since the script will
|
||||
be persistent. The callable should be on form <strong>callable(*args, **kwargs)</strong>
|
||||
be persistent. The callable should be on the form <strong>callable(*args, **kwargs)</strong>
|
||||
where args/kwargs are passed into this schedule.</p></li>
|
||||
<li><p><strong>repeat</strong> (<em>bool</em><em>, </em><em>optional</em>) – Defines if the callback should be called regularly
|
||||
at the specified time.</p></li>
|
||||
|
|
@ -224,11 +224,8 @@ at the specified time.</p></li>
|
|||
<li><p><strong>day</strong> (<em>int</em><em> or </em><em>None</em>) – Number of absolute days.</p></li>
|
||||
<li><p><strong>month</strong> (<em>int</em><em> or </em><em>None</em>) – Number of absolute months.</p></li>
|
||||
<li><p><strong>year</strong> (<em>int</em><em> or </em><em>None</em>) – Number of absolute years.</p></li>
|
||||
<li><p><strong>*args</strong> – Will be passed into the callable. These must be possible
|
||||
to store in Attributes on the generated scheduling Script.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – <p>Will be passed into the callable. These must be possible
|
||||
to store in Attributes on the generated scheduling Script.</p>
|
||||
</p></li>
|
||||
<li><p><strong>*args</strong> – Passed into the callable. Must be possible to store in Attribute.</p></li>
|
||||
<li><p><strong>**kwargs</strong> – Passed into the callable. Must be possible to store in Attribute.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
|
|
@ -236,10 +233,11 @@ to store in Attributes on the generated scheduling Script.</p>
|
|||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Examples</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">schedule</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="nb">min</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">sec</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># Will call 5 minutes past the next (in-game) hour.</span>
|
||||
<span class="n">schedule</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="n">hour</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="nb">min</span><span class="o">=</span><span class="mi">30</span><span class="p">,</span> <span class="n">sec</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># Will call the next (in-game) day at 02:30.</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="simple">
|
||||
<dt>::</dt><dd><p>schedule(func, min=5, sec=0) # Will call 5 minutes past the next (in-game) hour.
|
||||
schedule(func, hour=2, min=30, sec=0) # Will call the next (in-game) day at 02:30.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
|
|
|
|||
|
|
@ -282,7 +282,8 @@ This can be used for testing on-object Command interactions.</p></li>
|
|||
<li><p><strong>inputs</strong> (<em>list</em><em>, </em><em>optional</em>) – A list of strings to pass to functions that pause to
|
||||
take input from the user (normally using <strong>@interactive</strong> and
|
||||
<strong>ret = yield(question)</strong> or <strong>evmenu.get_input</strong>). Each element of the
|
||||
list will be passed into the command as if the user wrote that at the prompt.</p></li>
|
||||
list will be passed into the command as if the user answered each prompt
|
||||
in that order.</p></li>
|
||||
<li><p><strong>raw_string</strong> (<em>str</em><em>, </em><em>optional</em>) – Normally the <strong>.raw_string</strong> property is set as
|
||||
a combination of your <strong>key/cmdname</strong> and <strong>input_args</strong>. This allows
|
||||
direct control of what this is, for example for testing edge cases
|
||||
|
|
|
|||
|
|
@ -270,15 +270,15 @@ values with double quotes.</p></li>
|
|||
<p class="rubric">Notes</p>
|
||||
<p>Default is to use ‘Oxford comma’, like 1, 2, 3, and 4.</p>
|
||||
<p class="rubric">Examples</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">','</span><span class="p">)</span>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">','</span><span class="p">)</span>
|
||||
<span class="go">'1, 2, 3'</span>
|
||||
<span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span>
|
||||
<span class="go">'1, 2 3'</span>
|
||||
<span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">ensdep</span><span class="o">=</span><span class="s1">'and'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">ensdep</span><span class="o">=</span><span class="s1">'and'</span><span class="p">)</span>
|
||||
<span class="go">'1, 2 and 3'</span>
|
||||
<span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">sep</span><span class="o">=</span><span class="s1">';'</span><span class="p">,</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">';'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">sep</span><span class="o">=</span><span class="s1">';'</span><span class="p">,</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">';'</span><span class="p">)</span>
|
||||
<span class="go">'1; 2; 3'</span>
|
||||
<span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">addquote</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">addquote</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="go">'"1", "2", and "3"'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
|
@ -309,15 +309,15 @@ values with double quotes.</p></li>
|
|||
<p class="rubric">Notes</p>
|
||||
<p>Default is to use ‘Oxford comma’, like 1, 2, 3, and 4.</p>
|
||||
<p class="rubric">Examples</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">','</span><span class="p">)</span>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">','</span><span class="p">)</span>
|
||||
<span class="go">'1, 2, 3'</span>
|
||||
<span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span>
|
||||
<span class="go">'1, 2 3'</span>
|
||||
<span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">ensdep</span><span class="o">=</span><span class="s1">'and'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">ensdep</span><span class="o">=</span><span class="s1">'and'</span><span class="p">)</span>
|
||||
<span class="go">'1, 2 and 3'</span>
|
||||
<span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">sep</span><span class="o">=</span><span class="s1">';'</span><span class="p">,</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">';'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">sep</span><span class="o">=</span><span class="s1">';'</span><span class="p">,</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">';'</span><span class="p">)</span>
|
||||
<span class="go">'1; 2; 3'</span>
|
||||
<span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">addquote</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">addquote</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="go">'"1", "2", and "3"'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
|
@ -348,15 +348,15 @@ values with double quotes.</p></li>
|
|||
<p class="rubric">Notes</p>
|
||||
<p>Default is to use ‘Oxford comma’, like 1, 2, 3, and 4.</p>
|
||||
<p class="rubric">Examples</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">','</span><span class="p">)</span>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">','</span><span class="p">)</span>
|
||||
<span class="go">'1, 2, 3'</span>
|
||||
<span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">''</span><span class="p">)</span>
|
||||
<span class="go">'1, 2 3'</span>
|
||||
<span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">ensdep</span><span class="o">=</span><span class="s1">'and'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">ensdep</span><span class="o">=</span><span class="s1">'and'</span><span class="p">)</span>
|
||||
<span class="go">'1, 2 and 3'</span>
|
||||
<span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">sep</span><span class="o">=</span><span class="s1">';'</span><span class="p">,</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">';'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">sep</span><span class="o">=</span><span class="s1">';'</span><span class="p">,</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">';'</span><span class="p">)</span>
|
||||
<span class="go">'1; 2; 3'</span>
|
||||
<span class="gp">>>> </span><span class="n">list_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">addquote</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">addquote</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="go">'"1", "2", and "3"'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
|
@ -1722,6 +1722,25 @@ to avoid race conditions.</p>
|
|||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="evennia.utils.utils.int2str">
|
||||
<code class="sig-prename descclassname">evennia.utils.utils.</code><code class="sig-name descname">int2str</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">number</span></em>, <em class="sig-param"><span class="n">adjective</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/utils.html#int2str"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.utils.int2str" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Convert a number to an English string for better display; so 1 -> one, 2 -> two etc
|
||||
up until 12, after which it will be ‘13’, ‘14’ etc.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>number</strong> (<em>int</em>) – The number to convert. Floats will be converted to ints.</p></li>
|
||||
<li><p><strong>adjective</strong> (<em>int</em>) – If set, map 1->1st, 2->2nd etc. If unset, map 1->one, 2->two etc.
|
||||
up to twelve.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>str</em> – The number expressed as a string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -369,7 +369,7 @@
|
|||
<dl class="py method">
|
||||
<dt id="evennia.web.website.tests.CharacterCreateView.test_valid_access_multisession_2">
|
||||
<code class="sig-name descname">test_valid_access_multisession_2</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/tests.html#CharacterCreateView.test_valid_access_multisession_2"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.tests.CharacterCreateView.test_valid_access_multisession_2" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Account1 should be able to create a new character</p>
|
||||
<dd><p>Account1 should be able to create multiple new characters</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue