Update Eluna documentation

ElunaLuaEngine · Nov 3, 2024 · 64a1ba1 · 64a1ba1
1 parent a3ac2a1
commit 64a1ba1
Show file tree

Hide file tree

Showing 5 changed files with 177 additions and 1 deletion.
diff --git a/Player/RunCommand.html b/Player/RunCommand.html
@@ -0,0 +1,165 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="description" content="API documentation for the Player:RunCommand method in the Eluna engine.">
+    <meta name="keywords" content="eluna, lua, lua engine, trinitycore, trinity, mangos, cmangos, script, scripting, doc, docs, documentation">
+
+    <title>Player:RunCommand - Eluna</title>
+
+    <link rel="stylesheet" type="text/css" href="../static/main.css">
+    <link rel="stylesheet" href="../static/highlight.css">
+
+    <link rel="shortcut icon" href="../static/favicon.ico">
+
+    <script>
+    // Inline script to set theme before the rest of the document loads
+    (function() {
+        const currentTheme = localStorage.getItem('theme');
+        if (currentTheme) {
+            document.documentElement.classList.add(currentTheme);
+        }
+    })();
+    </script>
+    <script src="../static/highlight.min.js"></script>
+    <script src="../static/lua.min.js"></script>
+</head>
+<body class="rustdoc">
+<section class="sidebar">
+    <a href='../index.html'><img src='../static/eluna-logo.png' alt='Eluna Logo' width='100'></a>
+    <div class="block">
+
+    <h2>Player Methods</h2>
+    <script src="sidebar.js"></script>
+    <script>
+      // Highlight current method by adding "current" class to it
+      var element = document.getElementById("Player:RunCommand");
+      if (element) {
+        var classname = "current";
+        arr = element.className.split(" ");
+        if (arr.indexOf(classname) == -1) {
+          element.className += " " + classname;
+        }
+      }
+    </script>
+
+    </div>
+</section>
+
+<nav class="sub">
+    <form class="search-form js-only">
+        <input class="search-input" name="search"
+            autocomplete="off"
+            placeholder="Click or press 'S' to search..."
+            type="search">
+
+        <div class="toggle-container" id="themeToggle">
+            <svg class="sun-icon" xmlns="http://www.w3.org/2000/svg">
+                <circle cx="12" cy="12" r="5"></circle>
+                <line x1="12" y1="1" x2="12" y2="3"></line>
+                <line x1="12" y1="21" x2="12" y2="23"></line>
+                <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
+                <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
+                <line x1="1" y1="12" x2="3" y2="12"></line>
+                <line x1="21" y1="12" x2="23" y2="12"></line>
+                <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
+                <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
+            </svg>
+            <svg class="moon-icon" xmlns="http://www.w3.org/2000/svg">
+                <path d="M21 12.79A9 9 0 1 1 11.21 3 7 7 0 0 0 21 12.79z"></path>
+            </svg>
+        </div>
+    </form>
+</nav>
+
+<section id='main' class="content mod">
+    <h1 class='fqn'>
+        Method
+    <a class="mod" href="../Player/index.html">Player</a>:<a class="fn" href="../Player/RunCommand.html">RunCommand</a>
+        <span class='out-of-band'>
+            <span id='render-detail'>
+                <a id="collapse-all" href="#">[-]</a>
+                <a id="expand-all" href="#">[+]</a>
+            </span>
+        </span>
+    </h1>
+
+
+    <div class='docblock'>
+        <p>Runs a command as the <a class="mod" href="../Player/index.html">Player</a>.</p>
+
+
+        <h2 id="synopsis" class='section-header'>
+            <a href="#synopsis">Synopsis</a>
+        </h2>
+        <p>
+            <code>Player:RunCommand( command )</code>
+        </p>
+
+        <h2 id="arguments" class='section-header'>
+            <a href="#arguments">Arguments</a>
+        </h2>
+        <p>
+            <dl>
+                <dt><code><strong><a href="http://www.lua.org/pil/2.4.html">string</a></strong> command</code></dt>
+                <dd class="docblock"><p>The command to run. </p></dd>
+            </dl>
+        </p>
+
+        <h2 id="returns" class='section-header'>
+            <a href="#returns">Returns</a>
+        </h2>
+        <p>
+            Nothing.
+        </p>
+    </div>
+
+</section>
+
+<section id='search' class="content hidden"></section>
+
+<section class="footer"></section>
+
+<div id="help" class="hidden">
+    <div class="shortcuts">
+        <h1>Keyboard shortcuts</h1>
+        <dl>
+            <dt>?</dt>
+            <dd>Show this help dialog</dd>
+            <dt>S</dt>
+            <dd>Focus the search field</dd>
+            <dt>&larrb;</dt>
+            <dd>Move up in search results</dd>
+            <dt>&rarrb;</dt>
+            <dd>Move down in search results</dd>
+            <dt>&#9166;</dt>
+            <dd>Go to active search result</dd>
+        </dl>
+    </div>
+    <div class="infos">
+        <h1>Search tricks</h1>
+        <p>
+            Prefix searches with a type followed by a colon (e.g.
+            <code>fn:</code>) to restrict the search to a given type.
+        </p>
+        <p>
+            Accepted types are: <code>fn</code>, <code>mod</code>,
+            <code>struct</code> (or <code>str</code>), <code>enum</code>,
+            <code>trait</code>, <code>typedef</code> (or
+            <code>tdef</code>).
+        </p>
+    </div>
+</div>
+
+<script>
+    window.rootPath = "../";
+</script>
+<script src="../static/jquery.js"></script>
+<script src="../static/main.js"></script>
+<script src="../static/theme.js"></script>
+<script async src="../search-index.js"></script>
+<center>Generated on <script src="../date.js"></script></center>
+<center>&copy; 2010 - 2024 Eluna Lua Engine</center>
+</body>
+</html>
diff --git a/Player/index.html b/Player/index.html
@@ -1822,6 +1822,15 @@ <h2 id='methods' class='section-header'><a href="#methods">Methods</a></h2>
                 <p>Rewards the given quest entry for the <a class="mod" href="../Player/index.html">Player</a> if he has completed it.</p>
             </td>
         </tr>
