mirror of
https://github.com/evennia/evennia.git
synced 2026-03-27 02:06:32 +01:00
302 lines
No EOL
26 KiB
HTML
302 lines
No EOL
26 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>evennia.utils.optionhandler — Evennia 2.x 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" />
|
|
</head><body>
|
|
|
|
|
|
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../../../genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="../../../py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../../../index.html">Evennia 2.x</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="../../evennia.html" accesskey="U">evennia</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">evennia.utils.optionhandler</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
|
|
<div class="documentwrapper">
|
|
<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><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="optionhandler.html">2.x (main branch)</a></li>
|
|
<ul>
|
|
<li><a href="../1.3.0/index.html">1.3.0 (v1.3.0 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="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<h1>Source code for evennia.utils.optionhandler</h1><div class="highlight"><pre>
|
|
<span></span><span class="kn">from</span> <span class="nn">django.utils.translation</span> <span class="kn">import</span> <span class="n">gettext</span> <span class="k">as</span> <span class="n">_</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">evennia.utils.containers</span> <span class="kn">import</span> <span class="n">OPTION_CLASSES</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">string_partial_matching</span>
|
|
|
|
<span class="n">_GA</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="fm">__getattribute__</span>
|
|
<span class="n">_SA</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="fm">__setattr__</span>
|
|
|
|
|
|
<div class="viewcode-block" id="InMemorySaveHandler"><a class="viewcode-back" href="../../../api/evennia.utils.optionhandler.html#evennia.utils.optionhandler.InMemorySaveHandler">[docs]</a><span class="k">class</span> <span class="nc">InMemorySaveHandler</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Fallback SaveHandler, implementing a minimum of the required save mechanism</span>
|
|
<span class="sd"> and storing data in memory.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
|
|
<div class="viewcode-block" id="InMemorySaveHandler.__init__"><a class="viewcode-back" href="../../../api/evennia.utils.optionhandler.html#evennia.utils.optionhandler.InMemorySaveHandler.__init__">[docs]</a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">storage</span> <span class="o">=</span> <span class="p">{}</span></div>
|
|
|
|
<div class="viewcode-block" id="InMemorySaveHandler.add"><a class="viewcode-back" href="../../../api/evennia.utils.optionhandler.html#evennia.utils.optionhandler.InMemorySaveHandler.add">[docs]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">storage</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span></div>
|
|
|
|
<div class="viewcode-block" id="InMemorySaveHandler.get"><a class="viewcode-back" href="../../../api/evennia.utils.optionhandler.html#evennia.utils.optionhandler.InMemorySaveHandler.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">storage</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="OptionHandler"><a class="viewcode-back" href="../../../api/evennia.utils.optionhandler.html#evennia.utils.optionhandler.OptionHandler">[docs]</a><span class="k">class</span> <span class="nc">OptionHandler</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> This is a generic Option handler. Retrieve options either as properties on</span>
|
|
<span class="sd"> this handler or by using the .get method.</span>
|
|
|
|
<span class="sd"> This is used for Account.options but it could be used by Scripts or Objects</span>
|
|
<span class="sd"> just as easily. All it needs to be provided is an options_dict.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
|
|
<div class="viewcode-block" id="OptionHandler.__init__"><a class="viewcode-back" href="../../../api/evennia.utils.optionhandler.html#evennia.utils.optionhandler.OptionHandler.__init__">[docs]</a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">obj</span><span class="p">,</span>
|
|
<span class="n">options_dict</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">savefunc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">loadfunc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">save_kwargs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">load_kwargs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Initialize an OptionHandler.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> obj (object): The object this handler sits on. This is usually a TypedObject.</span>
|
|
<span class="sd"> options_dict (dict): A dictionary of option keys, where the values</span>
|
|
<span class="sd"> are options. The format of those tuples is: ('key', "Description to</span>
|
|
<span class="sd"> show", 'option_type', <default value>)</span>
|
|
<span class="sd"> savefunc (callable): A callable for all options to call when saving itself.</span>
|
|
<span class="sd"> It will be called as `savefunc(key, value, **save_kwargs)`. A common one</span>
|
|
<span class="sd"> to pass would be AttributeHandler.add.</span>
|
|
<span class="sd"> loadfunc (callable): A callable for all options to call when loading data into</span>
|
|
<span class="sd"> itself. It will be called as `loadfunc(key, default=default, **load_kwargs)`.</span>
|
|
<span class="sd"> A common one to pass would be AttributeHandler.get.</span>
|
|
<span class="sd"> save_kwargs (any): Optional extra kwargs to pass into `savefunc` above.</span>
|
|
<span class="sd"> load_kwargs (any): Optional extra kwargs to pass into `loadfunc` above.</span>
|
|
|
|
<span class="sd"> Notes:</span>
|
|
<span class="sd"> Both loadfunc and savefunc must be specified. If only one is given, the other</span>
|
|
<span class="sd"> will be ignored and in-memory storage will be used.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">obj</span> <span class="o">=</span> <span class="n">obj</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">options_dict</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">if</span> <span class="n">options_dict</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">options_dict</span>
|
|
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">savefunc</span> <span class="ow">and</span> <span class="n">loadfunc</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_in_memory_handler</span> <span class="o">=</span> <span class="n">InMemorySaveHandler</span><span class="p">()</span>
|
|
<span class="n">savefunc</span> <span class="o">=</span> <span class="n">InMemorySaveHandler</span><span class="o">.</span><span class="n">add</span>
|
|
<span class="n">loadfunc</span> <span class="o">=</span> <span class="n">InMemorySaveHandler</span><span class="o">.</span><span class="n">get</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">savefunc</span> <span class="o">=</span> <span class="n">savefunc</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">loadfunc</span> <span class="o">=</span> <span class="n">loadfunc</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">save_kwargs</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">if</span> <span class="n">save_kwargs</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">save_kwargs</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">load_kwargs</span> <span class="o">=</span> <span class="p">{}</span> <span class="k">if</span> <span class="n">load_kwargs</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">load_kwargs</span>
|
|
|
|
<span class="c1"># This dictionary stores the in-memory Options objects by their key for</span>
|
|
<span class="c1"># quick lookup.</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">options</span> <span class="o">=</span> <span class="p">{}</span></div>
|
|
|
|
<span class="k">def</span> <span class="fm">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Allow for obj.options.key</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Allow for obj.options.key = value</span>
|
|
|
|
<span class="sd"> But we must be careful to avoid infinite loops!</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">_GA</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"options_dict"</span><span class="p">):</span>
|
|
<span class="n">_GA</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"set"</span><span class="p">)(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
|
|
<span class="k">pass</span>
|
|
<span class="n">_SA</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span> <span class="nf">_load_option</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Loads option on-demand if it has not been loaded yet.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> key (str): The option being loaded.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="n">desc</span><span class="p">,</span> <span class="n">clsname</span><span class="p">,</span> <span class="n">default_val</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">options_dict</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
|
|
<span class="n">loaded_option</span> <span class="o">=</span> <span class="n">OPTION_CLASSES</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">clsname</span><span class="p">)(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">desc</span><span class="p">,</span> <span class="n">default_val</span><span class="p">)</span>
|
|
<span class="c1"># store the value for future easy access</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">loaded_option</span>
|
|
<span class="k">return</span> <span class="n">loaded_option</span>
|
|
|
|
<div class="viewcode-block" id="OptionHandler.get"><a class="viewcode-back" href="../../../api/evennia.utils.optionhandler.html#evennia.utils.optionhandler.OptionHandler.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">return_obj</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">raise_error</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Retrieves an Option stored in the handler. Will load it if it doesn't exist.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> key (str): The option key to retrieve.</span>
|
|
<span class="sd"> default (any): What to return if the option is defined.</span>
|
|
<span class="sd"> return_obj (bool, optional): If True, returns the actual option</span>
|
|
<span class="sd"> object instead of its value.</span>
|
|
<span class="sd"> raise_error (bool, optional): Raise Exception if key is not found in options.</span>
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> option_value (any or Option): An option value the Option itself.</span>
|
|
<span class="sd"> Raises:</span>
|
|
<span class="sd"> KeyError: If option is not defined.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">options_dict</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">raise_error</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Option not found!"</span><span class="p">))</span>
|
|
<span class="k">return</span> <span class="n">default</span>
|
|
<span class="c1"># get the options or load/recache it</span>
|
|
<span class="n">op_found</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_load_option</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">op_found</span> <span class="k">if</span> <span class="n">return_obj</span> <span class="k">else</span> <span class="n">op_found</span><span class="o">.</span><span class="n">value</span></div>
|
|
|
|
<div class="viewcode-block" id="OptionHandler.set"><a class="viewcode-back" href="../../../api/evennia.utils.optionhandler.html#evennia.utils.optionhandler.OptionHandler.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Change an individual option.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> key (str): The key of an option that can be changed. Allows partial matching.</span>
|
|
<span class="sd"> value (str): The value that should be checked, coerced, and stored.:</span>
|
|
<span class="sd"> kwargs (any, optional): These are passed into the Option's validation function,</span>
|
|
<span class="sd"> save function and display function and allows to customize either.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> value (any): Value stored in option, after validation.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">key</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Option field blank!"</span><span class="p">))</span>
|
|
<span class="n">match</span> <span class="o">=</span> <span class="n">string_partial_matching</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">options_dict</span><span class="o">.</span><span class="n">keys</span><span class="p">()),</span> <span class="n">key</span><span class="p">,</span> <span class="n">ret_index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">match</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">"Option not found!"</span><span class="p">))</span>
|
|
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">match</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
|
|
<span class="n">_</span><span class="p">(</span><span class="s2">"Multiple matches:"</span><span class="p">)</span> <span class="o">+</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">match</span><span class="p">)</span><span class="si">}</span><span class="s2">. "</span> <span class="o">+</span> <span class="n">_</span><span class="p">(</span><span class="s2">"Please be more specific."</span><span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="n">match</span> <span class="o">=</span> <span class="n">match</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
|
<span class="n">op</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">match</span><span class="p">,</span> <span class="n">return_obj</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
<span class="n">op</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">op</span><span class="o">.</span><span class="n">value</span></div>
|
|
|
|
<div class="viewcode-block" id="OptionHandler.all"><a class="viewcode-back" href="../../../api/evennia.utils.optionhandler.html#evennia.utils.optionhandler.OptionHandler.all">[docs]</a> <span class="k">def</span> <span class="nf">all</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">return_objs</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Get all options defined on this handler.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> return_objs (bool, optional): Return the actual Option objects rather</span>
|
|
<span class="sd"> than their values.</span>
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> all_options (dict): All options on this handler, either `{key: value}`</span>
|
|
<span class="sd"> or `{key: <Option>}` if `return_objs` is `True`.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">return_obj</span><span class="o">=</span><span class="n">return_objs</span><span class="p">)</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">options_dict</span><span class="p">]</span></div></div>
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../../../genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="../../../py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../../../index.html">Evennia 2.x</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="../../evennia.html" >evennia</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">evennia.utils.optionhandler</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2023, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
|
</div>
|
|
</body>
|
|
</html> |