Skip to content

Commit 6fa6a91

Browse files
FoereaperFoereaper
authored
Merge pull request #38 from ElunaLuaEngine/master-2024-11-03_20-00
Update Eluna documentation
2 parents a3ac2a1 + 64a1ba1 commit 6fa6a91

File tree

5 files changed

+177
-1
lines changed

5 files changed

+177
-1
lines changed

‎Player/RunCommand.html‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<meta name="description" content="API documentation for the Player:RunCommand method in the Eluna engine.">
7+
<meta name="keywords" content="eluna, lua, lua engine, trinitycore, trinity, mangos, cmangos, script, scripting, doc, docs, documentation">
8+
9+
<title>Player:RunCommand - Eluna</title>
10+
11+
<link rel="stylesheet" type="text/css" href="../static/main.css">
12+
<link rel="stylesheet" href="../static/highlight.css">
13+
14+
<link rel="shortcut icon" href="../static/favicon.ico">
15+
16+
<script>
17+
// Inline script to set theme before the rest of the document loads
18+
(function() {
19+
const currentTheme = localStorage.getItem('theme');
20+
if (currentTheme) {
21+
document.documentElement.classList.add(currentTheme);
22+
}
23+
})();
24+
</script>
25+
<script src="../static/highlight.min.js"></script>
26+
<script src="../static/lua.min.js"></script>
27+
</head>
28+
<body class="rustdoc">
29+
<section class="sidebar">
30+
<a href='../index.html'><img src='../static/eluna-logo.png' alt='Eluna Logo' width='100'></a>
31+
<div class="block">
32+
33+
<h2>Player Methods</h2>
34+
<script src="sidebar.js"></script>
35+
<script>
36+
// Highlight current method by adding "current" class to it
37+
var element = document.getElementById("Player:RunCommand");
38+
if (element) {
39+
var classname = "current";
40+
arr = element.className.split(" ");
41+
if (arr.indexOf(classname) == -1) {
42+
element.className += " " + classname;
43+
}
44+
}
45+
</script>
46+
47+
</div>
48+
</section>
49+
50+
<nav class="sub">
51+
<form class="search-form js-only">
52+
<input class="search-input" name="search"
53+
autocomplete="off"
54+
placeholder="Click or press 'S' to search..."
55+
type="search">
56+
57+
<div class="toggle-container" id="themeToggle">
58+
<svg class="sun-icon" xmlns="http://www.w3.org/2000/svg">
59+
<circle cx="12" cy="12" r="5"></circle>
60+
<line x1="12" y1="1" x2="12" y2="3"></line>
61+
<line x1="12" y1="21" x2="12" y2="23"></line>
62+
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
63+
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
64+
<line x1="1" y1="12" x2="3" y2="12"></line>
65+
<line x1="21" y1="12" x2="23" y2="12"></line>
66+
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
67+
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
68+
</svg>
69+
<svg class="moon-icon" xmlns="http://www.w3.org/2000/svg">
70+
<path d="M21 12.79A9 9 0 1 1 11.21 3 7 7 0 0 0 21 12.79z"></path>
71+
</svg>
72+
</div>
73+
</form>
74+
</nav>
75+
76+
<section id='main' class="content mod">
77+
<h1 class='fqn'>
78+
Method
79+
<a class="mod" href="../Player/index.html">Player</a>:<a class="fn" href="../Player/RunCommand.html">RunCommand</a>
80+
<span class='out-of-band'>
81+
<span id='render-detail'>
82+
<a id="collapse-all" href="#">[-]</a>
83+
<a id="expand-all" href="#">[+]</a>
84+
</span>
85+
</span>
86+
</h1>
87+
88+
89+
<div class='docblock'>
90+
<p>Runs a command as the <a class="mod" href="../Player/index.html">Player</a>.</p>
91+
92+
93+
<h2 id="synopsis" class='section-header'>
94+
<a href="#synopsis">Synopsis</a>
95+
</h2>
96+
<p>
97+
<code>Player:RunCommand( command )</code>
98+
</p>
99+
100+
<h2 id="arguments" class='section-header'>
101+
<a href="#arguments">Arguments</a>
102+
</h2>
103+
<p>
104+
<dl>
105+
<dt><code><strong><a href="http://www.lua.org/pil/2.4.html">string</a></strong> command</code></dt>
106+
<dd class="docblock"><p>The command to run. </p></dd>
107+
</dl>
108+
</p>
109+
110+
<h2 id="returns" class='section-header'>
111+
<a href="#returns">Returns</a>
112+
</h2>
113+
<p>
114+
Nothing.
115+
</p>
116+
</div>
117+
118+
</section>
119+
120+
<section id='search' class="content hidden"></section>
121+
122+
<section class="footer"></section>
123+
124+
<div id="help" class="hidden">
125+
<div class="shortcuts">
126+
<h1>Keyboard shortcuts</h1>
127+
<dl>
128+
<dt>?</dt>
129+
<dd>Show this help dialog</dd>
130+
<dt>S</dt>
131+
<dd>Focus the search field</dd>
132+
<dt>&larrb;</dt>
133+
<dd>Move up in search results</dd>
134+
<dt>&rarrb;</dt>
135+
<dd>Move down in search results</dd>
136+
<dt>&#9166;</dt>
137+
<dd>Go to active search result</dd>
138+
</dl>
139+
</div>
140+
<div class="infos">
141+
<h1>Search tricks</h1>
142+
<p>
143+
Prefix searches with a type followed by a colon (e.g.
144+
<code>fn:</code>) to restrict the search to a given type.
145+
</p>
146+
<p>
147+
Accepted types are: <code>fn</code>, <code>mod</code>,
148+
<code>struct</code> (or <code>str</code>), <code>enum</code>,
149+
<code>trait</code>, <code>typedef</code> (or
150+
<code>tdef</code>).
151+
</p>
152+
</div>
153+
</div>
154+
155+
<script>
156+
window.rootPath = "../";
157+
</script>
158+
<script src="../static/jquery.js"></script>
159+
<script src="../static/main.js"></script>
160+
<script src="../static/theme.js"></script>
161+
<script async src="../search-index.js"></script>
162+
<center>Generated on <script src="../date.js"></script></center>
163+
<center>&copy; 2010 - 2024 Eluna Lua Engine</center>
164+
</body>
165+
</html>

