diff --git a/docs/files/CommandManager.html b/docs/files/CommandManager.html index 52e4515..2c9a322 100644 --- a/docs/files/CommandManager.html +++ b/docs/files/CommandManager.html @@ -107,6 +107,11 @@ <table class="function_list"> <tr> + <td class="name" nowrap><a href="#CM:AutoHelp">CM:AutoHelp</a> ()</td> + <td class="summary">Prints all command names together with their help messages.</td> + </tr> + + <tr> <td class="name" nowrap><a href="#CM:GetCommand">CM:GetCommand</a> (command)</td> <td class="summary">Gets the callback for a command by name.</td> </tr> @@ -127,7 +132,7 @@ </tr> <tr> - <td class="name" nowrap><a href="#CM:Register">CM:Register</a> (command, access, func)</td> + <td class="name" nowrap><a href="#CM:Register">CM:Register</a> (names, access, func, help, command)</td> <td class="summary">Register a new command.</td> </tr> @@ -159,6 +164,23 @@ +<dt><a name="CM:AutoHelp"></a><strong>CM:AutoHelp</strong> ()</dt> +<dd> +Prints all command names together with their help messages. + + + + + + + + + +</dd> + + + + <dt><a name="CM:GetCommand"></a><strong>CM:GetCommand</strong> (command)</dt> <dd> Gets the callback for a command by name. @@ -179,7 +201,7 @@ Gets the callback for a command by name. <h3>Return value:</h3> -<ul>Callback for the command. </ul> +<ul>Callback for the command, nil if no command was found. </ul> @@ -278,7 +300,7 @@ Initialize CommandManager. NOTE: Unused. -<dt><a name="CM:Register"></a><strong>CM:Register</strong> (command, access, func)</dt> +<dt><a name="CM:Register"></a><strong>CM:Register</strong> (names, access, func, help, command)</dt> <dd> Register a new command. @@ -287,7 +309,7 @@ Register a new command. <ul> <li> - <code><em>command</em></code>: Table containing aliases for the command. + <code><em>names</em></code>: </li> <li> @@ -295,7 +317,15 @@ Register a new command. </li> <li> - <code><em>func</em></code>: Function called to execute command. Called with params args, player and isChat. + <code><em>func</em></code>: Function called to execute command. Called with params args, player and isChat. + </li> + + <li> + <code><em>help</em></code>: Message describing how the command should be used. + </li> + + <li> + <code><em>command</em></code>: Table containing aliases for the command. </li> </ul> diff --git a/docs/files/PlayerManager.html b/docs/files/PlayerManager.html index 10f0e1f..0da16da 100644 --- a/docs/files/PlayerManager.html +++ b/docs/files/PlayerManager.html @@ -818,7 +818,7 @@ Set the state of an item on the list. </li> <li> - <code><em>list</em></code>: True to list it, false to not list it. + <code><em>list</em></code>: True to list it, false to not list it. </li> </ul> @@ -828,6 +828,15 @@ Set the state of an item on the list. +<h3>Return values:</h3> +<ol> + + <li>String stating that the command was added or removed, false if error.</li> + + <li>Error message if unsuccessful, nil otherwise. </li> + +</ol> + </dd> @@ -854,8 +863,14 @@ Add a command to the blacklist/whitelist. -<h3>Return value:</h3> -<ul>String stating that the command was added. </ul> +<h3>Return values:</h3> +<ol> + + <li>String stating that the command was added, false if error.</li> + + <li>Error message if unsuccessful, nil otherwise. </li> + +</ol> @@ -883,8 +898,14 @@ Remove a command from the blacklist/whitelist. -<h3>Return value:</h3> -<ul>String stating that the command was removed. </ul> +<h3>Return values:</h3> +<ol> + + <li>String stating that the command was removed, false if error.</li> + + <li>Error message if unsuccessful, nil otherwise. </li> + +</ol> @@ -902,7 +923,7 @@ Dynamically add or remove an item from the list. <ul> <li> - <code><em>command</em></code>: Name of command to list. + <code><em>command</em></code>: Name of command to list. </li> </ul> @@ -912,6 +933,15 @@ Dynamically add or remove an item from the list. +<h3>Return values:</h3> +<ol> + + <li>String stating that the command was added or removed, false if error.</li> + + <li>Error message if unsuccessful, nil otherwise. </li> + +</ol> + </dd>