<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html> <head> <title>Reference</title> <link rel="stylesheet" href="../luadoc.css" type="text/css" /> <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/--> </head> <body> <div id="container"> <div id="product"> <div id="product_logo"></div> <div id="product_name"><big><b></b></big></div> <div id="product_description"></div> </div> <!-- id="product" --> <div id="main"> <div id="navigation"> <h1>LuaDoc</h1> <ul> <li><a href="../index.html">Index</a></li> </ul> <!-- Module list --> <!-- File list --> <h1>Files</h1> <ul> <li> <a href="../files/ChatManager.html">ChatManager.lua</a> </li> <li><strong>Command.lua</strong></li> <li> <a href="../files/CommandManager.html">CommandManager.lua</a> </li> <li> <a href="../files/EventHandler.html">EventHandler.lua</a> </li> <li> <a href="../files/Events.html">Events.lua</a> </li> <li> <a href="../files/Events_Chat.html">Events_Chat.lua</a> </li> <li> <a href="../files/GroupTools.html">GroupTools.lua</a> </li> <li> <a href="../files/Logger.html">Logger.lua</a> </li> <li> <a href="../files/PlayerManager.html">PlayerManager.lua</a> </li> <li> <a href="../files/QueueManager.html">QueueManager.lua</a> </li> <li> <a href="../files/String.html">String.lua</a> </li> <li> <a href="../files/Table.html">Table.lua</a> </li> </ul> </div> <!-- id="navigation" --> <div id="content"> <h1>File <code>Command.lua</code></h1> <h2>Functions</h2> <table class="function_list"> <tr> <td class="name" nowrap><a href="#C:Disable">C:Disable</a> ()</td> <td class="summary">Disable AddOn.</td> </tr> <tr> <td class="name" nowrap><a href="#C:DisableDebug">C:DisableDebug</a> ()</td> <td class="summary">Disable debugging.</td> </tr> <tr> <td class="name" nowrap><a href="#C:Enable">C:Enable</a> ()</td> <td class="summary">Enable AddOn.</td> </tr> <tr> <td class="name" nowrap><a href="#C:EnableDebug">C:EnableDebug</a> ()</td> <td class="summary">Enable debugging.</td> </tr> <tr> <td class="name" nowrap><a href="#C:Init">C:Init</a> ()</td> <td class="summary">Initialize Command.</td> </tr> <tr> <td class="name" nowrap><a href="#C:LoadSavedVars">C:LoadSavedVars</a> ()</td> <td class="summary">Load the saved variables.</td> </tr> <tr> <td class="name" nowrap><a href="#C:SetDebug">C:SetDebug</a> (enabled)</td> <td class="summary">Control debugging state.</td> </tr> <tr> <td class="name" nowrap><a href="#C:SetEnabled">C:SetEnabled</a> (enabled)</td> <td class="summary">Control AddOn state.</td> </tr> <tr> <td class="name" nowrap><a href="#C:Toggle">C:Toggle</a> ()</td> <td class="summary">Toggle AddOn on and off.</td> </tr> <tr> <td class="name" nowrap><a href="#C:ToggleDebug">C:ToggleDebug</a> ()</td> <td class="summary">Toggle debugging.</td> </tr> </table> <h2>Tables</h2> <table class="table_list"> <tr> <td class="name" nowrap><a href="#Command">Command</a></td> <td class="summary">Table containing all Command methods.</td> </tr> </table> <br/> <br/> <h2><a name="functions"></a>Functions</h2> <dl class="function"> <dt><a name="C:Disable"></a><strong>C:Disable</strong> ()</dt> <dd> Disable AddOn. </dd> <dt><a name="C:DisableDebug"></a><strong>C:DisableDebug</strong> ()</dt> <dd> Disable debugging. </dd> <dt><a name="C:Enable"></a><strong>C:Enable</strong> ()</dt> <dd> Enable AddOn. </dd> <dt><a name="C:EnableDebug"></a><strong>C:EnableDebug</strong> ()</dt> <dd> Enable debugging. </dd> <dt><a name="C:Init"></a><strong>C:Init</strong> ()</dt> <dd> Initialize Command. </dd> <dt><a name="C:LoadSavedVars"></a><strong>C:LoadSavedVars</strong> ()</dt> <dd> Load the saved variables. Also call Init() on modules that need it. </dd> <dt><a name="C:SetDebug"></a><strong>C:SetDebug</strong> (enabled)</dt> <dd> Control debugging state. <h3>Parameters:</h3> <ul> <li> <code><em>enabled</em></code>: Boolean indicating enabled or disabled state. </li> </ul> </dd> <dt><a name="C:SetEnabled"></a><strong>C:SetEnabled</strong> (enabled)</dt> <dd> Control AddOn state. <h3>Parameters:</h3> <ul> <li> <code><em>enabled</em></code>: Boolean indicating enabled or disabled state. </li> </ul> </dd> <dt><a name="C:Toggle"></a><strong>C:Toggle</strong> ()</dt> <dd> Toggle AddOn on and off. </dd> <dt><a name="C:ToggleDebug"></a><strong>C:ToggleDebug</strong> ()</dt> <dd> Toggle debugging. </dd> </dl> <h2><a name="tables"></a>Tables</h2> <dl class="table"> <dt><a name="Command"></a><strong>Command</strong></dt> <dd>Table containing all Command methods. This is referenced "C" in Command.lua<br /><br /> <h3>Fields:</h3> <ul> <li> <code><em>Name</em></code>: AddOn name. </li> <li> <code><em>Version</em></code>: AddOn version. </li> <li> <code><em>VarVersion</em></code>: SavedVariables version. </li> <li> <code><em>Enabled</em></code>: Enabled state. </li> <li> <code><em>Global</em></code>: Contains the saved variables. </li> <li> <code><em>Settings</em></code>: Contains settings specific to Command. </li> <li> <code><em>Events</em></code>: Contains all registered event handlers. </li> </ul> </dd> </dl> </div> <!-- id="content" --> </div> <!-- id="main" --> <div id="about"> <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p> </div> <!-- id="about" --> </div> <!-- id="container" --> </body> </html>