‎Player/index.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1822,6 +1822,15 @@ <h2 id='methods' class='section-header'><a href="#methods">Methods</a></h2>
18221822
<p>Rewards the given quest entry for the <a class="mod" href="../Player/index.html">Player</a> if he has completed it.</p>
18231823
</td>
18241824
</tr>
1825+
<tr>
1826+
<td>
1827+
<a class='stability Stable' title='Documented'></a>
1828+
<a class='fn' href='RunCommand.html'>RunCommand</a>
1829+
</td>
1830+
<td class='docblock short'>
1831+
<p>Runs a command as the <a class="mod" href="../Player/index.html">Player</a>.</p>
1832+
</td>
1833+
</tr>
18251834
<tr>
18261835
<td>
18271836
<a class='stability Stable' title='Documented'></a>

‎Player/sidebar.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ document.write(`
193193
<a id="Player:ResetTypeCooldowns" class="fn" href="../Player/ResetTypeCooldowns.html">ResetTypeCooldowns</a>
194194
<a id="Player:ResurrectPlayer" class="fn" href="../Player/ResurrectPlayer.html">ResurrectPlayer</a>
195195
<a id="Player:RewardQuest" class="fn" href="../Player/RewardQuest.html">RewardQuest</a>
196+
<a id="Player:RunCommand" class="fn" href="../Player/RunCommand.html">RunCommand</a>
196197
<a id="Player:SaveToDB" class="fn" href="../Player/SaveToDB.html">SaveToDB</a>
197198
<a id="Player:Say" class="fn" href="../Player/Say.html">Say</a>
198199
<a id="Player:SendAddonMessage" class="fn" href="../Player/SendAddonMessage.html">SendAddonMessage</a>

‎date.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
document.write("03/10/2024");
1+
document.write("03/11/2024");

‎search-index.js‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)