+        <tr>
+            <td>
+                <a class='stability Stable' title='Documented'></a>
+                <a class='fn' href='RunCommand.html'>RunCommand</a>
+            </td>
+            <td class='docblock short'>
+                <p>Runs a command as the <a class="mod" href="../Player/index.html">Player</a>.</p>
+            </td>
+        </tr>
         <tr>
             <td>
                 <a class='stability Stable' title='Documented'></a>

diff --git a/Player/sidebar.js b/Player/sidebar.js
@@ -193,6 +193,7 @@ document.write(`
   <a id="Player:ResetTypeCooldowns" class="fn" href="../Player/ResetTypeCooldowns.html">ResetTypeCooldowns</a>
   <a id="Player:ResurrectPlayer" class="fn" href="../Player/ResurrectPlayer.html">ResurrectPlayer</a>
   <a id="Player:RewardQuest" class="fn" href="../Player/RewardQuest.html">RewardQuest</a>
+  <a id="Player:RunCommand" class="fn" href="../Player/RunCommand.html">RunCommand</a>
   <a id="Player:SaveToDB" class="fn" href="../Player/SaveToDB.html">SaveToDB</a>
   <a id="Player:Say" class="fn" href="../Player/Say.html">Say</a>
   <a id="Player:SendAddonMessage" class="fn" href="../Player/SendAddonMessage.html">SendAddonMessage</a>

diff --git a/date.js b/date.js
@@ -1 +1 @@
-document.write("03/10/2024");
+document.write("03/11/2024");
diff --git a/search-index.js b/search-index.js