-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update eluna documentation (#140)
- Loading branch information
1 parent
aa21f31
commit 74636da
Showing
7 changed files
with
358 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| <!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 Unit:GetSpeedRate method in the Eluna engine."> | ||
| <meta name="keywords" content="eluna, lua, lua engine, azerothcore, script, scripting, doc, docs, documentation"> | ||
|
|
||
| <title>Unit:GetSpeedRate - Eluna</title> | ||
|
|
||
| <link rel="stylesheet" type="text/css" href="../static/main.css"> | ||
| <link rel="stylesheet" type="text/css" href="../static/dark.css"> | ||
|
|
||
| <link rel="shortcut icon" href="../static/favicon.ico"> | ||
|
|
||
| </head> | ||
| <body class="rustdoc"> | ||
| <!--[if lte IE 8]> | ||
| <div class="warning"> | ||
| This old browser is unsupported and will most likely display funky | ||
| things. | ||
| </div> | ||
| <![endif]--> | ||
|
|
||
| <section class="sidebar"> | ||
| <a href='../index.html'><img src='../static/eluna-logo.png' alt='Eluna Logo' width='100'></a> | ||
| <div class="block"> | ||
|
|
||
| <h2>Unit Methods</h2> | ||
| <script src="sidebar.js"></script> | ||
| <script> | ||
| // Highlight current method by adding "current" class to it | ||
| var element = document.getElementById("Unit:GetSpeedRate"); | ||
| 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"> | ||
| <div class="search-container"> | ||
| <input class="search-input" name="search" | ||
| autocomplete="off" | ||
| placeholder="Click or press 'S' to search, '?' for more options..." | ||
| type="search"> | ||
| </div> | ||
| </form> | ||
| </nav> | ||
|
|
||
| <section id='main' class="content mod"> | ||
| <h1 class='fqn'> | ||
| Method | ||
| <a class="mod" href="../Unit/index.html">Unit</a>:<a class="fn" href="../Unit/GetSpeedRate.html">GetSpeedRate</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>Returns the <a class="mod" href="../Unit/index.html">Unit</a>'s speed rate of given [UnitMoveType].</p> | ||
| <pre> | ||
| enum UnitMoveType | ||
| { | ||
| MOVE_WALK = 0, | ||
| MOVE_RUN = 1, | ||
| MOVE_RUN_BACK = 2, | ||
| MOVE_SWIM = 3, | ||
| MOVE_SWIM_BACK = 4, | ||
| MOVE_TURN_RATE = 5, | ||
| MOVE_FLIGHT = 6, | ||
| MOVE_FLIGHT_BACK = 7, | ||
| MOVE_PITCH_RATE = 8 | ||
| }; | ||
| </pre> | ||
|
|
||
| <h2 id="synopsis" class='section-header'> | ||
| <a href="#synopsis">Synopsis</a> | ||
| </h2> | ||
| <p> | ||
| <code>speed = Unit:GetSpeedRate( type )</code> | ||
| </p> | ||
|
|
||
| <h2 id="arguments" class='section-header'> | ||
| <a href="#arguments">Arguments</a> | ||
| </h2> | ||
| <p> | ||
| <dl> | ||
| <dt><code><strong><a href="https://github.com/ElunaLuaEngine/ElunaTrinityWotlk/search?l=cpp&q=%22enum+UnitMoveType%22&type=Code&utf8=%E2%9C%93">UnitMoveType</a></strong> type</code></dt> | ||
| <dd class="docblock"><em>See method description.</em></dd> | ||
| </dl> | ||
| </p> | ||
|
|
||
| <h2 id="returns" class='section-header'> | ||
| <a href="#returns">Returns</a> | ||
| </h2> | ||
| <p> | ||
| <dl> | ||
| <dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> speed</code></dt> | ||
| <dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd> | ||
| </dl> | ||
| </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>⇤</dt> | ||
| <dd>Move up in search results</dd> | ||
| <dt>⇥</dt> | ||
| <dd>Move down in search results</dd> | ||
| <dt>⏎</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 async src="../search-index.js"></script> | ||
| <center>Generated on <script src="../date.js"></script></center> | ||
| <center>©2016 - Eluna Lua Engine</center> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| <!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 Unit:SetSpeedRate method in the Eluna engine."> | ||
| <meta name="keywords" content="eluna, lua, lua engine, azerothcore, script, scripting, doc, docs, documentation"> | ||
|
|
||
| <title>Unit:SetSpeedRate - Eluna</title> | ||
|
|
||
| <link rel="stylesheet" type="text/css" href="../static/main.css"> | ||
| <link rel="stylesheet" type="text/css" href="../static/dark.css"> | ||
|
|
||
| <link rel="shortcut icon" href="../static/favicon.ico"> | ||
|
|
||
| </head> | ||
| <body class="rustdoc"> | ||
| <!--[if lte IE 8]> | ||
| <div class="warning"> | ||
| This old browser is unsupported and will most likely display funky | ||
| things. | ||
| </div> | ||
| <![endif]--> | ||
|
|
||
| <section class="sidebar"> | ||
| <a href='../index.html'><img src='../static/eluna-logo.png' alt='Eluna Logo' width='100'></a> | ||
| <div class="block"> | ||
|
|
||
| <h2>Unit Methods</h2> | ||
| <script src="sidebar.js"></script> | ||
| <script> | ||
| // Highlight current method by adding "current" class to it | ||
| var element = document.getElementById("Unit:SetSpeedRate"); | ||
| 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"> | ||
| <div class="search-container"> | ||
| <input class="search-input" name="search" | ||
| autocomplete="off" | ||
| placeholder="Click or press 'S' to search, '?' for more options..." | ||
| type="search"> | ||
| </div> | ||
| </form> | ||
| </nav> | ||
|
|
||
| <section id='main' class="content mod"> | ||
| <h1 class='fqn'> | ||
| Method | ||
| <a class="mod" href="../Unit/index.html">Unit</a>:<a class="fn" href="../Unit/SetSpeedRate.html">SetSpeedRate</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>Sets the <a class="mod" href="../Unit/index.html">Unit</a>'s speed rate of given [UnitMoveType] to given rate. | ||
| If forced, packets sent to clients forcing the visual change.</p> | ||
| <pre> | ||
| enum UnitMoveType | ||
| { | ||
| MOVE_WALK = 0, | ||
| MOVE_RUN = 1, | ||
| MOVE_RUN_BACK = 2, | ||
| MOVE_SWIM = 3, | ||
| MOVE_SWIM_BACK = 4, | ||
| MOVE_TURN_RATE = 5, | ||
| MOVE_FLIGHT = 6, | ||
| MOVE_FLIGHT_BACK = 7, | ||
| MOVE_PITCH_RATE = 8 | ||
| }; | ||
| </pre> | ||
|
|
||
| <h2 id="synopsis" class='section-header'> | ||
| <a href="#synopsis">Synopsis</a> | ||
| </h2> | ||
| <p> | ||
| <code>Unit:SetSpeedRate( type, rate )</code> | ||
| </p> | ||
| <p> | ||
| <code>Unit:SetSpeedRate( type, rate, forced )</code> | ||
| </p> | ||
|
|
||
| <h2 id="arguments" class='section-header'> | ||
| <a href="#arguments">Arguments</a> | ||
| </h2> | ||
| <p> | ||
| <dl> | ||
| <dt><code><strong><a href="https://github.com/ElunaLuaEngine/ElunaTrinityWotlk/search?l=cpp&q=%22enum+UnitMoveType%22&type=Code&utf8=%E2%9C%93">UnitMoveType</a></strong> type</code></dt> | ||
| <dd class="docblock"><em>See method description.</em></dd> | ||
| </dl> | ||
| <dl> | ||
| <dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> rate</code></dt> | ||
| <dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd> | ||
| </dl> | ||
| <dl> | ||
| <dt><code><strong><a href="http://www.lua.org/pil/2.2.html">boolean</a></strong> forced (false)</code></dt> | ||
| <dd class="docblock"><em>See method description.</em></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>⇤</dt> | ||
| <dd>Move up in search results</dd> | ||
| <dt>⇥</dt> | ||
| <dd>Move down in search results</dd> | ||
| <dt>⏎</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 async src="../search-index.js"></script> | ||
| <center>Generated on <script src="../date.js"></script></center> | ||
| <center>©2016 - Eluna Lua Engine</center> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| document.write("07/08/2023"); | ||
| document.write("14/10/2023"); |
Oops, something went wrong.