API 摘要（英文）

這個 fork 的 API 參考仍然是從 Evennia 原始碼 docstrings 自動生成，目前維持英文。

evennia - 函式庫原始碼樹

• evennia.accounts - 代表玩家的 out-of-character 實體

• evennia.commands - 處理所有輸入，也包含預設 commands

• evennia.comms - 遊戲內頻道與訊息系統

• evennia.contrib - 由社群提供、偏向遊戲用途的工具與程式碼

• evennia.help - 遊戲內 help 系統

• evennia.locks - 控制各種系統與資源存取權限的機制

• evennia.objects - 所有遊戲內實體，例如 Rooms、Characters、Exits 等

• evennia.prototypes - 用 dict 來客製化實體

• evennia.scripts - 所有 out-of-character 遊戲物件

• evennia.server - 核心的 Server 與 Portal 程式，也包含網路 protocols

• evennia.typeclasses - 核心的資料庫與 Python 橋接層

• evennia.utils - 大量實用的開發工具與 utilities

• evennia.web - webclient、網站與其他 web 資源

常用捷徑

Evennia 的「flat API」提供了許多常用工具的捷徑，只要匯入 evennia 就能取得。 flat API 定義在 __init__.py，可由此查看。

主要設定

• evennia.settings_default - 所有設定（在 mygame/server/settings.py 中修改或 override）

搜尋函式

• evennia.search_account

• evennia.search_object

• evennia.search_tag

• evennia.search_script

• evennia.search_channel

• evennia.search_message

• evennia.search_help

建立函式

• evennia.create_account

• evennia.create_object

• evennia.create_script

• evennia.create_channel

• evennia.create_help_entry

• evennia.create_message

Typeclasses

• evennia.DefaultAccount - 玩家帳號 class（docs）

• evennia.DefaultGuest - guest 帳號的基礎 class

• evennia.DefaultObject - 所有物件的基礎 class（docs）

• evennia.DefaultCharacter - 遊戲內角色的基礎 class（docs）

• evennia.DefaultRoom - 房間的基礎 class（docs）

• evennia.DefaultExit - 出口的基礎 class（docs）

• evennia.DefaultScript - OOC 物件的基礎 class（docs）

• evennia.DefaultChannel - 遊戲內頻道的基礎 class（docs）

Commands

• evennia.Command - 基礎 Command class。另請參考 evennia.default_cmds.MuxCommand

• evennia.CmdSet - 基礎 CmdSet class

• evennia.default_cmds - 可將所有預設 command class 當成屬性存取

• evennia.syscmdkeys - 可將 system command keys 當成屬性存取

Utilities

• evennia.utils.utils - 各種雜項但實用的工具

• evennia.gametime - 伺服器運作時間與遊戲時間（docs）

• evennia.logger - 記錄工具

• evennia.ansi - ANSI 著色工具

• evennia.spawn - spawn/prototype 系統（docs）

• evennia.lockfuncs - 預設的 lock functions，用於存取控制（docs）

• evennia.EvMenu - 選單系統（docs）

• evennia.EvTable - 文字表格產生器

• evennia.EvForm - 文字表單產生器

• Evennia.EvMore - 文字分頁器

• evennia.EvEditor - 遊戲內逐行文字編輯器（docs）

• evennia.utils.funcparser.Funcparser - inline 函式 parsing（docs）

全域 singleton handlers

• evennia.TICKER_HANDLER - 讓物件可以訂閱 ticker（docs）

• evennia.MONITOR_HANDLER - 監看變更（docs）

• evennia.SESSION_HANDLER - 管理所有 sessions 的主要 session handler

資料庫核心 models（供較進階查詢使用）

• evennia.ObjectDB

• evennia.accountDB

• evennia.ScriptDB

• evennia.ChannelDB

• evennia.Msg

• evennia.managers - 包含所有 database managers 的捷徑

Contributions

• evennia.contrib - 遊戲導向的 contributions 與 plugins