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/" / >
< title > Core Components — 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 >
< 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 = "Typeclasses" href = "Typeclasses.html" / >
< link rel = "prev" title = "Making a sittable object" href = "../Howtos/A-Sittable-Object.html" / >
< / head > < body >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
< a href = "../genindex.html" title = "General Index"
accesskey="I">index< / a > < / li >
< li class = "right" >
< a href = "../py-modindex.html" title = "Python Module Index"
>modules< / a > |< / li >
< li class = "right" >
< a href = "Typeclasses.html" title = "Typeclasses"
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "../Howtos/A-Sittable-Object.html" title = "Making a sittable object"
accesskey="P">previous< / a > |< / li >
< 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 = "" > Core Components< / a > < / li >
< / ul >
< div class = "develop" > develop branch< / div >
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "sphinxsidebar" role = "navigation" aria-label = "main navigation" >
< div class = "sphinxsidebarwrapper" >
< p class = "logo" > < a href = "../index.html" >
< img class = "logo" src = "../_static/evennia_logo.png" alt = "Logo" / >
< / a > < / p >
< div id = "searchbox" style = "display: none" role = "search" >
< h3 id = "searchlabel" > Quick search< / h3 >
< div class = "searchformwrapper" >
< form class = "search" action = "../search.html" method = "get" >
< input type = "text" name = "q" aria-labelledby = "searchlabel" / >
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / div >
< script > $ ( '#searchbox' ) . show ( 0 ) ; < / script >
< h3 > < a href = "../index.html" > Table of Contents< / a > < / h3 >
< ul >
< li > < a class = "reference internal" href = "#" > Core Components< / a > < ul >
2022-11-20 00:44:59 +00:00
< li > < a class = "reference internal" href = "#basic-entites" > Basic entites< / a > < / li >
2022-11-14 22:43:45 +01:00
< li > < a class = "reference internal" href = "#commands" > Commands< / a > < / li >
< li > < a class = "reference internal" href = "#utils-and-tools" > Utils and tools< / a > < / li >
< li > < a class = "reference internal" href = "#web-components" > Web components< / a > < / li >
< / ul >
< / li >
< / ul >
< h4 > Previous topic< / h4 >
< p class = "topless" > < a href = "../Howtos/A-Sittable-Object.html"
title="previous chapter">Making a sittable object< / a > < / p >
< h4 > Next topic< / h4 >
< p class = "topless" > < a href = "Typeclasses.html"
title="next chapter">Typeclasses< / a > < / p >
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
< li > < a href = "../_sources/Components/Components-Overview.md.txt"
rel="nofollow">Show Page Source< / a > < / li >
< / ul >
< / 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 >
< 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 > Versions< / h3 >
< ul >
< li > < a href = "Components-Overview.html" > 1.0-dev (develop branch)< / a > < / li >
2022-11-15 20:29:38 +00:00
< ul >
< li > < a href = "../0.9.5/index.html" > 0.9.5 (v0.9.5 branch)< / a > < / li >
2022-11-14 22:43:45 +01:00
< / ul >
< / div >
< / div >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< section class = "tex2jax_ignore mathjax_ignore" id = "core-components" >
< h1 > Core Components< a class = "headerlink" href = "#core-components" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > These are the ‘ building blocks’ out of which Evennia is built. This documentation is complementary to, and often goes deeper than, the doc-strings of each component in the < a class = "reference internal" href = "../Evennia-API.html" > < span class = "doc std std-doc" > API< / span > < / a > .< / p >
2022-11-20 00:44:59 +00:00
< section id = "basic-entites" >
< h2 > Basic entites< a class = "headerlink" href = "#basic-entites" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > These are base pieces used to make an Evennia game. Most are long-lived and are persisted in the database.< / p >
2022-11-14 22:43:45 +01:00
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "Typeclasses.html" > Typeclasses< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Typeclasses.html#difference-between-typeclasses-and-classes" > Difference between typeclasses and classes< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Typeclasses.html#creating-a-new-typeclass" > Creating a new typeclass< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Typeclasses.html#about-typeclass-properties" > About typeclass properties< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Typeclasses.html#overloading-hooks" > Overloading hooks< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Typeclasses.html#querying-for-typeclasses" > Querying for typeclasses< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Typeclasses.html#updating-existing-typeclass-instances" > Updating existing typeclass instances< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Typeclasses.html#swap-typeclass" > Swap typeclass< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Typeclasses.html#how-typeclasses-actually-work" > How typeclasses actually work< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Typeclasses.html#caveats" > Caveats< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Sessions.html" > Sessions< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Sessions.html#properties-on-sessions" > Properties on Sessions< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Sessions.html#multisession-mode" > Multisession mode< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Sessions.html#returning-data-to-the-session" > Returning data to the session< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Sessions.html#customizing-the-session-object" > Customizing the Session object< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Sessions.html#portal-and-server-sessions" > Portal and Server Sessions< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Sessions.html#sessionhandlers" > Sessionhandlers< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Accounts.html" > Accounts< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Accounts.html#how-to-create-your-own-account-types" > How to create your own Account types< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Accounts.html#properties-on-accounts" > Properties on Accounts< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Objects.html" > Objects< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Objects.html#how-to-create-your-own-object-types" > How to create your own object types< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Objects.html#adding-common-functionality" > Adding common functionality< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Objects.html#properties-and-functions-on-objects" > Properties and functions on Objects< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Objects.html#subclasses-of-object" > Subclasses of < code class = "docutils literal notranslate" > < span class = "pre" > Object< / span > < / code > < / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Scripts.html" > Scripts< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Scripts.html#in-game-command-examples" > In-game command examples< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Scripts.html#code-examples" > Code examples< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Scripts.html#defining-new-scripts" > Defining new Scripts< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Scripts.html#timed-scripts" > Timed Scripts< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Scripts.html#script-attached-to-another-object" > Script attached to another object< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Scripts.html#other-script-methods" > Other Script methods< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Scripts.html#the-global-scripts-container" > The GLOBAL_SCRIPTS container< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Scripts.html#hints-dealing-with-script-errors" > Hints: Dealing with Script Errors< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Channels.html" > Channels< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Channels.html#using-channels-in-game" > Using channels in-game< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Channels.html#allowing-characters-to-use-channels" > Allowing Characters to use Channels< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Channels.html#customizing-channel-output-and-behavior" > Customizing channel output and behavior< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Channels.html#channels-in-code" > Channels in code< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Channels.html#channel-logging" > Channel logging< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Msg.html" > Msg< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Msg.html#msg-in-code" > Msg in code< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Msg.html#tempmsg" > TempMsg< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Attributes.html" > Attributes< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Attributes.html#managing-attributes-in-code" > Managing Attributes in Code< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Attributes.html#managing-attributes-in-game" > Managing Attributes in-game< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Attributes.html#locking-and-checking-attributes" > Locking and checking Attributes< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Attributes.html#what-types-of-data-can-i-save-in-an-attribute" > What types of data can I save in an Attribute?< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Attributes.html#properties-of-attributes" > Properties of Attributes< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Attributes.html#in-memory-attributes-nattributes" > In-memory Attributes (NAttributes)< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Nicks.html" > Nicks< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Nicks.html#coding-with-nicks" > Coding with nicks< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Nicks.html#advanced-note" > Advanced note< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Tags.html" > Tags< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Tags.html#properties-of-tags-and-aliases-and-permissions" > Properties of Tags (and Aliases and Permissions)< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Tags.html#adding-removing-tags" > Adding/Removing Tags< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Tags.html#searching-for-objects-with-a-given-tag" > Searching for objects with a given tag< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Tags.html#using-aliases-and-permissions" > Using Aliases and Permissions< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Tags.html#assorted-notes" > Assorted notes< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Prototypes.html" > Spawner and Prototypes< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Prototypes.html#using-the-olc" > Using the OLC< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Prototypes.html#the-prototype" > The prototype< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Prototypes.html#storing-prototypes" > Storing prototypes< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Prototypes.html#using-spawn" > Using @ spawn< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Prototypes.html#using-evennia-prototypes-spawner" > Using evennia.prototypes.spawner()< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Help-System.html" > Help System< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Help-System.html#using-the-help-system-from-in-game" > Using the help system from in-game< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Help-System.html#sources-of-help-entries" > Sources of help entries< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Help-System.html#entry-priority" > Entry priority< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Help-System.html#locking-help-entries" > Locking help entries< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Help-System.html#customizing-the-look-of-the-help-system" > Customizing the look of the help system< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Help-System.html#technical-notes" > Technical notes< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Permissions.html" > Permissions< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Permissions.html#managing-permissions" > Managing Permissions< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Permissions.html#the-permission-hierarchy" > The permission hierarchy< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Permissions.html#checking-permissions" > Checking permissions< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Permissions.html#superusers" > Superusers< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Permissions.html#quelling" > Quelling< / a > < / li >
< / ul >
< / li >
2022-11-20 00:44:59 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "Portal-And-Server.html" > Portal And Server< / a > < / li >
2022-11-14 22:43:45 +01:00
< / ul >
< / div >
< / section >
< section id = "commands" >
< h2 > Commands< a class = "headerlink" href = "#commands" title = "Permalink to this headline" > ¶< / a > < / h2 >
2022-11-20 00:44:59 +00:00
< p > Evennia’ s Command system handle everything sent to the server by the user.< / p >
2022-11-14 22:43:45 +01:00
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "Command-System.html" > Command System< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Commands.html" > Commands< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Commands.html#defining-commands" > Defining Commands< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Commands.html#exiting-a-command" > Exiting a command< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Commands.html#pauses-in-commands" > Pauses in commands< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Commands.html#asking-for-user-input" > Asking for user input< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Commands.html#system-commands" > System commands< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Commands.html#dynamic-commands" > Dynamic Commands< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Commands.html#exits" > Exits< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Commands.html#command-instances-are-re-used" > Command instances are re-used< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Commands.html#dynamically-created-commands" > Dynamically created commands< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Commands.html#how-commands-actually-work" > How commands actually work< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Commands.html#assorted-notes" > Assorted notes< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Command-Sets.html" > Command Sets< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Command-Sets.html#defining-command-sets" > Defining Command Sets< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Command-Sets.html#command-sets-searched" > Command Sets Searched< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Command-Sets.html#adding-and-merging-command-sets" > Adding and Merging Command Sets< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Default-Commands.html" > Default Commands< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Connection-Screen.html" > Connection Screen< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Connection-Screen.html#commands-available-at-the-connection-screen" > Commands available at the Connection Screen< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Batch-Processors.html" > Batch Processors< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Batch-Processors.html#a-note-on-file-encodings" > A note on File Encodings< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Batch-Code-Processor.html" > Batch Code Processor< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Batch-Code-Processor.html#basic-usage" > Basic Usage< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Batch-Code-Processor.html#the-batch-file" > The batch file< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Batch-Code-Processor.html#debug-mode" > Debug mode< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Batch-Code-Processor.html#interactive-mode" > Interactive mode< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Batch-Code-Processor.html#limitations-and-caveats" > Limitations and Caveats< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Batch-Command-Processor.html" > Batch Command Processor< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Batch-Command-Processor.html#basic-usage" > Basic Usage< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Batch-Command-Processor.html#the-batch-file" > The batch file< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Batch-Command-Processor.html#interactive-mode" > Interactive mode< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Batch-Command-Processor.html#limitations-and-caveats" > Limitations and Caveats< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Batch-Command-Processor.html#assorted-notes" > Assorted notes< / a > < / li >
< / ul >
< / li >
2022-11-20 00:44:59 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "Inputfuncs.html" > Inputfuncs< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Inputfuncs.html#adding-your-own-inputfuncs" > Adding your own inputfuncs< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Inputfuncs.html#default-inputfuncs" > Default inputfuncs< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Inputfuncs.html#unmonitor" > unmonitor< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Outputfuncs.html" > Outputfuncs< / a > < / li >
2022-11-14 22:43:45 +01:00
< / ul >
< / div >
< / section >
< section id = "utils-and-tools" >
< h2 > Utils and tools< a class = "headerlink" href = "#utils-and-tools" title = "Permalink to this headline" > ¶< / a > < / h2 >
2022-11-20 00:44:59 +00:00
< p > Evennia provides a library of code resources to help the creation of a game.< / p >
2022-11-14 22:43:45 +01:00
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "Coding-Utils.html" > Coding Utils< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Coding-Utils.html#searching" > Searching< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Coding-Utils.html#create" > Create< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Coding-Utils.html#logging" > Logging< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Coding-Utils.html#time-utilities" > Time Utilities< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Coding-Utils.html#object-classes" > Object Classes< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Coding-Utils.html#text-utilities" > Text utilities< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Coding-Utils.html#display-utilities" > Display utilities< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "EvEditor.html" > EvEditor< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvEditor.html#launching-the-editor" > Launching the editor< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvEditor.html#example-of-usage" > Example of usage< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvEditor.html#persistent-editor" > Persistent editor< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvEditor.html#line-editor-usage" > Line editor usage< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvEditor.html#the-eveditor-to-edit-code" > The EvEditor to edit code< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "EvForm.html" > EvForm< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "EvMenu.html" > EvMenu< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvMenu.html#introduction" > Introduction< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvMenu.html#launching-the-menu" > Launching the menu< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvMenu.html#the-menu-nodes" > The Menu nodes< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvMenu.html#temporary-storage" > Temporary storage< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvMenu.html#customizing-menu-formatting" > Customizing Menu formatting< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvMenu.html#evmenu-templating-language" > EvMenu templating language< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvMenu.html#id1" > Examples:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvMenu.html#ask-for-simple-input" > Ask for simple input< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvMenu.html#the-list-node-decorator" > The < code class = "docutils literal notranslate" > < span class = "pre" > @ list_node< / span > < / code > decorator< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvMenu.html#assorted-notes" > Assorted notes< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "EvMore.html" > EvMore< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "EvMore.html#using-evmore" > Using EvMore< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "EvTable.html" > EvTable< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "FuncParser.html" > The Inline Function Parser< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "FuncParser.html#uses-in-default-evennia" > Uses in default Evennia< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "FuncParser.html#using-the-funcparser" > Using the FuncParser< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "FuncParser.html#defining-custom-callables" > Defining custom callables< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "FuncParser.html#default-callables" > Default callables< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "MonitorHandler.html" > MonitorHandler< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "MonitorHandler.html#using-the-monitorhandler" > Using the MonitorHandler< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "TickerHandler.html" > TickerHandler< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "TickerHandler.html#about-tickers" > About Tickers< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Locks.html" > Locks< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Locks.html#setting-and-checking-a-lock" > Setting and checking a lock< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Locks.html#defining-locks" > Defining locks< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Locks.html#checking-simple-strings" > Checking simple strings< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Locks.html#default-locks" > Default locks< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Locks.html#more-lock-definition-examples" > More Lock definition examples< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Locks.html#a-complete-example-of-setting-locks-on-an-object" > A complete example of setting locks on an object< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Locks.html#on-djangos-permission-system" > On Django’ s permission system< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Signals.html" > Signals< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Signals.html#attaching-a-handler-to-a-signal" > Attaching a handler to a signal< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Signals.html#available-signals" > Available signals< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< / section >
< section id = "web-components" >
< h2 > Web components< a class = "headerlink" href = "#web-components" title = "Permalink to this headline" > ¶< / a > < / h2 >
2022-11-20 00:44:59 +00:00
< p > Evennia is also its own webserver, with a website and in-browser webclient you can expand on.< / p >
2022-11-14 22:43:45 +01:00
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "Website.html" > Game website< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Website.html#modifying-the-default-website" > Modifying the default Website< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Website.html#examples-of-commom-web-changes" > Examples of commom web changes< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Website.html#adding-a-new-web-page" > Adding a new web page< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Website.html#user-forms" > User forms< / a > < / li >
< / ul >
< / li >
2022-11-20 00:44:59 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "Webclient.html" > Web Client< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Webclient.html#customizing-the-web-client" > Customizing the web client< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Webclient.html#evennia-web-client-api-from-evennia-js" > Evennia Web Client API (from evennia.js)< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Webclient.html#plugin-manager-api-from-webclient-gui-js" > Plugin Manager API (from webclient_gui.js)< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Webclient.html#plugin-callbacks-api" > Plugin callbacks API< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Webclient.html#writing-your-own-plugins" > Writing your own Plugins< / a > < / li >
2022-11-14 22:43:45 +01:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Web-Admin.html" > The Web Admin< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Web-Admin.html#usage" > Usage< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Web-Admin.html#grant-others-access-to-the-admin" > Grant others access to the admin< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Web-Admin.html#customizing-the-web-admin" > Customizing the web admin< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Webserver.html" > Webserver< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Webserver.html#basic-webserver-data-flow" > Basic Webserver data flow< / a > < / li >
< / ul >
< / li >
2022-11-20 00:44:59 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "Web-API.html" > Evennia REST API< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Web-API.html#usage" > Usage< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Web-API.html#customizing-the-api" > Customizing the API< / a > < / li >
2022-11-14 22:43:45 +01:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Bootstrap-Components-and-Utilities.html" > Bootstrap Components and Utilities< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Bootstrap-Components-and-Utilities.html#general-styling" > General Styling< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Bootstrap-Components-and-Utilities.html#components" > Components< / a > < / li >
< / ul >
< / li >
< / ul >
< / div >
< / section >
< / 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 = "Typeclasses.html" title = "Typeclasses"
>next< / a > |< / li >
< li class = "right" >
< a href = "../Howtos/A-Sittable-Object.html" title = "Making a sittable object"
>previous< / a > |< / li >
< 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 = "" > Core Components< / a > < / li >
< / ul >
< div class = "develop" > develop branch< / div >
< / div >
< div class = "footer" role = "contentinfo" >
2022-11-15 19:52:44 +00:00
© Copyright 2022, The Evennia developer community.
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 >