mirror of
https://github.com/evennia/evennia.git
synced 2026-03-26 09:46:32 +01:00
Updated HTML docs
This commit is contained in:
Griatch
parent
801df95026
commit
b77bb57004
690 changed files with 24165 additions and 10952 deletions
|
|
@ -31,6 +31,7 @@
|
|||
<li class="nav-item nav-item-2"><a href="../../evennia.html" accesskey="U">evennia</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.objects.objects</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
|
|
@ -45,6 +46,8 @@
|
|||
<span class="sd">These are the (default) starting points for all in-game visible</span>
|
||||
<span class="sd">entities.</span>
|
||||
|
||||
<span class="sd">This is the v1.0 develop version (for ref in doc building).</span>
|
||||
|
||||
<span class="sd">"""</span>
|
||||
<span class="kn">import</span> <span class="nn">time</span>
|
||||
<span class="kn">import</span> <span class="nn">inflect</span>
|
||||
|
|
@ -53,7 +56,7 @@
|
|||
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="kn">import</span> <span class="n">settings</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">evennia.typeclasses.models</span> <span class="kn">import</span> <span class="n">TypeclassBase</span>
|
||||
<span class="kn">from</span> <span class="nn">evennia.typeclasses.attributes</span> <span class="kn">import</span> <span class="n">NickHandler</span>
|
||||
<span class="kn">from</span> <span class="nn">evennia.typeclasses.attributes</span> <span class="kn">import</span> <span class="n">NickHandler</span><span class="p">,</span> <span class="n">ModelAttributeBackend</span>
|
||||
<span class="kn">from</span> <span class="nn">evennia.objects.manager</span> <span class="kn">import</span> <span class="n">ObjectManager</span>
|
||||
<span class="kn">from</span> <span class="nn">evennia.objects.models</span> <span class="kn">import</span> <span class="n">ObjectDB</span>
|
||||
<span class="kn">from</span> <span class="nn">evennia.scripts.scripthandler</span> <span class="kn">import</span> <span class="n">ScriptHandler</span>
|
||||
|
|
@ -247,6 +250,9 @@
|
|||
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="c1"># Used for sorting / filtering in inventories / room contents.</span>
|
||||
<span class="n">_content_types</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"object"</span><span class="p">,)</span>
|
||||
|
||||
<span class="c1"># lockstring of newly created objects, for easy overloading.</span>
|
||||
<span class="c1"># Will be formatted with the appropriate attributes.</span>
|
||||
<span class="n">lockstring</span> <span class="o">=</span> <span class="s2">"control:id(</span><span class="si">{account_id}</span><span class="s2">) or perm(Admin);delete:id(</span><span class="si">{account_id}</span><span class="s2">) or perm(Admin)"</span>
|
||||
|
|
@ -265,7 +271,7 @@
|
|||
|
||||
<div class="viewcode-block" id="DefaultObject.nicks"><a class="viewcode-back" href="../../../api/evennia.objects.objects.html#evennia.objects.objects.DefaultObject.nicks">[docs]</a> <span class="nd">@lazy_property</span>
|
||||
<span class="k">def</span> <span class="nf">nicks</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">NickHandler</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div>
|
||||
<span class="k">return</span> <span class="n">NickHandler</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ModelAttributeBackend</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="DefaultObject.sessions"><a class="viewcode-back" href="../../../api/evennia.objects.objects.html#evennia.objects.objects.DefaultObject.sessions">[docs]</a> <span class="nd">@lazy_property</span>
|
||||
<span class="k">def</span> <span class="nf">sessions</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
|
|
@ -300,7 +306,7 @@
|
|||
<span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_account</span><span class="o">.</span><span class="n">attributes</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"_quell"</span><span class="p">)</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<div class="viewcode-block" id="DefaultObject.contents_get"><a class="viewcode-back" href="../../../api/evennia.objects.objects.html#evennia.objects.objects.DefaultObject.contents_get">[docs]</a> <span class="k">def</span> <span class="nf">contents_get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exclude</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="DefaultObject.contents_get"><a class="viewcode-back" href="../../../api/evennia.objects.objects.html#evennia.objects.objects.DefaultObject.contents_get">[docs]</a> <span class="k">def</span> <span class="nf">contents_get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exclude</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">content_type</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||||
<span class="sd">"""</span>
|
||||
<span class="sd"> Returns the contents of this object, i.e. all</span>
|
||||
<span class="sd"> objects that has this object set as its location.</span>
|
||||
|
|
@ -309,17 +315,18 @@
|
|||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> exclude (Object): Object to exclude from returned</span>
|
||||
<span class="sd"> contents list</span>
|
||||
<span class="sd"> content_type (str): A content_type to filter by. None for no</span>
|
||||
<span class="sd"> filtering.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> contents (list): List of contents of this Object.</span>
|
||||
|
||||
<span class="sd"> Notes:</span>
|
||||
<span class="sd"> Also available as the `contents` property.</span>
|
||||
<span class="sd"> Also available as the `contents` property, minus exclusion</span>
|
||||
<span class="sd"> and filtering.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">con</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">contents_cache</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">exclude</span><span class="o">=</span><span class="n">exclude</span><span class="p">)</span>
|
||||
<span class="c1"># print "contents_get:", self, con, id(self), calledby() # DEBUG</span>
|
||||
<span class="k">return</span> <span class="n">con</span></div>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">contents_cache</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">exclude</span><span class="o">=</span><span class="n">exclude</span><span class="p">,</span> <span class="n">content_type</span><span class="o">=</span><span class="n">content_type</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="DefaultObject.contents_set"><a class="viewcode-back" href="../../../api/evennia.objects.objects.html#evennia.objects.objects.DefaultObject.contents_set">[docs]</a> <span class="k">def</span> <span class="nf">contents_set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
|
||||
<span class="s2">"You cannot replace this property"</span>
|
||||
|
|
@ -415,6 +422,7 @@
|
|||
<span class="n">nofound_string</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">multimatch_string</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">use_dbref</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">stacked</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="sd">"""</span>
|
||||
<span class="sd"> Returns an Object matching a search string/condition</span>
|
||||
|
|
@ -443,7 +451,9 @@
|
|||
<span class="sd"> to search. Note that this is used to query the *contents* of a</span>
|
||||
<span class="sd"> location and will not match for the location itself -</span>
|
||||
<span class="sd"> if you want that, don't set this or use `candidates` to specify</span>
|
||||
<span class="sd"> exactly which objects should be searched.</span>
|
||||
<span class="sd"> exactly which objects should be searched. If this nor candidates are</span>
|
||||
<span class="sd"> given, candidates will include caller's inventory, current location and</span>
|
||||
<span class="sd"> all objects in the current location.</span>
|
||||
<span class="sd"> attribute_name (str): Define which property to search. If set, no</span>
|
||||
<span class="sd"> key+alias search will be performed. This can be used</span>
|
||||
<span class="sd"> to search database fields (db_ will be automatically</span>
|
||||
|
|
@ -471,10 +481,19 @@
|
|||
<span class="sd"> will be treated like a normal string. If `None` (default), the ability to query by</span>
|
||||
<span class="sd"> #dbref is turned on if `self` has the permission 'Builder' and is turned off</span>
|
||||
<span class="sd"> otherwise.</span>
|
||||
<span class="sd"> stacked (int, optional): If > 0, multimatches will be analyzed to determine if they</span>
|
||||
<span class="sd"> only contains identical objects; these are then assumed 'stacked' and no multi-match</span>
|
||||
<span class="sd"> error will be generated, instead `stacked` number of matches will be returned. If</span>
|
||||
<span class="sd"> `stacked` is larger than number of matches, returns that number of matches. If</span>
|
||||
<span class="sd"> the found stack is a mix of objects, return None and handle the multi-match</span>
|
||||
<span class="sd"> error depending on the value of `quiet`.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> match (Object, None or list): will return an Object/None if `quiet=False`,</span>
|
||||
<span class="sd"> otherwise it will return a list of 0, 1 or more matches.</span>
|
||||
<span class="sd"> Object: If finding a match an `quiet=False`</span>
|
||||
<span class="sd"> None: If not finding a unique match and `quiet=False`.</span>
|
||||
<span class="sd"> list: With 0, 1 or more matching objects if `quiet=True`</span>
|
||||
<span class="sd"> list: With 2 or more matching objects if `stacked` is a positive integer and</span>
|
||||
<span class="sd"> the matched stack has only object-copies.</span>
|
||||
|
||||
<span class="sd"> Notes:</span>
|
||||
<span class="sd"> To find Accounts, use eg. `evennia.account_search`. If</span>
|
||||
|
|
@ -542,8 +561,29 @@
|
|||
<span class="n">use_dbref</span><span class="o">=</span><span class="n">use_dbref</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="n">nresults</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">results</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">stacked</span> <span class="o">></span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">nresults</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
|
||||
<span class="c1"># handle stacks, disable multimatch errors</span>
|
||||
<span class="n">nstack</span> <span class="o">=</span> <span class="n">nresults</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">exact</span><span class="p">:</span>
|
||||
<span class="c1"># we re-run exact match agains one of the matches to</span>
|
||||
<span class="c1"># make sure we were not catching partial matches not belonging</span>
|
||||
<span class="c1"># to the stack</span>
|
||||
<span class="n">nstack</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">ObjectDB</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get_objs_with_key_or_alias</span><span class="p">(</span>
|
||||
<span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">key</span><span class="p">,</span>
|
||||
<span class="n">exact</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
||||
<span class="n">candidates</span><span class="o">=</span><span class="nb">list</span><span class="p">(</span><span class="n">results</span><span class="p">),</span>
|
||||
<span class="n">typeclasses</span><span class="o">=</span><span class="p">[</span><span class="n">typeclass</span><span class="p">]</span> <span class="k">if</span> <span class="n">typeclass</span> <span class="k">else</span> <span class="kc">None</span>
|
||||
<span class="p">))</span>
|
||||
<span class="k">if</span> <span class="n">nstack</span> <span class="o">==</span> <span class="n">nresults</span><span class="p">:</span>
|
||||
<span class="c1"># a valid stack, return multiple results</span>
|
||||
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">results</span><span class="p">)[:</span><span class="n">stacked</span><span class="p">]</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">quiet</span><span class="p">:</span>
|
||||
<span class="c1"># don't auto-handle error messaging</span>
|
||||
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">results</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># handle error messages</span>
|
||||
<span class="k">return</span> <span class="n">_AT_SEARCH_RESULT</span><span class="p">(</span>
|
||||
<span class="n">results</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
|
|
@ -1700,20 +1740,26 @@
|
|||
<span class="sd"> **kwargs (dict): Arbitrary, optional arguments for users</span>
|
||||
<span class="sd"> overriding the call (unused by default).</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">filter_visible</span><span class="p">(</span><span class="n">obj_list</span><span class="p">):</span>
|
||||
<span class="c1"># Helper method to determine if objects are visible to the looker.</span>
|
||||
<span class="k">return</span> <span class="p">[</span><span class="n">obj</span> <span class="k">for</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">obj_list</span> <span class="k">if</span> <span class="n">obj</span> <span class="o">!=</span> <span class="n">looker</span> <span class="ow">and</span> <span class="n">obj</span><span class="o">.</span><span class="n">access</span><span class="p">(</span><span class="n">looker</span><span class="p">,</span> <span class="s2">"view"</span><span class="p">)]</span>
|
||||
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">looker</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="s2">""</span>
|
||||
|
||||
<span class="c1"># get and identify all objects</span>
|
||||
<span class="n">visible</span> <span class="o">=</span> <span class="p">(</span><span class="n">con</span> <span class="k">for</span> <span class="n">con</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">contents</span> <span class="k">if</span> <span class="n">con</span> <span class="o">!=</span> <span class="n">looker</span> <span class="ow">and</span> <span class="n">con</span><span class="o">.</span><span class="n">access</span><span class="p">(</span><span class="n">looker</span><span class="p">,</span> <span class="s2">"view"</span><span class="p">))</span>
|
||||
<span class="n">exits</span><span class="p">,</span> <span class="n">users</span><span class="p">,</span> <span class="n">things</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">[],</span> <span class="n">defaultdict</span><span class="p">(</span><span class="nb">list</span><span class="p">)</span>
|
||||
<span class="k">for</span> <span class="n">con</span> <span class="ow">in</span> <span class="n">visible</span><span class="p">:</span>
|
||||
<span class="n">key</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">get_display_name</span><span class="p">(</span><span class="n">looker</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">con</span><span class="o">.</span><span class="n">destination</span><span class="p">:</span>
|
||||
<span class="n">exits</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
|
||||
<span class="k">elif</span> <span class="n">con</span><span class="o">.</span><span class="n">has_account</span><span class="p">:</span>
|
||||
<span class="n">users</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"|c</span><span class="si">%s</span><span class="s2">|n"</span> <span class="o">%</span> <span class="n">key</span><span class="p">)</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="c1"># things can be pluralized</span>
|
||||
<span class="n">things</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">con</span><span class="p">)</span>
|
||||
<span class="n">exits_list</span> <span class="o">=</span> <span class="n">filter_visible</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">contents_get</span><span class="p">(</span><span class="n">content_type</span><span class="o">=</span><span class="s2">"exit"</span><span class="p">))</span>
|
||||
<span class="n">users_list</span> <span class="o">=</span> <span class="n">filter_visible</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">contents_get</span><span class="p">(</span><span class="n">content_type</span><span class="o">=</span><span class="s2">"character"</span><span class="p">))</span>
|
||||
<span class="n">things_list</span> <span class="o">=</span> <span class="n">filter_visible</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">contents_get</span><span class="p">(</span><span class="n">content_type</span><span class="o">=</span><span class="s2">"object"</span><span class="p">))</span>
|
||||
|
||||
<span class="n">things</span> <span class="o">=</span> <span class="n">defaultdict</span><span class="p">(</span><span class="nb">list</span><span class="p">)</span>
|
||||
|
||||
<span class="k">for</span> <span class="n">thing</span> <span class="ow">in</span> <span class="n">things_list</span><span class="p">:</span>
|
||||
<span class="n">things</span><span class="p">[</span><span class="n">thing</span><span class="o">.</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">thing</span><span class="p">)</span>
|
||||
<span class="n">users</span> <span class="o">=</span> <span class="p">[</span><span class="sa">f</span><span class="s2">"|c</span><span class="si">{</span><span class="n">user</span><span class="o">.</span><span class="n">key</span><span class="si">}</span><span class="s2">|n"</span> <span class="k">for</span> <span class="n">user</span> <span class="ow">in</span> <span class="n">users_list</span><span class="p">]</span>
|
||||
<span class="n">exits</span> <span class="o">=</span> <span class="p">[</span><span class="n">ex</span><span class="o">.</span><span class="n">key</span> <span class="k">for</span> <span class="n">ex</span> <span class="ow">in</span> <span class="n">exits_list</span><span class="p">]</span>
|
||||
|
||||
<span class="c1"># get description, build string</span>
|
||||
<span class="n">string</span> <span class="o">=</span> <span class="s2">"|c</span><span class="si">%s</span><span class="s2">|n</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_display_name</span><span class="p">(</span><span class="n">looker</span><span class="p">)</span>
|
||||
<span class="n">desc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">desc</span>
|
||||
|
|
@ -1984,9 +2030,7 @@
|
|||
<span class="c1"># whisper mode</span>
|
||||
<span class="n">msg_type</span> <span class="o">=</span> <span class="s2">"whisper"</span>
|
||||
<span class="n">msg_self</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="s1">'</span><span class="si">{self}</span><span class="s1"> whisper to </span><span class="si">{all_receivers}</span><span class="s1">, "|n</span><span class="si">{speech}</span><span class="s1">|n"'</span>
|
||||
<span class="k">if</span> <span class="n">msg_self</span> <span class="ow">is</span> <span class="kc">True</span>
|
||||
<span class="k">else</span> <span class="n">msg_self</span>
|
||||
<span class="s1">'</span><span class="si">{self}</span><span class="s1"> whisper to </span><span class="si">{all_receivers}</span><span class="s1">, "|n</span><span class="si">{speech}</span><span class="s1">|n"'</span> <span class="k">if</span> <span class="n">msg_self</span> <span class="ow">is</span> <span class="kc">True</span> <span class="k">else</span> <span class="n">msg_self</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">msg_receivers</span> <span class="o">=</span> <span class="n">msg_receivers</span> <span class="ow">or</span> <span class="s1">'</span><span class="si">{object}</span><span class="s1"> whispers: "|n</span><span class="si">{speech}</span><span class="s1">|n"'</span>
|
||||
<span class="n">msg_location</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
|
|
@ -2073,6 +2117,9 @@
|
|||
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="c1"># Tuple of types used for indexing inventory contents. Characters generally wouldn't be in</span>
|
||||
<span class="c1"># anyone's inventory, but this also governs displays in room contents.</span>
|
||||
<span class="n">_content_types</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"character"</span><span class="p">,)</span>
|
||||
<span class="c1"># lockstring of newly created rooms, for easy overloading.</span>
|
||||
<span class="c1"># Will be formatted with the appropriate attributes.</span>
|
||||
<span class="n">lockstring</span> <span class="o">=</span> <span class="p">(</span>
|
||||
|
|
@ -2112,6 +2159,13 @@
|
|||
<span class="c1"># If no typeclass supplied, use this class</span>
|
||||
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"typeclass"</span><span class="p">]</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"typeclass"</span><span class="p">,</span> <span class="bp">cls</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># Normalize to latin characters and validate, if necessary, the supplied key</span>
|
||||
<span class="n">key</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">normalize_name</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
|
||||
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="bp">cls</span><span class="o">.</span><span class="n">validate_name</span><span class="p">(</span><span class="n">key</span><span class="p">):</span>
|
||||
<span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"Invalid character name."</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">obj</span><span class="p">,</span> <span class="n">errors</span>
|
||||
|
||||
<span class="c1"># Set the supplied key as the name of the intended object</span>
|
||||
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"key"</span><span class="p">]</span> <span class="o">=</span> <span class="n">key</span>
|
||||
|
||||
|
|
@ -2161,6 +2215,38 @@
|
|||
|
||||
<span class="k">return</span> <span class="n">obj</span><span class="p">,</span> <span class="n">errors</span></div>
|
||||
|
||||
<div class="viewcode-block" id="DefaultCharacter.normalize_name"><a class="viewcode-back" href="../../../api/evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.normalize_name">[docs]</a> <span class="nd">@classmethod</span>
|
||||
<span class="k">def</span> <span class="nf">normalize_name</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<span class="sd">"""</span>
|
||||
<span class="sd"> Normalize the character name prior to creating. Note that this should be refactored</span>
|
||||
<span class="sd"> to support i18n for non-latin scripts, but as we (currently) have no bug reports requesting better</span>
|
||||
<span class="sd"> support of non-latin character sets, requiring character names to be latinified is an acceptable option.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> name (str) : The name of the character</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> latin_name (str) : A valid name.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">latinify</span>
|
||||
|
||||
<span class="n">latin_name</span> <span class="o">=</span> <span class="n">latinify</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">"X"</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">latin_name</span></div>
|
||||
|
||||
<div class="viewcode-block" id="DefaultCharacter.validate_name"><a class="viewcode-back" href="../../../api/evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.validate_name">[docs]</a> <span class="nd">@classmethod</span>
|
||||
<span class="k">def</span> <span class="nf">validate_name</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<span class="sd">""" Validate the character name prior to creating. Overload this function to add custom validators</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> name (str) : The name of the character</span>
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> valid (bool) : True if character creation should continue; False if it should fail</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="k">return</span> <span class="kc">True</span> <span class="c1"># Default validator does not perform any operations</span></div>
|
||||
|
||||
<div class="viewcode-block" id="DefaultCharacter.basetype_setup"><a class="viewcode-back" href="../../../api/evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.basetype_setup">[docs]</a> <span class="k">def</span> <span class="nf">basetype_setup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="sd">"""</span>
|
||||
<span class="sd"> Setup character-specific security.</span>
|
||||
|
|
@ -2289,6 +2375,10 @@
|
|||
<span class="sd"> location is always `None`.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="c1"># A tuple of strings used for indexing this object inside an inventory.</span>
|
||||
<span class="c1"># Generally, a room isn't expected to HAVE a location, but maybe in some games?</span>
|
||||
<span class="n">_content_types</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"room"</span><span class="p">,)</span>
|
||||
|
||||
<span class="c1"># lockstring of newly created rooms, for easy overloading.</span>
|
||||
<span class="c1"># Will be formatted with the {id} of the creating object.</span>
|
||||
<span class="n">lockstring</span> <span class="o">=</span> <span class="p">(</span>
|
||||
|
|
@ -2447,6 +2537,7 @@
|
|||
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="n">_content_types</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"exit"</span><span class="p">,)</span>
|
||||
<span class="n">exit_command</span> <span class="o">=</span> <span class="n">ExitCommand</span>
|
||||
<span class="n">priority</span> <span class="o">=</span> <span class="mi">101</span>
|
||||
|
||||
|
|
@ -2689,7 +2780,6 @@
|
|||
<li><a href="../../../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
|
|
@ -2708,6 +2798,7 @@
|
|||
<li class="nav-item nav-item-2"><a href="../../evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.objects.objects</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue