Skip to content

Commit 1158511

Browse files
FoereaperFoereaper
authored
Merge pull request #27 from ElunaLuaEngine/master-2024-05-02_01-20
Update Eluna documentation
2 parents 65691c3 + d79e0d3 commit 1158511

5 files changed

Lines changed: 155 additions & 1 deletion

File tree

‎Creature/GetRank.html‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
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 Creature:GetRank 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>Creature:GetRank - Eluna</title>
10+
11+
<link rel="stylesheet" type="text/css" href="../static/main.css">
12+
13+
<link rel="shortcut icon" href="../static/favicon.ico">
14+
15+
</head>
16+
<body class="rustdoc">
17+
<!--[if lte IE 8]>
18+
<div class="warning">
19+
This old browser is unsupported and will most likely display funky
20+
things.
21+
</div>
22+
<![endif]-->
23+
24+
<section class="sidebar">
25+
<a href='../index.html'><img src='../static/eluna-logo.png' alt='Eluna Logo' width='100'></a>
26+
<div class="block">
27+
28+
<h2>Creature Methods</h2>
29+
<script src="sidebar.js"></script>
30+
<script>
31+
// Highlight current method by adding "current" class to it
32+
var element = document.getElementById("Creature:GetRank");
33+
if (element) {
34+
var classname = "current";
35+
arr = element.className.split(" ");
36+
if (arr.indexOf(classname) == -1) {
37+
element.className += " " + classname;
38+
}
39+
}
40+
</script>
41+
42+
</div>
43+
</section>
44+
45+
<nav class="sub">
46+
<form class="search-form js-only">
47+
<div class="search-container">
48+
<input class="search-input" name="search"
49+
autocomplete="off"
50+
placeholder="Click or press 'S' to search, '?' for more options..."
51+
type="search">
52+
</div>
53+
</form>
54+
</nav>
55+
56+
<section id='main' class="content mod">
57+
<h1 class='fqn'>
58+
Method
59+
<a class="mod" href="../Creature/index.html">Creature</a>:<a class="fn" href="../Creature/GetRank.html">GetRank</a>
60+
<span class='out-of-band'>
61+
<span id='render-detail'>
62+
<a id="collapse-all" href="#">[-]</a>
63+
<a id="expand-all" href="#">[+]</a>
64+
</span>
65+
</span>
66+
</h1>
67+
68+
69+
<div class='docblock'>
70+
<p>Returns the <a class="mod" href="../Creature/index.html">Creature</a>'s rank as defined in the creature template.</p>
71+
72+
<h2 id="synopsis" class='section-header'>
73+
<a href="#synopsis">Synopsis</a>
74+
</h2>
75+
<p>
76+
<code>rank = Creature:GetRank()</code>
77+
</p>
78+
79+
<h2 id="arguments" class='section-header'>
80+
<a href="#arguments">Arguments</a>
81+
</h2>
82+
<p>
83+
None.
84+
</p>
85+
86+
<h2 id="returns" class='section-header'>
87+
<a href="#returns">Returns</a>
88+
</h2>
89+
<p>
90+
<dl>
91+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> rank</code></dt>
92+
<dd class="docblock"><p><em>Valid numbers</em>: integers from 0 to 4,294,967,295.</p></dd>
93+
</dl>
94+
</p>
95+
</div>
96+
97+
</section>
98+
99+
<section id='search' class="content hidden"></section>
100+
101+
<section class="footer"></section>
102+
103+
<div id="help" class="hidden">
104+
<div class="shortcuts">
105+
<h1>Keyboard shortcuts</h1>
106+
<dl>
107+
<dt>?</dt>
108+
<dd>Show this help dialog</dd>
109+
<dt>S</dt>
110+
<dd>Focus the search field</dd>
111+
<dt>&larrb;</dt>
112+
<dd>Move up in search results</dd>
113+
<dt>&rarrb;</dt>
114+
<dd>Move down in search results</dd>
115+
<dt>&#9166;</dt>
116+
<dd>Go to active search result</dd>
117+
</dl>
118+
</div>
119+
<div class="infos">
120+
<h1>Search tricks</h1>
121+
<p>
122+
Prefix searches with a type followed by a colon (e.g.
123+
<code>fn:</code>) to restrict the search to a given type.
124+
</p>
125+
<p>
126+
Accepted types are: <code>fn</code>, <code>mod</code>,
127+
<code>struct</code> (or <code>str</code>), <code>enum</code>,
128+
<code>trait</code>, <code>typedef</code> (or
129+
<code>tdef</code>).
130+
</p>
131+
</div>
132+
</div>
133+
134+
<script>
135+
window.rootPath = "../";
136+
</script>
137+
<script src="../static/jquery.js"></script>
138+
<script src="../static/main.js"></script>
139+
<script async src="../search-index.js"></script>
140+
<center>Generated on <script src="../date.js"></script></center>
141+
<center>&copy; 2010 - 2024 Eluna Lua Engine</center>
142+
</body>
143+
</html>

‎Creature/index.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -389,6 +389,15 @@ <h2 id='methods' class='section-header'><a href="#methods">Methods</a></h2>
389389
<p>Returns the <a class="mod" href="../Creature/index.html">Creature</a>'s NPC flags.</p>
390390
</td>
391391
</tr>
392+
<tr>
393+
<td>
394+
<a class='stability Stable' title='Documented'></a>
395+
<a class='fn' href='GetRank.html'>GetRank</a>
396+
</td>
397+
<td class='docblock short'>
398+
<p>Returns the <a class="mod" href="../Creature/index.html">Creature</a>'s rank as defined in the creature template.</p>
399+
</td>
400+
</tr>
392401
<tr>
393402
<td>
394403
<a class='stability Stable' title='Documented'></a>

‎Creature/sidebar.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ document.write(`
3535
<a id="Creature:GetLootRecipient" class="fn" href="../Creature/GetLootRecipient.html">GetLootRecipient</a>
3636
<a id="Creature:GetLootRecipientGroup" class="fn" href="../Creature/GetLootRecipientGroup.html">GetLootRecipientGroup</a>
3737
<a id="Creature:GetNPCFlags" class="fn" href="../Creature/GetNPCFlags.html">GetNPCFlags</a>
38+
<a id="Creature:GetRank" class="fn" href="../Creature/GetRank.html">GetRank</a>
3839
<a id="Creature:GetRespawnDelay" class="fn" href="../Creature/GetRespawnDelay.html">GetRespawnDelay</a>
3940
<a id="Creature:GetScriptId" class="fn" href="../Creature/GetScriptId.html">GetScriptId</a>
4041
<a id="Creature:GetScriptName" class="fn" href="../Creature/GetScriptName.html">GetScriptName</a>

‎date.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
document.write("04/04/2024");
1+
document.write("02/05/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)