Skip to content

Commit f531cee

Browse files
FoereaperFoereaper
authored
Merge pull request #24 from ElunaLuaEngine/master-2024-03-14_23-34
Update Eluna documentation
2 parents 9154d30 + db87d9e commit f531cee

5 files changed

Lines changed: 156 additions & 1 deletion

File tree

‎Creature/RemoveFromWorld.html‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
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:RemoveFromWorld 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:RemoveFromWorld - 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:RemoveFromWorld");
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/RemoveFromWorld.html">RemoveFromWorld</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>Removes <a class="mod" href="../Creature/index.html">Creature</a> from the world</p>
71+
<p>The object is no longer reachable after this and it is not respawned.</p>
72+
73+
<h2 id="synopsis" class='section-header'>
74+
<a href="#synopsis">Synopsis</a>
75+
</h2>
76+
<p>
77+
<code>Creature:RemoveFromWorld( deleteFromDB )</code>
78+
</p>
79+
80+
<h2 id="arguments" class='section-header'>
81+
<a href="#arguments">Arguments</a>
82+
</h2>
83+
<p>
84+
<dl>
85+
<dt><code><strong><a href="http://www.lua.org/pil/2.2.html">boolean</a></strong> deleteFromDB</code></dt>
86+
<dd class="docblock"><p>If true, it will delete the <a class="mod" href="../Creature/index.html">Creature</a> from the database. </p></dd>
87+
</dl>
88+
</p>
89+
90+
<h2 id="returns" class='section-header'>
91+
<a href="#returns">Returns</a>
92+
</h2>
93+
<p>
94+
Nothing.
95+
</p>
96+
</div>
97+
98+
</section>
99+
100+
<section id='search' class="content hidden"></section>
101+
102+
<section class="footer"></section>
103+
104+
<div id="help" class="hidden">
105+
<div class="shortcuts">
106+
<h1>Keyboard shortcuts</h1>
107+
<dl>
108+
<dt>?</dt>
109+
<dd>Show this help dialog</dd>
110+
<dt>S</dt>
111+
<dd>Focus the search field</dd>
112+
<dt>&larrb;</dt>
113+
<dd>Move up in search results</dd>
114+
<dt>&rarrb;</dt>
115+
<dd>Move down in search results</dd>
116+
<dt>&#9166;</dt>
117+
<dd>Go to active search result</dd>
118+
</dl>
119+
</div>
120+
<div class="infos">
121+
<h1>Search tricks</h1>
122+
<p>
123+
Prefix searches with a type followed by a colon (e.g.
124+
<code>fn:</code>) to restrict the search to a given type.
125+
</p>
126+
<p>
127+
Accepted types are: <code>fn</code>, <code>mod</code>,
128+
<code>struct</code> (or <code>str</code>), <code>enum</code>,
129+
<code>trait</code>, <code>typedef</code> (or
130+
<code>tdef</code>).
131+
</p>
132+
</div>
133+
</div>
134+
135+
<script>
136+
window.rootPath = "../";
137+
</script>
138+
<script src="../static/jquery.js"></script>
139+
<script src="../static/main.js"></script>
140+
<script async src="../search-index.js"></script>
141+
<center>Generated on <script src="../date.js"></script></center>
142+
<center>&copy; 2010 - 2024 Eluna Lua Engine</center>
143+
</body>
144+
</html>

‎Creature/index.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -669,6 +669,15 @@ <h2 id='methods' class='section-header'><a href="#methods">Methods</a></h2>
669669
<p>Remove this <a class="mod" href="../Creature/index.html">Creature</a>'s corpse.</p>
670670
</td>
671671
</tr>
672+
<tr>
673+
<td>
674+
<a class='stability Stable' title='Documented'></a>
675+
<a class='fn' href='RemoveFromWorld.html'>RemoveFromWorld</a>
676+
</td>
677+
<td class='docblock short'>
678+
<p>Removes <a class="mod" href="../Creature/index.html">Creature</a> from the world</p>
679+
</td>
680+
</tr>
672681
<tr>
673682
<td>
674683
<a class='stability Stable' title='Documented'></a>

‎Creature/sidebar.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ document.write(`
6464
<a id="Creature:IsWorldBoss" class="fn" href="../Creature/IsWorldBoss.html">IsWorldBoss</a>
6565
<a id="Creature:MoveWaypoint" class="fn" href="../Creature/MoveWaypoint.html">MoveWaypoint</a>
6666
<a id="Creature:RemoveCorpse" class="fn" href="../Creature/RemoveCorpse.html">RemoveCorpse</a>
67+
<a id="Creature:RemoveFromWorld" class="fn" href="../Creature/RemoveFromWorld.html">RemoveFromWorld</a>
6768
<a id="Creature:RemoveLootMode" class="fn" href="../Creature/RemoveLootMode.html">RemoveLootMode</a>
6869
<a id="Creature:ResetAllThreat" class="fn" href="../Creature/ResetAllThreat.html">ResetAllThreat</a>
6970
<a id="Creature:ResetLootMode" class="fn" href="../Creature/ResetLootMode.html">ResetLootMode</a>

‎date.js‎

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