<spanid="evennia-utils-validatorfuncs"></span><h1>evennia.utils.validatorfuncs<aclass="headerlink"href="#module-evennia.utils.validatorfuncs"title="Link to this heading">¶</a></h1>
<p>Contains all the validation functions.</p>
<p>All validation functions must have a checker (probably a session) and entry arg.</p>
<p>They can employ more paramters at your leisure.</p>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.utils.validatorfuncs.</span></span><spanclass="sig-name descname"><spanclass="pre">text</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">entry</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">option_key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'Text'</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/validatorfuncs.html#text"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.utils.validatorfuncs.text"title="Link to this definition">¶</a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.utils.validatorfuncs.</span></span><spanclass="sig-name descname"><spanclass="pre">color</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">entry</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">option_key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'Color'</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/validatorfuncs.html#color"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.utils.validatorfuncs.color"title="Link to this definition">¶</a></dt>
<dd><p>The color should be just a color character, so ‘r’ if red color is desired.</p>
<li><p><strong>entry</strong> (<em>str</em>) – A date string from a user.</p></li>
<li><p><strong>option_key</strong> (<em>str</em>) – Name to display this datetime as.</p></li>
<li><p><strong>account</strong> (<aclass="reference internal"href="evennia.accounts.accounts.html#evennia.accounts.accounts.AccountDB"title="evennia.accounts.accounts.AccountDB"><em>AccountDB</em></a>) – The Account performing this lookup. Unless <strong>from_tz</strong> is provided,
the account’s timezone option will be used.</p></li>
<li><p><strong>from_tz</strong> (<em>pytz.timezone</em>) – An instance of a pytz timezone object from the
user. If not provided, tries to use the timezone option of <strong>account</strong>.
If neither one is provided, defaults to UTC.</p></li>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.utils.validatorfuncs.</span></span><spanclass="sig-name descname"><spanclass="pre">duration</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">entry</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">option_key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'Duration'</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/validatorfuncs.html#duration"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.utils.validatorfuncs.duration"title="Link to this definition">¶</a></dt>
<dd><p>Take a string and derive a datetime timedelta from it.</p>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.utils.validatorfuncs.</span></span><spanclass="sig-name descname"><spanclass="pre">future</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">entry</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">option_key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'Future</span><spanclass="pre">Datetime'</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">from_tz</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/validatorfuncs.html#future"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.utils.validatorfuncs.future"title="Link to this definition">¶</a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.utils.validatorfuncs.</span></span><spanclass="sig-name descname"><spanclass="pre">signed_integer</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">entry</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">option_key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'Signed</span><spanclass="pre">Integer'</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/validatorfuncs.html#signed_integer"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.utils.validatorfuncs.signed_integer"title="Link to this definition">¶</a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.utils.validatorfuncs.</span></span><spanclass="sig-name descname"><spanclass="pre">positive_integer</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">entry</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">option_key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'Positive</span><spanclass="pre">Integer'</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/validatorfuncs.html#positive_integer"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.utils.validatorfuncs.positive_integer"title="Link to this definition">¶</a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.utils.validatorfuncs.</span></span><spanclass="sig-name descname"><spanclass="pre">unsigned_integer</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">entry</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">option_key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'Unsigned</span><spanclass="pre">Integer'</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/validatorfuncs.html#unsigned_integer"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.utils.validatorfuncs.unsigned_integer"title="Link to this definition">¶</a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.utils.validatorfuncs.</span></span><spanclass="sig-name descname"><spanclass="pre">boolean</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">entry</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">option_key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'True/False'</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/validatorfuncs.html#boolean"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.utils.validatorfuncs.boolean"title="Link to this definition">¶</a></dt>
<dd><p>Simplest check in computer logic, right? This will take user input to flick the switch on or off</p>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.utils.validatorfuncs.</span></span><spanclass="sig-name descname"><spanclass="pre">timezone</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">entry</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">option_key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'Timezone'</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/validatorfuncs.html#timezone"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.utils.validatorfuncs.timezone"title="Link to this definition">¶</a></dt>
<dd><p>Takes user input as string, and partial matches a Timezone.</p>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.utils.validatorfuncs.</span></span><spanclass="sig-name descname"><spanclass="pre">email</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">entry</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">option_key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'Email</span><spanclass="pre">Address'</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/validatorfuncs.html#email"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.utils.validatorfuncs.email"title="Link to this definition">¶</a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.utils.validatorfuncs.</span></span><spanclass="sig-name descname"><spanclass="pre">lock</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">entry</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">option_key</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'locks'</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">access_options</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/validatorfuncs.html#lock"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.utils.validatorfuncs.lock"title="Link to this definition">¶</a></dt>