Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-27 02:06:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/latest/api/evennia.web.website.views.characters.html
Evennia docbuilder action 243d596662 Updated HTML docs.
2025-08-15 18:14:21 +00:00

445 lines
No EOL
41 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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.web.website.views.characters &#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.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>
<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.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>
<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.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>
</div>
<div class="document">
<div class="documentwrapper">
<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="Link to this heading"></a></h1>
<p>Views for manipulating Characters (children of Objects often used for
puppeting).</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterMixin">
<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.web.website.views.characters.</span></span><span class="sig-name descname"><span class="pre">CharacterMixin</span></span><a class="reference internal" href="../_modules/evennia/web/website/views/characters.html#CharacterMixin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin" title="Link 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">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 class="sig sig-object py" id="evennia.web.website.views.characters.CharacterMixin.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin.model" title="Link 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">DefaultCharacter</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterMixin.form_class">
<span class="sig-name descname"><span class="pre">form_class</span></span><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin.form_class" title="Link 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">CharacterForm</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterMixin.success_url">
<span class="sig-name descname"><span class="pre">success_url</span></span><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin.success_url" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterMixin.get_queryset">
<span class="sig-name descname"><span class="pre">get_queryset</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterMixin.get_queryset" title="Link 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<span class="colon">:</span></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 class="sig sig-object py" id="evennia.web.website.views.characters.CharacterListView">
<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.web.website.views.characters.</span></span><span class="sig-name descname"><span class="pre">CharacterListView</span></span><span class="sig-paren">(</span><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/web/website/views/characters.html#CharacterListView"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">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">CharacterMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">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 class="sig sig-object py" id="evennia.web.website.views.characters.CharacterListView.template_name">
<span class="sig-name descname"><span class="pre">template_name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'website/character_list.html'</span></em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.template_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterListView.paginate_by">
<span class="sig-name descname"><span class="pre">paginate_by</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">100</span></em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.paginate_by" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterListView.page_title">
<span class="sig-name descname"><span class="pre">page_title</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Character</span> <span class="pre">List'</span></em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.page_title" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterListView.access_type">
<span class="sig-name descname"><span class="pre">access_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'view'</span></em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.access_type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterListView.get_queryset">
<span class="sig-name descname"><span class="pre">get_queryset</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterListView.get_queryset" title="Link 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<span class="colon">:</span></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 class="sig sig-object py" id="evennia.web.website.views.characters.CharacterPuppetView">
<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.web.website.views.characters.</span></span><span class="sig-name descname"><span class="pre">CharacterPuppetView</span></span><span class="sig-paren">(</span><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/web/website/views/characters.html#CharacterPuppetView"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterPuppetView" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">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">CharacterMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">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">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 class="sig sig-object py" id="evennia.web.website.views.characters.CharacterPuppetView.get_redirect_url">
<span class="sig-name descname"><span class="pre">get_redirect_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</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/web/website/views/characters.html#CharacterPuppetView.get_redirect_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterPuppetView.get_redirect_url" title="Link 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<span class="colon">:</span></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 class="sig sig-object py" id="evennia.web.website.views.characters.CharacterManageView">
<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.web.website.views.characters.</span></span><span class="sig-name descname"><span class="pre">CharacterManageView</span></span><span class="sig-paren">(</span><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/web/website/views/characters.html#CharacterManageView"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterManageView" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">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">CharacterMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">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 class="sig sig-object py" id="evennia.web.website.views.characters.CharacterManageView.paginate_by">
<span class="sig-name descname"><span class="pre">paginate_by</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterManageView.paginate_by" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterManageView.template_name">
<span class="sig-name descname"><span class="pre">template_name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'website/character_manage_list.html'</span></em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterManageView.template_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterManageView.page_title">
<span class="sig-name descname"><span class="pre">page_title</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Manage</span> <span class="pre">Characters'</span></em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterManageView.page_title" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterUpdateView">
<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.web.website.views.characters.</span></span><span class="sig-name descname"><span class="pre">CharacterUpdateView</span></span><span class="sig-paren">(</span><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/web/website/views/characters.html#CharacterUpdateView"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterUpdateView" title="Link 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">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">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 class="sig sig-object py" id="evennia.web.website.views.characters.CharacterUpdateView.form_class">
<span class="sig-name descname"><span class="pre">form_class</span></span><a class="headerlink" href="#evennia.web.website.views.characters.CharacterUpdateView.form_class" title="Link 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">CharacterUpdateForm</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterUpdateView.template_name">
<span class="sig-name descname"><span class="pre">template_name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'website/character_form.html'</span></em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterUpdateView.template_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterDetailView">
<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.web.website.views.characters.</span></span><span class="sig-name descname"><span class="pre">CharacterDetailView</span></span><span class="sig-paren">(</span><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/web/website/views/characters.html#CharacterDetailView"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView" title="Link 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">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">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 class="sig sig-object py" id="evennia.web.website.views.characters.CharacterDetailView.template_name">
<span class="sig-name descname"><span class="pre">template_name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'website/object_detail.html'</span></em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView.template_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterDetailView.attributes">
<span class="sig-name descname"><span class="pre">attributes</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['name',</span> <span class="pre">'desc']</span></em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView.attributes" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterDetailView.access_type">
<span class="sig-name descname"><span class="pre">access_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'view'</span></em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView.access_type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterDetailView.get_queryset">
<span class="sig-name descname"><span class="pre">get_queryset</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDetailView.get_queryset" title="Link 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<span class="colon">:</span></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 class="sig sig-object py" id="evennia.web.website.views.characters.CharacterDeleteView">
<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.web.website.views.characters.</span></span><span class="sig-name descname"><span class="pre">CharacterDeleteView</span></span><span class="sig-paren">(</span><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/web/website/views/characters.html#CharacterDeleteView"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDeleteView" title="Link 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">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">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 class="sig sig-object py" id="evennia.web.website.views.characters.CharacterDeleteView.form_class">
<span class="sig-name descname"><span class="pre">form_class</span></span><a class="headerlink" href="#evennia.web.website.views.characters.CharacterDeleteView.form_class" title="Link 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">EvenniaForm</span></code></a></p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterCreateView">
<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.web.website.views.characters.</span></span><span class="sig-name descname"><span class="pre">CharacterCreateView</span></span><span class="sig-paren">(</span><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/web/website/views/characters.html#CharacterCreateView"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterCreateView" title="Link 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">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">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 class="sig sig-object py" id="evennia.web.website.views.characters.CharacterCreateView.template_name">
<span class="sig-name descname"><span class="pre">template_name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'website/character_form.html'</span></em><a class="headerlink" href="#evennia.web.website.views.characters.CharacterCreateView.template_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.website.views.characters.CharacterCreateView.form_valid">
<span class="sig-name descname"><span class="pre">form_valid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">form</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.views.characters.CharacterCreateView.form_valid" title="Link 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 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.web.website.views.characters</a><ul>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin"><code class="docutils literal notranslate"><span class="pre">CharacterMixin</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin.model"><code class="docutils literal notranslate"><span class="pre">CharacterMixin.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin.form_class"><code class="docutils literal notranslate"><span class="pre">CharacterMixin.form_class</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin.success_url"><code class="docutils literal notranslate"><span class="pre">CharacterMixin.success_url</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterMixin.get_queryset"><code class="docutils literal notranslate"><span class="pre">CharacterMixin.get_queryset()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterListView"><code class="docutils literal notranslate"><span class="pre">CharacterListView</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterListView.template_name"><code class="docutils literal notranslate"><span class="pre">CharacterListView.template_name</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterListView.paginate_by"><code class="docutils literal notranslate"><span class="pre">CharacterListView.paginate_by</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterListView.page_title"><code class="docutils literal notranslate"><span class="pre">CharacterListView.page_title</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterListView.access_type"><code class="docutils literal notranslate"><span class="pre">CharacterListView.access_type</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterListView.get_queryset"><code class="docutils literal notranslate"><span class="pre">CharacterListView.get_queryset()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterPuppetView"><code class="docutils literal notranslate"><span class="pre">CharacterPuppetView</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterPuppetView.get_redirect_url"><code class="docutils literal notranslate"><span class="pre">CharacterPuppetView.get_redirect_url()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterManageView"><code class="docutils literal notranslate"><span class="pre">CharacterManageView</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterManageView.paginate_by"><code class="docutils literal notranslate"><span class="pre">CharacterManageView.paginate_by</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterManageView.template_name"><code class="docutils literal notranslate"><span class="pre">CharacterManageView.template_name</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterManageView.page_title"><code class="docutils literal notranslate"><span class="pre">CharacterManageView.page_title</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterUpdateView"><code class="docutils literal notranslate"><span class="pre">CharacterUpdateView</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterUpdateView.form_class"><code class="docutils literal notranslate"><span class="pre">CharacterUpdateView.form_class</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterUpdateView.template_name"><code class="docutils literal notranslate"><span class="pre">CharacterUpdateView.template_name</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterDetailView"><code class="docutils literal notranslate"><span class="pre">CharacterDetailView</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterDetailView.template_name"><code class="docutils literal notranslate"><span class="pre">CharacterDetailView.template_name</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterDetailView.attributes"><code class="docutils literal notranslate"><span class="pre">CharacterDetailView.attributes</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterDetailView.access_type"><code class="docutils literal notranslate"><span class="pre">CharacterDetailView.access_type</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterDetailView.get_queryset"><code class="docutils literal notranslate"><span class="pre">CharacterDetailView.get_queryset()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterDeleteView"><code class="docutils literal notranslate"><span class="pre">CharacterDeleteView</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterDeleteView.form_class"><code class="docutils literal notranslate"><span class="pre">CharacterDeleteView.form_class</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterCreateView"><code class="docutils literal notranslate"><span class="pre">CharacterCreateView</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterCreateView.template_name"><code class="docutils literal notranslate"><span class="pre">CharacterCreateView.template_name</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.views.characters.CharacterCreateView.form_valid"><code class="docutils literal notranslate"><span class="pre">CharacterCreateView.form_valid()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div>
<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>
</div>
<div>
<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>
<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>
<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.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>
<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.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>
<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>
Reference in a new issue View git blame Copy permalink