evennia/docs/6.x/api/evennia.contrib.game_systems.storage.html
2026-02-15 19:06:04 +01:00

249 lines
No EOL
22 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.game_systems.storage &#8212; 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.game_systems.storage.storage" href="evennia.contrib.game_systems.storage.storage.html" />
<link rel="prev" title="evennia.contrib.game_systems.puzzles.tests" href="evennia.contrib.game_systems.puzzles.tests.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.game_systems.storage.storage.html" title="evennia.contrib.game_systems.storage.storage"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.game_systems.puzzles.tests.html" title="evennia.contrib.game_systems.puzzles.tests"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.game_systems.html" accesskey="U">evennia.contrib.game_systems</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.storage</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.game_systems.storage">
<span id="evennia-contrib-game-systems-storage"></span><h1>evennia.contrib.game_systems.storage<a class="headerlink" href="#module-evennia.contrib.game_systems.storage" title="Link to this heading"></a></h1>
<p>Item storage integration - helpme 2024</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html">evennia.contrib.game_systems.storage.storage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.StorageCommand"><code class="docutils literal notranslate"><span class="pre">StorageCommand</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.StorageCommand.at_pre_cmd"><code class="docutils literal notranslate"><span class="pre">StorageCommand.at_pre_cmd()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.StorageCommand.aliases"><code class="docutils literal notranslate"><span class="pre">StorageCommand.aliases</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.StorageCommand.help_category"><code class="docutils literal notranslate"><span class="pre">StorageCommand.help_category</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.StorageCommand.key"><code class="docutils literal notranslate"><span class="pre">StorageCommand.key</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.StorageCommand.lock_storage"><code class="docutils literal notranslate"><span class="pre">StorageCommand.lock_storage</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.StorageCommand.search_index_entry"><code class="docutils literal notranslate"><span class="pre">StorageCommand.search_index_entry</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStore"><code class="docutils literal notranslate"><span class="pre">CmdStore</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStore.key"><code class="docutils literal notranslate"><span class="pre">CmdStore.key</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStore.locks"><code class="docutils literal notranslate"><span class="pre">CmdStore.locks</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStore.help_category"><code class="docutils literal notranslate"><span class="pre">CmdStore.help_category</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStore.func"><code class="docutils literal notranslate"><span class="pre">CmdStore.func()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStore.aliases"><code class="docutils literal notranslate"><span class="pre">CmdStore.aliases</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStore.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdStore.lock_storage</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStore.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdStore.search_index_entry</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdRetrieve"><code class="docutils literal notranslate"><span class="pre">CmdRetrieve</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdRetrieve.key"><code class="docutils literal notranslate"><span class="pre">CmdRetrieve.key</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdRetrieve.locks"><code class="docutils literal notranslate"><span class="pre">CmdRetrieve.locks</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdRetrieve.help_category"><code class="docutils literal notranslate"><span class="pre">CmdRetrieve.help_category</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdRetrieve.func"><code class="docutils literal notranslate"><span class="pre">CmdRetrieve.func()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdRetrieve.aliases"><code class="docutils literal notranslate"><span class="pre">CmdRetrieve.aliases</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdRetrieve.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdRetrieve.lock_storage</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdRetrieve.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdRetrieve.search_index_entry</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdList"><code class="docutils literal notranslate"><span class="pre">CmdList</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdList.key"><code class="docutils literal notranslate"><span class="pre">CmdList.key</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdList.locks"><code class="docutils literal notranslate"><span class="pre">CmdList.locks</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdList.help_category"><code class="docutils literal notranslate"><span class="pre">CmdList.help_category</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdList.func"><code class="docutils literal notranslate"><span class="pre">CmdList.func()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdList.aliases"><code class="docutils literal notranslate"><span class="pre">CmdList.aliases</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdList.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdList.lock_storage</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdList.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdList.search_index_entry</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStorage"><code class="docutils literal notranslate"><span class="pre">CmdStorage</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStorage.key"><code class="docutils literal notranslate"><span class="pre">CmdStorage.key</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStorage.locks"><code class="docutils literal notranslate"><span class="pre">CmdStorage.locks</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStorage.func"><code class="docutils literal notranslate"><span class="pre">CmdStorage.func()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStorage.aliases"><code class="docutils literal notranslate"><span class="pre">CmdStorage.aliases</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStorage.help_category"><code class="docutils literal notranslate"><span class="pre">CmdStorage.help_category</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStorage.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdStorage.lock_storage</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.CmdStorage.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdStorage.search_index_entry</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.StorageCmdSet"><code class="docutils literal notranslate"><span class="pre">StorageCmdSet</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.StorageCmdSet.at_cmdset_creation"><code class="docutils literal notranslate"><span class="pre">StorageCmdSet.at_cmdset_creation()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.storage.html#evennia.contrib.game_systems.storage.storage.StorageCmdSet.path"><code class="docutils literal notranslate"><span class="pre">StorageCmdSet.path</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.game_systems.storage.tests.html">evennia.contrib.game_systems.storage.tests</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.game_systems.storage.tests.html#evennia.contrib.game_systems.storage.tests.TestStorage"><code class="docutils literal notranslate"><span class="pre">TestStorage</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.tests.html#evennia.contrib.game_systems.storage.tests.TestStorage.setUp"><code class="docutils literal notranslate"><span class="pre">TestStorage.setUp()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.tests.html#evennia.contrib.game_systems.storage.tests.TestStorage.test_store_and_retrieve"><code class="docutils literal notranslate"><span class="pre">TestStorage.test_store_and_retrieve()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.tests.html#evennia.contrib.game_systems.storage.tests.TestStorage.test_store_retrieve_while_not_in_storeroom"><code class="docutils literal notranslate"><span class="pre">TestStorage.test_store_retrieve_while_not_in_storeroom()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.tests.html#evennia.contrib.game_systems.storage.tests.TestStorage.test_store_retrieve_nonexistent_obj"><code class="docutils literal notranslate"><span class="pre">TestStorage.test_store_retrieve_nonexistent_obj()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.tests.html#evennia.contrib.game_systems.storage.tests.TestStorage.test_list_nothing_stored"><code class="docutils literal notranslate"><span class="pre">TestStorage.test_list_nothing_stored()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.tests.html#evennia.contrib.game_systems.storage.tests.TestStorage.test_shared_storage"><code class="docutils literal notranslate"><span class="pre">TestStorage.test_shared_storage()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.game_systems.storage.tests.html#evennia.contrib.game_systems.storage.tests.TestStorage.test_remove_add_storage"><code class="docutils literal notranslate"><span class="pre">TestStorage.test_remove_add_storage()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</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>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.game_systems.puzzles.tests.html"
title="previous chapter">evennia.contrib.game_systems.puzzles.tests</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.game_systems.storage.storage.html"
title="next chapter">evennia.contrib.game_systems.storage.storage</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.game_systems.storage.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/6.x/index.html">v6.0.0 branch (outdated)</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.game_systems.storage.storage.html" title="evennia.contrib.game_systems.storage.storage"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.game_systems.puzzles.tests.html" title="evennia.contrib.game_systems.puzzles.tests"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.game_systems.html" >evennia.contrib.game_systems</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.game_systems.storage</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>