mirror of
https://github.com/evennia/evennia.git
synced 2026-04-05 23:47:16 +02:00
387 lines
No EOL
32 KiB
HTML
387 lines
No EOL
32 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en" data-content_root="../">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>evennia.contrib.full_systems.evscaperoom.state — Evennia latest documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
|
||
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
|
||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<link rel="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.full_systems.evscaperoom.tests" href="evennia.contrib.full_systems.evscaperoom.tests.html" />
|
||
<link rel="prev" title="evennia.contrib.full_systems.evscaperoom.scripts" href="evennia.contrib.full_systems.evscaperoom.scripts.html" />
|
||
</head><body>
|
||
<div class="related" role="navigation" aria-label="Related">
|
||
<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.full_systems.evscaperoom.tests.html" title="evennia.contrib.full_systems.evscaperoom.tests"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.contrib.full_systems.evscaperoom.scripts.html" title="evennia.contrib.full_systems.evscaperoom.scripts"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</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.full_systems.html" >evennia.contrib.full_systems</a> »</li>
|
||
<li class="nav-item nav-item-6"><a href="evennia.contrib.full_systems.evscaperoom.html" accesskey="U">evennia.contrib.full_systems.evscaperoom</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.state</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="module-evennia.contrib.full_systems.evscaperoom.state">
|
||
<span id="evennia-contrib-full-systems-evscaperoom-state"></span><h1>evennia.contrib.full_systems.evscaperoom.state<a class="headerlink" href="#module-evennia.contrib.full_systems.evscaperoom.state" title="Link to this heading">¶</a></h1>
|
||
<p>States represent the sequence of states the room goes through.</p>
|
||
<p>This module includes the BaseState class and the StateHandler
|
||
for managing states on the room.</p>
|
||
<p>The state handler operates on an Evscaperoom and changes
|
||
its state from one to another.</p>
|
||
<p>A given state is given as a module in states/ package. The
|
||
state is identified by its module name.</p>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.StateHandler">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.full_systems.evscaperoom.state.</span></span><span class="sig-name descname"><span class="pre">StateHandler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">room</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#StateHandler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>This sits on the room and is used to progress through the states.</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.StateHandler.__init__">
|
||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">room</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#StateHandler.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler.__init__" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.StateHandler.load_state">
|
||
<span class="sig-name descname"><span class="pre">load_state</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">statename</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#StateHandler.load_state"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler.load_state" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Load state without initializing it</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.StateHandler.init_state">
|
||
<span class="sig-name descname"><span class="pre">init_state</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#StateHandler.init_state"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler.init_state" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Initialize a new state</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.StateHandler.next_state">
|
||
<span class="sig-name descname"><span class="pre">next_state</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">next_state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#StateHandler.next_state"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler.next_state" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Check if the current state is finished. This should be called whenever
|
||
the players do actions that may affect the state of the room.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>next_state</strong> (<em>str</em><em>, </em><em>optional</em>) – If given, override the next_state given
|
||
by the current state’s check() method with this - this allows
|
||
for branching paths (but the current state must still first agree
|
||
that the check passes).</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><em>state_changed (bool)</em> – True if the state changed, False otherwise.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.BaseState">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.full_systems.evscaperoom.state.</span></span><span class="sig-name descname"><span class="pre">BaseState</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">room</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Base object holding all callables for a state. This is here to
|
||
allow easy overriding for child states.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.BaseState.next_state">
|
||
<span class="sig-name descname"><span class="pre">next_state</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'unset'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.next_state" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.BaseState.hints">
|
||
<span class="sig-name descname"><span class="pre">hints</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.hints" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.BaseState.__init__">
|
||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">room</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.__init__" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Initializer.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>room</strong> (<a class="reference internal" href="evennia.contrib.full_systems.evscaperoom.room.html#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom" title="evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom"><em>EvscapeRoom</em></a>) – The room tied to this state.</p></li>
|
||
<li><p><strong>handler</strong> (<a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler" title="evennia.contrib.full_systems.evscaperoom.state.StateHandler"><em>StateHandler</em></a>) – Back-reference to the handler
|
||
storing this state.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.BaseState.get_hint">
|
||
<span class="sig-name descname"><span class="pre">get_hint</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.get_hint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.get_hint" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Get a hint for how to solve this state.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.BaseState.msg">
|
||
<span class="sig-name descname"><span class="pre">msg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">borders</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cinematic</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.msg"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.msg" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Display messsage to everyone in room, or given target.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.BaseState.cinematic">
|
||
<span class="sig-name descname"><span class="pre">cinematic</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.cinematic"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.cinematic" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Display a ‘cinematic’ sequence - centered, with borders.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.BaseState.create_object">
|
||
<span class="sig-name descname"><span class="pre">create_object</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">typeclass</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'testobj'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.create_object"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.create_object" title="Link to this definition">¶</a></dt>
|
||
<dd><p>This is a convenience-wrapper for quickly building EvscapeRoom objects.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>typeclass</strong> (<em>str</em>) – This can take just the class-name in the evscaperoom’s
|
||
objects.py module. Otherwise, a full path or the actual class
|
||
is needed (for custom state objects, just give the class directly).</p></li>
|
||
<li><p><strong>key</strong> (<em>str</em>) – Name of object.</p></li>
|
||
<li><p><strong>location</strong> (<em>Object</em>) – If not given, this will be the current room.</p></li>
|
||
<li><p><strong>kwargs</strong> (<em>any</em>) – Will be passed into create_object.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><em>new_obj (Object)</em> – The newly created object, if any.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.BaseState.get_object">
|
||
<span class="sig-name descname"><span class="pre">get_object</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.get_object"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.get_object" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Find a named <em>non-character</em> object for this state in this room.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>key</strong> (<em>str</em>) – Object to search for.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><em>obj (Object)</em> – Object in the room.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.BaseState.init">
|
||
<span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.init" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Initializes the state (usually by modifying the room in some way)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.BaseState.clean">
|
||
<span class="sig-name descname"><span class="pre">clean</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.clean"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.clean" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Any cleanup operations after the state ends.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.BaseState.next">
|
||
<span class="sig-name descname"><span class="pre">next</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">next_state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.next"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.next" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Get the next state after this one.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>next_state</strong> (<em>str</em><em>, </em><em>optional</em>) – This allows the calling code
|
||
to redirect to a different state than the ‘default’ one
|
||
(creating branching paths in the game). Override this method
|
||
to customize (by default the input will always override default
|
||
set on the class)</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><p><em>state_name (str or None)</em> –</p>
|
||
<dl class="simple">
|
||
<dt>Name of next state to switch to. None</dt><dd><p>to remain in this state. By default we check the room for the
|
||
“finished” flag be set.</p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.BaseState.character_enters">
|
||
<span class="sig-name descname"><span class="pre">character_enters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">character</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.character_enters"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.character_enters" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Called when character enters the room in this state.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.state.BaseState.character_leaves">
|
||
<span class="sig-name descname"><span class="pre">character_leaves</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">character</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/state.html#BaseState.character_leaves"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.character_leaves" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Called when character is whisked away (usually because of
|
||
quitting). This method cannot influence the move itself; it
|
||
happens just before room.character_cleanup()</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||
<div class="sphinxsidebarwrapper">
|
||
<p class="logo"><a href="../index.html">
|
||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
|
||
</a></p>
|
||
<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</search>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">evennia.contrib.full_systems.evscaperoom.state</a><ul>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler"><code class="docutils literal notranslate"><span class="pre">StateHandler</span></code></a><ul>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler.__init__"><code class="docutils literal notranslate"><span class="pre">StateHandler.__init__()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler.load_state"><code class="docutils literal notranslate"><span class="pre">StateHandler.load_state()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler.init_state"><code class="docutils literal notranslate"><span class="pre">StateHandler.init_state()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.StateHandler.next_state"><code class="docutils literal notranslate"><span class="pre">StateHandler.next_state()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState"><code class="docutils literal notranslate"><span class="pre">BaseState</span></code></a><ul>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.next_state"><code class="docutils literal notranslate"><span class="pre">BaseState.next_state</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.hints"><code class="docutils literal notranslate"><span class="pre">BaseState.hints</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.__init__"><code class="docutils literal notranslate"><span class="pre">BaseState.__init__()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.get_hint"><code class="docutils literal notranslate"><span class="pre">BaseState.get_hint()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.msg"><code class="docutils literal notranslate"><span class="pre">BaseState.msg()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.cinematic"><code class="docutils literal notranslate"><span class="pre">BaseState.cinematic()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.create_object"><code class="docutils literal notranslate"><span class="pre">BaseState.create_object()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.get_object"><code class="docutils literal notranslate"><span class="pre">BaseState.get_object()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.init"><code class="docutils literal notranslate"><span class="pre">BaseState.init()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.clean"><code class="docutils literal notranslate"><span class="pre">BaseState.clean()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.next"><code class="docutils literal notranslate"><span class="pre">BaseState.next()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.character_enters"><code class="docutils literal notranslate"><span class="pre">BaseState.character_enters()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.state.BaseState.character_leaves"><code class="docutils literal notranslate"><span class="pre">BaseState.character_leaves()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="evennia.contrib.full_systems.evscaperoom.scripts.html"
|
||
title="previous chapter">evennia.contrib.full_systems.evscaperoom.scripts</a></p>
|
||
</div>
|
||
<div>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="evennia.contrib.full_systems.evscaperoom.tests.html"
|
||
title="next chapter">evennia.contrib.full_systems.evscaperoom.tests</a></p>
|
||
</div>
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/api/evennia.contrib.full_systems.evscaperoom.state.md.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div><h3>Links</h3>
|
||
<ul>
|
||
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
|
||
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
|
||
<li><a href="https://github.com/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>Doc Versions</h3>
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
|
||
</li>
|
||
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="Related">
|
||
<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.full_systems.evscaperoom.tests.html" title="evennia.contrib.full_systems.evscaperoom.tests"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.contrib.full_systems.evscaperoom.scripts.html" title="evennia.contrib.full_systems.evscaperoom.scripts"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</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.full_systems.html" >evennia.contrib.full_systems</a> »</li>
|
||
<li class="nav-item nav-item-6"><a href="evennia.contrib.full_systems.evscaperoom.html" >evennia.contrib.full_systems.evscaperoom</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.state</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2024, The Evennia developer community.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
|
||
</div>
|
||
</body>
|
||
</html> |