2020-07-14 00:21:00 +02:00
<!DOCTYPE html>
2020-10-15 01:31:30 +02:00
< html >
2020-07-14 00:21:00 +02:00
< head >
< meta charset = "utf-8" / >
2021-05-16 00:06:01 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docutils 0.17.1: http://docutils.sourceforge.net/" / >
2020-07-14 00:21:00 +02:00
< title > evennia.web.website.forms — Evennia 1.0-dev 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 >
2021-10-26 21:41:11 +02:00
< script async = "async" src = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML" > < / script >
< script type = "text/x-mathjax-config" > MathJax . Hub . Config ( { "tex2jax" : { "processClass" : "tex2jax_process|mathjax_process|math|output_area" } } ) < / script >
2020-07-14 00:21:00 +02:00
< 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 >
2020-10-15 01:31:30 +02:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 1.0-dev< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > evennia.web.website.forms< / a > < / li >
2020-07-14 00:21:00 +02:00
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2020-07-14 00:21:00 +02:00
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2021-05-16 00:06:01 +02:00
< section id = "module-evennia.web.website.forms" >
2020-07-14 00:21:00 +02:00
< span id = "evennia-web-website-forms" > < / span > < h1 > evennia.web.website.forms< a class = "headerlink" href = "#module-evennia.web.website.forms" title = "Permalink to this headline" > ¶< / a > < / h1 >
2020-10-15 01:31:30 +02:00
< dl class = "py class" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.EvenniaForm" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > evennia.web.website.forms.< / code > < code class = "sig-name descname" > EvenniaForm< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > data=None< / em > , < em class = "sig-param" > files=None< / em > , < em class = "sig-param" > auto_id='id_%s'< / em > , < em class = "sig-param" > prefix=None< / em > , < em class = "sig-param" > initial=None< / em > , < em class = "sig-param" > error_class=< class 'django.forms.utils.ErrorList'> < / em > , < em class = "sig-param" > label_suffix=None< / em > , < em class = "sig-param" > empty_permitted=False< / em > , < em class = "sig-param" > field_order=None< / em > , < em class = "sig-param" > use_required_attribute=None< / em > , < em class = "sig-param" > renderer=None< / em > < span class = "sig-paren" > )< / span > < a class = "reference internal" href = "../_modules/evennia/web/website/forms.html#EvenniaForm" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.web.website.forms.EvenniaForm" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > django.forms.forms.Form< / span > < / code > < / p >
< p > This is a stock Django form, but modified so that all values provided
through it are escaped (sanitized). Validation is performed by the fields
you define in the form.< / p >
< p > This has little to do with Evennia itself and is more general web security-
related.< / p >
< p > < a class = "reference external" href = "https://www.owasp.org/index.php/Input_Validation_Cheat_Sheet#Goals_of_Input_Validation" > https://www.owasp.org/index.php/Input_Validation_Cheat_Sheet#Goals_of_Input_Validation< / a > < / p >
2020-10-15 01:31:30 +02:00
< dl class = "py method" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.EvenniaForm.clean" >
< code class = "sig-name descname" > clean< / code > < span class = "sig-paren" > (< / span > < span class = "sig-paren" > )< / span > < a class = "reference internal" href = "../_modules/evennia/web/website/forms.html#EvenniaForm.clean" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.web.website.forms.EvenniaForm.clean" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Django hook. Performed on form submission.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Returns< / dt >
< dd class = "field-odd" > < p > < em > cleaned (dict)< / em > – < / p >
< / dd >
< / dl >
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.EvenniaForm.base_fields" >
< code class = "sig-name descname" > base_fields< / code > < em class = "property" > = {}< / em > < a class = "headerlink" href = "#evennia.web.website.forms.EvenniaForm.base_fields" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.EvenniaForm.declared_fields" >
< code class = "sig-name descname" > declared_fields< / code > < em class = "property" > = {}< / em > < a class = "headerlink" href = "#evennia.web.website.forms.EvenniaForm.declared_fields" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py method" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.EvenniaForm.media" >
< em class = "property" > property < / em > < code class = "sig-name descname" > media< / code > < a class = "headerlink" href = "#evennia.web.website.forms.EvenniaForm.media" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-10-15 01:31:30 +02:00
< dd > < p > Return all media required to render the widgets on this form.< / p >
< / dd > < / dl >
2020-07-14 00:21:00 +02:00
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py class" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.AccountForm" >
2020-10-15 01:31:30 +02:00
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > evennia.web.website.forms.< / code > < code class = "sig-name descname" > AccountForm< / 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/forms.html#AccountForm" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.web.website.forms.AccountForm" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-07-14 00:21:00 +02:00
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > django.contrib.auth.forms.UserCreationForm< / span > < / code > < / p >
< p > This is a generic Django form tailored to the Account model.< / p >
< p > In this incarnation it does not allow getting/setting of attributes, only
core User model fields (username, email, password).< / p >
2020-10-15 01:31:30 +02:00
< dl class = "py class" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.AccountForm.Meta" >
< em class = "property" > class < / em > < code class = "sig-name descname" > Meta< / code > < a class = "reference internal" href = "../_modules/evennia/web/website/forms.html#AccountForm.Meta" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.web.website.forms.AccountForm.Meta" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > object< / span > < / code > < / p >
< p > This is a Django construct that provides additional configuration to
the form.< / p >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.AccountForm.Meta.model" >
< code class = "sig-name descname" > model< / code > < a class = "headerlink" href = "#evennia.web.website.forms.AccountForm.Meta.model" title = "Permalink to this definition" > ¶< / a > < / dt >
2021-02-27 20:21:31 +01:00
< dd > < p > alias of < a class = "reference internal" href = "evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount" title = "evennia.accounts.accounts.DefaultAccount" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > evennia.accounts.accounts.DefaultAccount< / span > < / code > < / a > < / p >
2020-07-14 00:21:00 +02:00
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.AccountForm.Meta.fields" >
< code class = "sig-name descname" > fields< / code > < em class = "property" > = ('username', 'email')< / em > < a class = "headerlink" href = "#evennia.web.website.forms.AccountForm.Meta.fields" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.AccountForm.Meta.field_classes" >
< code class = "sig-name descname" > field_classes< / code > < em class = "property" > = {'username': < class 'django.contrib.auth.forms.UsernameField'> }< / em > < a class = "headerlink" href = "#evennia.web.website.forms.AccountForm.Meta.field_classes" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.AccountForm.base_fields" >
< code class = "sig-name descname" > base_fields< / code > < em class = "property" > = {'email': < django.forms.fields.EmailField object> , 'password1': < django.forms.fields.CharField object> , 'password2': < django.forms.fields.CharField object> , 'username': < django.contrib.auth.forms.UsernameField object> }< / em > < a class = "headerlink" href = "#evennia.web.website.forms.AccountForm.base_fields" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.AccountForm.declared_fields" >
< code class = "sig-name descname" > declared_fields< / code > < em class = "property" > = {'email': < django.forms.fields.EmailField object> , 'password1': < django.forms.fields.CharField object> , 'password2': < django.forms.fields.CharField object> }< / em > < a class = "headerlink" href = "#evennia.web.website.forms.AccountForm.declared_fields" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py method" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.AccountForm.media" >
< em class = "property" > property < / em > < code class = "sig-name descname" > media< / code > < a class = "headerlink" href = "#evennia.web.website.forms.AccountForm.media" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-10-15 01:31:30 +02:00
< dd > < p > Return all media required to render the widgets on this form.< / p >
< / dd > < / dl >
2020-07-14 00:21:00 +02:00
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py class" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.ObjectForm" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > evennia.web.website.forms.< / code > < code class = "sig-name descname" > ObjectForm< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > data=None< / em > , < em class = "sig-param" > files=None< / em > , < em class = "sig-param" > auto_id='id_%s'< / em > , < em class = "sig-param" > prefix=None< / em > , < em class = "sig-param" > initial=None< / em > , < em class = "sig-param" > error_class=< class 'django.forms.utils.ErrorList'> < / em > , < em class = "sig-param" > label_suffix=None< / em > , < em class = "sig-param" > empty_permitted=False< / em > , < em class = "sig-param" > instance=None< / em > , < em class = "sig-param" > use_required_attribute=None< / em > , < em class = "sig-param" > renderer=None< / em > < span class = "sig-paren" > )< / span > < a class = "reference internal" href = "../_modules/evennia/web/website/forms.html#ObjectForm" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.web.website.forms.ObjectForm" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Bases: < a class = "reference internal" href = "#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 > , < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > django.forms.models.ModelForm< / span > < / code > < / p >
< p > This is a Django form for generic Evennia Objects that allows modification
of attributes when called from a descendent of ObjectUpdate or ObjectCreate
views.< / p >
< p > It defines no fields by default; you have to do that by extending this class
and defining what fields you want to be recorded. See the CharacterForm for
a simple example of how to do this.< / p >
2020-10-15 01:31:30 +02:00
< dl class = "py class" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.ObjectForm.Meta" >
< em class = "property" > class < / em > < code class = "sig-name descname" > Meta< / code > < a class = "reference internal" href = "../_modules/evennia/web/website/forms.html#ObjectForm.Meta" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.web.website.forms.ObjectForm.Meta" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > object< / span > < / code > < / p >
< p > This is a Django construct that provides additional configuration to
the form.< / p >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.ObjectForm.Meta.model" >
< code class = "sig-name descname" > model< / code > < a class = "headerlink" href = "#evennia.web.website.forms.ObjectForm.Meta.model" title = "Permalink to this definition" > ¶< / a > < / dt >
2021-02-27 20:21:31 +01:00
< dd > < p > alias of < a class = "reference internal" href = "evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title = "evennia.objects.objects.DefaultObject" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > evennia.objects.objects.DefaultObject< / span > < / code > < / a > < / p >
2020-07-14 00:21:00 +02:00
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.ObjectForm.Meta.fields" >
< code class = "sig-name descname" > fields< / code > < em class = "property" > = ('db_key',)< / em > < a class = "headerlink" href = "#evennia.web.website.forms.ObjectForm.Meta.fields" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.ObjectForm.Meta.labels" >
< code class = "sig-name descname" > labels< / code > < em class = "property" > = {'db_key': 'Name'}< / em > < a class = "headerlink" href = "#evennia.web.website.forms.ObjectForm.Meta.labels" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.ObjectForm.base_fields" >
< code class = "sig-name descname" > base_fields< / code > < em class = "property" > = {'db_key': < django.forms.fields.CharField object> }< / em > < a class = "headerlink" href = "#evennia.web.website.forms.ObjectForm.base_fields" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.ObjectForm.declared_fields" >
< code class = "sig-name descname" > declared_fields< / code > < em class = "property" > = {}< / em > < a class = "headerlink" href = "#evennia.web.website.forms.ObjectForm.declared_fields" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py method" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.ObjectForm.media" >
< em class = "property" > property < / em > < code class = "sig-name descname" > media< / code > < a class = "headerlink" href = "#evennia.web.website.forms.ObjectForm.media" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-10-15 01:31:30 +02:00
< dd > < p > Return all media required to render the widgets on this form.< / p >
< / dd > < / dl >
2020-07-14 00:21:00 +02:00
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py class" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.CharacterForm" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > evennia.web.website.forms.< / code > < code class = "sig-name descname" > CharacterForm< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > data=None< / em > , < em class = "sig-param" > files=None< / em > , < em class = "sig-param" > auto_id='id_%s'< / em > , < em class = "sig-param" > prefix=None< / em > , < em class = "sig-param" > initial=None< / em > , < em class = "sig-param" > error_class=< class 'django.forms.utils.ErrorList'> < / em > , < em class = "sig-param" > label_suffix=None< / em > , < em class = "sig-param" > empty_permitted=False< / em > , < em class = "sig-param" > instance=None< / em > , < em class = "sig-param" > use_required_attribute=None< / em > , < em class = "sig-param" > renderer=None< / em > < span class = "sig-paren" > )< / span > < a class = "reference internal" href = "../_modules/evennia/web/website/forms.html#CharacterForm" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.web.website.forms.CharacterForm" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Bases: < a class = "reference internal" href = "#evennia.web.website.forms.ObjectForm" title = "evennia.web.website.forms.ObjectForm" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > evennia.web.website.forms.ObjectForm< / span > < / code > < / a > < / p >
< p > This is a Django form for Evennia Character objects.< / p >
< p > Since Evennia characters only have one attribute by default, this form only
defines a field for that single attribute. The names of fields you define should
correspond to their names as stored in the dbhandler; you can display
‘ ’ ‘ ’ < / p >
< p > The basic field types are CharFields and IntegerFields, which let you enter
text and numbers respectively. IntegerFields have some neat validation tricks
they can do, like mandating values fall within a certain range.< / p >
< p > For example, a complete “age” field (which stores its value to
< strong > character.db.age< / strong > might look like:< / p >
< dl class = "simple" >
< dt > age = forms.IntegerField(< / dt > < dd > < p > label=”Your Age”,
min_value=18, max_value=9000,
help_text=”Years since your birth.”)< / p >
< / dd >
< / dl >
< p > Default input fields are generic single-line text boxes. You can control what
sort of input field users will see by specifying a “widget.” An example of
this is used for the ‘ ’ < / p >
< p > For help in building out your form, please see:
< a class = "reference external" href = "https://docs.djangoproject.com/en/1.11/topics/forms/#building-a-form-in-django" > https://docs.djangoproject.com/en/1.11/topics/forms/#building-a-form-in-django< / a > < / p >
< p > For more information on fields and their capabilities, see:
< a class = "reference external" href = "https://docs.djangoproject.com/en/1.11/ref/forms/fields/" > https://docs.djangoproject.com/en/1.11/ref/forms/fields/< / a > < / p >
< p > For more on widgets, see:
< a class = "reference external" href = "https://docs.djangoproject.com/en/1.11/ref/forms/widgets/" > https://docs.djangoproject.com/en/1.11/ref/forms/widgets/< / a > < / p >
2020-10-15 01:31:30 +02:00
< dl class = "py class" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.CharacterForm.Meta" >
< em class = "property" > class < / em > < code class = "sig-name descname" > Meta< / code > < a class = "reference internal" href = "../_modules/evennia/web/website/forms.html#CharacterForm.Meta" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.web.website.forms.CharacterForm.Meta" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Bases: < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > object< / span > < / code > < / p >
< p > This is a Django construct that provides additional configuration to
the form.< / p >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.CharacterForm.Meta.model" >
< code class = "sig-name descname" > model< / code > < a class = "headerlink" href = "#evennia.web.website.forms.CharacterForm.Meta.model" title = "Permalink to this definition" > ¶< / a > < / dt >
2021-02-27 20:21:31 +01:00
< 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 >
2020-07-14 00:21:00 +02:00
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.CharacterForm.Meta.fields" >
< code class = "sig-name descname" > fields< / code > < em class = "property" > = ('db_key',)< / em > < a class = "headerlink" href = "#evennia.web.website.forms.CharacterForm.Meta.fields" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.CharacterForm.Meta.labels" >
< code class = "sig-name descname" > labels< / code > < em class = "property" > = {'db_key': 'Name'}< / em > < a class = "headerlink" href = "#evennia.web.website.forms.CharacterForm.Meta.labels" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.CharacterForm.base_fields" >
< code class = "sig-name descname" > base_fields< / code > < em class = "property" > = {'db_key': < django.forms.fields.CharField object> , 'desc': < django.forms.fields.CharField object> }< / em > < a class = "headerlink" href = "#evennia.web.website.forms.CharacterForm.base_fields" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.CharacterForm.declared_fields" >
< code class = "sig-name descname" > declared_fields< / code > < em class = "property" > = {'desc': < django.forms.fields.CharField object> }< / em > < a class = "headerlink" href = "#evennia.web.website.forms.CharacterForm.declared_fields" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py method" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.CharacterForm.media" >
< em class = "property" > property < / em > < code class = "sig-name descname" > media< / code > < a class = "headerlink" href = "#evennia.web.website.forms.CharacterForm.media" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-10-15 01:31:30 +02:00
< dd > < p > Return all media required to render the widgets on this form.< / p >
< / dd > < / dl >
2020-07-14 00:21:00 +02:00
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py class" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.CharacterUpdateForm" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > evennia.web.website.forms.< / code > < code class = "sig-name descname" > CharacterUpdateForm< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > data=None< / em > , < em class = "sig-param" > files=None< / em > , < em class = "sig-param" > auto_id='id_%s'< / em > , < em class = "sig-param" > prefix=None< / em > , < em class = "sig-param" > initial=None< / em > , < em class = "sig-param" > error_class=< class 'django.forms.utils.ErrorList'> < / em > , < em class = "sig-param" > label_suffix=None< / em > , < em class = "sig-param" > empty_permitted=False< / em > , < em class = "sig-param" > instance=None< / em > , < em class = "sig-param" > use_required_attribute=None< / em > , < em class = "sig-param" > renderer=None< / em > < span class = "sig-paren" > )< / span > < a class = "reference internal" href = "../_modules/evennia/web/website/forms.html#CharacterUpdateForm" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.web.website.forms.CharacterUpdateForm" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Bases: < a class = "reference internal" href = "#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 >
< p > This is a Django form for updating Evennia Character objects.< / p >
< p > By default it is the same as the CharacterForm, but if there are circumstances
in which you don’
access to during creation, you can redefine this form with those fields you do
wish to allow.< / p >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.CharacterUpdateForm.base_fields" >
< code class = "sig-name descname" > base_fields< / code > < em class = "property" > = {'db_key': < django.forms.fields.CharField object> , 'desc': < django.forms.fields.CharField object> }< / em > < a class = "headerlink" href = "#evennia.web.website.forms.CharacterUpdateForm.base_fields" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.CharacterUpdateForm.declared_fields" >
< code class = "sig-name descname" > declared_fields< / code > < em class = "property" > = {'desc': < django.forms.fields.CharField object> }< / em > < a class = "headerlink" href = "#evennia.web.website.forms.CharacterUpdateForm.declared_fields" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py method" >
2020-07-14 00:21:00 +02:00
< dt id = "evennia.web.website.forms.CharacterUpdateForm.media" >
< em class = "property" > property < / em > < code class = "sig-name descname" > media< / code > < a class = "headerlink" href = "#evennia.web.website.forms.CharacterUpdateForm.media" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-10-15 01:31:30 +02:00
< dd > < p > Return all media required to render the widgets on this form.< / p >
< / dd > < / dl >
2020-07-14 00:21:00 +02:00
< / dd > < / dl >
2021-05-16 00:06:01 +02:00
< / section >
2020-07-14 00:21:00 +02:00
2020-10-15 01:31:30 +02:00
< div class = "clearer" > < / div >
2020-07-14 00:21:00 +02:00
< / div >
< / div >
< / div >
< 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 >
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
2021-10-26 21:41:11 +02:00
< li > < a href = "../_sources/api/evennia.web.website.forms.md.txt"
2020-07-14 00:21:00 +02:00
rel="nofollow">Show Page Source< / a > < / li >
< / ul >
2021-03-06 01:37:43 +01:00
< / div > < h3 > Links< / h3 >
< ul >
< li > < a href = "https://www.evennia.com" > Home page< / a > < / li >
< li > < a href = "https://github.com/evennia/evennia" > Evennia Github< / a > < / li >
< li > < a href = "http://games.evennia.com" > Game Index< / a > < / li >
2021-08-06 00:47:51 +02:00
< li >
< a href = "https://discord.gg/AJJpcRUhtF" > Discord< / a > -
< a href = "https://github.com/evennia/evennia/discussions" > Discussions< / a > -
2021-08-06 00:53:44 +02:00
< a href = "https://evennia.blogspot.com/" > Blog< / a >
2021-03-06 01:37:43 +01:00
< / li >
< / ul >
2020-07-14 00:21:00 +02:00
< h3 > Versions< / h3 >
< ul >
< li > < a href = "evennia.web.website.forms.html" > 1.0-dev (develop branch)< / a > < / li >
< / ul >
< / div >
< / div >
< div class = "clearer" > < / 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 >
2020-10-15 01:31:30 +02:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 1.0-dev< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > evennia.web.website.forms< / a > < / li >
2020-07-14 00:21:00 +02:00
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2020-07-14 00:21:00 +02:00
< / div >
< div class = "footer" role = "contentinfo" >
© Copyright 2020, The Evennia developer community.
2020-10-15 01:31:30 +02:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.2.1.
2020-07-14 00:21:00 +02:00
< / div >
< / body >
< / html >
