Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-19 22:36:31 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/2.x/api/evennia.web.website.views.characters.html

375 lines
30 KiB
HTML
Raw Normal View History

Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<title>evennia.web.website.views.characters &#8212; Evennia 2.x documentation</title>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.web.website.views.errors" href="evennia.web.website.views.errors.html" />
<link rel="prev" title="evennia.web.website.views.channels" href="evennia.web.website.views.channels.html" />
</head><body>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.web.website.views.errors.html" title="evennia.web.website.views.errors"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.web.website.views.channels.html" title="evennia.web.website.views.channels"
accesskey="P">previous</a> |</li>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> &#187;</li>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<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.web.html" >evennia.web</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.web.website.html" >evennia.web.website</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.web.website.views.html" accesskey="U">evennia.web.website.views</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.characters</a></li>
</ul>
Updated HTML docs.
2023-06-10 08:53:19 +00:00
</div>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<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>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.web.website.views.channels.html"
title="previous chapter">evennia.web.website.views.channels</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.web.website.views.errors.html"
title="next chapter">evennia.web.website.views.errors</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.web.website.views.characters.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<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>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<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>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<h3>Doc Versions</h3>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<ul>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li><a href="evennia.web.website.views.characters.html">2.x (main branch)</a></li>
Updated HTML docs.
2022-11-15 20:29:38 +00:00
<ul>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<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>
Updated HTML docs.
2022-11-15 20:29:38 +00:00
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.web.website.views.characters">
<span id="evennia-web-website-views-characters"></span><h1>evennia.web.website.views.characters<a class="headerlink" href="#module-evennia.web.website.views.characters" title="Permalink to this headline"></a></h1>
<p>Views for manipulating Characters (children of Objects often used for
puppeting).</p>
<dl class="py class">
<dt id="evennia.web.website.views.characters.CharacterMixin">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterMixin</code><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.TypeclassMixin" title="evennia.web.website.views.mixins.TypeclassMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.TypeclassMixin</span></code></a></p>
<p>This is a “mixin”, a modifier of sorts.</p>
<p>Any view class with this in its inheritance list will be modified to work
with Character objects instead of generic Objects or otherwise.</p>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterMixin.model">
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin.model" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter" title="evennia.objects.objects.DefaultCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterMixin.form_class">
<code class="sig-name descname">form_class</code><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin.form_class" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.web.website.forms.html#evennia.web.website.forms.CharacterForm" title="evennia.web.website.forms.CharacterForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.forms.CharacterForm</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterMixin.success_url">
<code class="sig-name descname">success_url</code><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin.success_url" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.web.website.views.characters.CharacterMixin.get_queryset">
<code class="sig-name descname">get_queryset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterMixin.get_queryset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin.get_queryset" title="Permalink to this definition"></a></dt>
<dd><p>This method will override the Django get_queryset method to only
return a list of characters associated with the current authenticated
user.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><em>queryset (QuerySet)</em> – Django queryset for use in the given view.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.web.website.views.characters.CharacterListView">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterListView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterListView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.contrib.auth.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin" title="evennia.web.website.views.characters.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.characters.CharacterMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.list.ListView</span></code></p>
<p>This view provides a mechanism by which a logged-in player can view a list
of all other characters.</p>
<p>This view requires authentication by default as a nominal effort to prevent
human stalkers and automated bots/scrapers from harvesting data on your users.</p>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterListView.template_name">
<code class="sig-name descname">template_name</code><em class="property"> = 'website/character_list.html'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.template_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterListView.paginate_by">
<code class="sig-name descname">paginate_by</code><em class="property"> = 100</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.paginate_by" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterListView.page_title">
<code class="sig-name descname">page_title</code><em class="property"> = 'Character List'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.page_title" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterListView.access_type">
<code class="sig-name descname">access_type</code><em class="property"> = 'view'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.access_type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.web.website.views.characters.CharacterListView.get_queryset">
<code class="sig-name descname">get_queryset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterListView.get_queryset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.get_queryset" title="Permalink to this definition"></a></dt>
<dd><p>This method will override the Django get_queryset method to return a
list of all characters (filtered/sorted) instead of just those limited
to the account.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><em>queryset (QuerySet)</em> – Django queryset for use in the given view.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.web.website.views.characters.CharacterPuppetView">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterPuppetView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterPuppetView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterPuppetView" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.contrib.auth.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin" title="evennia.web.website.views.characters.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.characters.CharacterMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.base.RedirectView</span></code>, <a class="reference internal" href="evennia.web.website.views.objects.html#evennia.web.website.views.objects.ObjectDetailView" title="evennia.web.website.views.objects.ObjectDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectDetailView</span></code></a></p>
<p>This view provides a mechanism by which a logged-in player can “puppet” one
of their characters within the context of the website.</p>
<p>It also ensures that any user attempting to puppet something is logged in,
and that their intended puppet is one that they own.</p>
<dl class="py method">
<dt id="evennia.web.website.views.characters.CharacterPuppetView.get_redirect_url">
<code class="sig-name descname">get_redirect_url</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterPuppetView.get_redirect_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterPuppetView.get_redirect_url" title="Permalink to this definition"></a></dt>
<dd><p>Django hook.</p>
<p>This view returns the URL to which the user should be redirected after
a passed or failed puppet attempt.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><em>url (str)</em> – Path to post-puppet destination.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.web.website.views.characters.CharacterManageView">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterManageView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterManageView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterManageView" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.contrib.auth.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin" title="evennia.web.website.views.characters.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.characters.CharacterMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">django.views.generic.list.ListView</span></code></p>
<p>This view provides a mechanism by which a logged-in player can browse,
edit, or delete their own characters.</p>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterManageView.paginate_by">
<code class="sig-name descname">paginate_by</code><em class="property"> = 10</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterManageView.paginate_by" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterManageView.template_name">
<code class="sig-name descname">template_name</code><em class="property"> = 'website/character_manage_list.html'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterManageView.template_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterManageView.page_title">
<code class="sig-name descname">page_title</code><em class="property"> = 'Manage Characters'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterManageView.page_title" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.web.website.views.characters.CharacterUpdateView">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterUpdateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterUpdateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterUpdateView" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin" title="evennia.web.website.views.characters.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.characters.CharacterMixin</span></code></a>, <a class="reference internal" href="evennia.web.website.views.objects.html#evennia.web.website.views.objects.ObjectUpdateView" title="evennia.web.website.views.objects.ObjectUpdateView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectUpdateView</span></code></a></p>
<p>This view provides a mechanism by which a logged-in player (enforced by
ObjectUpdateView) can edit the attributes of a character they own.</p>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterUpdateView.form_class">
<code class="sig-name descname">form_class</code><a class="headerlink" href="#evennia.web.website.views.characters.CharacterUpdateView.form_class" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.web.website.forms.html#evennia.web.website.forms.CharacterUpdateForm" title="evennia.web.website.forms.CharacterUpdateForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.forms.CharacterUpdateForm</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterUpdateView.template_name">
<code class="sig-name descname">template_name</code><em class="property"> = 'website/character_form.html'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterUpdateView.template_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.web.website.views.characters.CharacterDetailView">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterDetailView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterDetailView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin" title="evennia.web.website.views.characters.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.characters.CharacterMixin</span></code></a>, <a class="reference internal" href="evennia.web.website.views.objects.html#evennia.web.website.views.objects.ObjectDetailView" title="evennia.web.website.views.objects.ObjectDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectDetailView</span></code></a></p>
<p>This view provides a mechanism by which a user can view the attributes of
a character, owned by them or not.</p>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterDetailView.template_name">
<code class="sig-name descname">template_name</code><em class="property"> = 'website/object_detail.html'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView.template_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterDetailView.attributes">
<code class="sig-name descname">attributes</code><em class="property"> = ['name', 'desc']</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView.attributes" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterDetailView.access_type">
<code class="sig-name descname">access_type</code><em class="property"> = 'view'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView.access_type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.web.website.views.characters.CharacterDetailView.get_queryset">
<code class="sig-name descname">get_queryset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterDetailView.get_queryset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView.get_queryset" title="Permalink to this definition"></a></dt>
<dd><p>This method will override the Django get_queryset method to return a
list of all characters the user may access.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><em>queryset (QuerySet)</em> – Django queryset for use in the given view.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.web.website.views.characters.CharacterDeleteView">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterDeleteView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterDeleteView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDeleteView" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin" title="evennia.web.website.views.characters.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.characters.CharacterMixin</span></code></a>, <a class="reference internal" href="evennia.web.website.views.objects.html#evennia.web.website.views.objects.ObjectDeleteView" title="evennia.web.website.views.objects.ObjectDeleteView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectDeleteView</span></code></a></p>
<p>This view provides a mechanism by which a logged-in player (enforced by
ObjectDeleteView) can delete a character they own.</p>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterDeleteView.form_class">
<code class="sig-name descname">form_class</code><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDeleteView.form_class" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.web.website.forms.html#evennia.web.website.forms.EvenniaForm" title="evennia.web.website.forms.EvenniaForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.forms.EvenniaForm</span></code></a></p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.web.website.views.characters.CharacterCreateView">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.characters.</code><code class="sig-name descname">CharacterCreateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterCreateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterCreateView" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin" title="evennia.web.website.views.characters.CharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.characters.CharacterMixin</span></code></a>, <a class="reference internal" href="evennia.web.website.views.objects.html#evennia.web.website.views.objects.ObjectCreateView" title="evennia.web.website.views.objects.ObjectCreateView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectCreateView</span></code></a></p>
<p>This view provides a mechanism by which a logged-in player (enforced by
ObjectCreateView) can create a new character.</p>
<dl class="py attribute">
<dt id="evennia.web.website.views.characters.CharacterCreateView.template_name">
<code class="sig-name descname">template_name</code><em class="property"> = 'website/character_form.html'</em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterCreateView.template_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.web.website.views.characters.CharacterCreateView.form_valid">
<code class="sig-name descname">form_valid</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">form</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterCreateView.form_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterCreateView.form_valid" title="Permalink to this definition"></a></dt>
<dd><p>Django hook, modified for Evennia.</p>
<p>This hook is called after a valid form is submitted.</p>
<p>When an character creation form is submitted and the data is deemed valid,
proceeds with creating the Character object.</p>
</dd></dl>
</dd></dl>
</section>
</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="right" >
<a href="evennia.web.website.views.errors.html" title="evennia.web.website.views.errors"
>next</a> |</li>
<li class="right" >
<a href="evennia.web.website.views.channels.html" title="evennia.web.website.views.channels"
>previous</a> |</li>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> &#187;</li>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<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.web.html" >evennia.web</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.web.website.html" >evennia.web.website</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.web.website.views.html" >evennia.web.website.views</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.characters</a></li>
</ul>
</div>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<div class="footer" role="contentinfo">
Updated HTML docs.
2023-10-19 20:22:27 +00:00
&#169; Copyright 2023, The Evennia developer community.
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue Copy permalink