| 1 | Référence Lua |
| 2 | |
| 3 | <p>Escaline utilise Lua 5 comme moteur de script pour ses commandes, vous pouvez utiliser, en plus des fonctions spécifiques à Escaline décrites ci-dessous, les fonctions suivantes de la bibliothèque standard : <samp class="lua">ipairs</samp>, <samp class="lua">next</samp>, <samp class="lua">pairs</samp>, <samp class="lua">tonumber</samp>, <samp class="lua">tostring</samp>, <samp class="lua">type</samp>, <samp class="lua">unpack</samp>, <samp class="lua"><span class="package">string</span></samp>, <samp class="lua"><span class="package">table</span></samp>, et <samp class="lua"><span class="package">math</span></samp>. A noter que les fonctions <samp class="lua">os.time</samp>, <samp class="lua">os.date</samp>, et <samp class="lua">os.difftime</samp> sont accessibles par le package « time » (<samp class="lua">time.time</samp>, <samp class="lua">time.date</samp>, <samp class="lua">time.difftime</samp>).</p> |
| 4 | |
| 5 | <p>Le <a href="http://www.lua.org/manual/5.0/manual.html">manuel de Lua</a> |
| 6 | documente très bien ces diverses fonctions ainsi que la syntaxe du langage.</p> |
| 7 | |
| 8 | <p>Si certaines fonctions de la bibliothèque standard ne sont pas incluse et vous semble utiles pour le développement des modules, contactez-nous, nous étudierons la question...</p> |
| 9 | |
| 10 | <h2>Fonctions relatives à Escaline (package <samp class="lua"><span class="package">escaline</span></samp>)</h2> |
| 11 | |
| 12 | <div class="function_doc"> |
| 13 | <h3><samp class="lua"><span class="package">escaline</span>.return_url(string)</samp></h3> |
| 14 | <p>Stoppe l'exécution de la commande et retourne l'url « string » |
| 15 | au site qui servira à rediriger l'utilisateur.</p> |
| 16 | </div> |
| 17 | |
| 18 | <div class="function_doc"> |
| 19 | <h3><samp class="lua"><span class="package">escaline</span>.return_error(string)</samp></h3> |
| 20 | <p>Stoppe l'exécution de la commande et retourne le message d'erreur |
| 21 | « string » au site qui l'affichera à l'utilisateur.</p> |
| 22 | </div> |
| 23 | |
| 24 | <div class="function_doc"> |
| 25 | <h3><samp class="lua"><span class="package">escaline</span>.return_message(string)</samp></h3> |
| 26 | <p>Stoppe l'exécution de la commande et retourne le message |
| 27 | « string » au site qui l'affichera à l'utilisateur.</p> |
| 28 | </div> |
| 29 | |
| 30 | <h2>Fonctions du package <samp class="lua"><span class="package">table</span></samp></h2> |
| 31 | |
| 32 | <div class="function_doc"> |
| 33 | <h3><samp class="lua"><span class="package">table</span>.into(string, array)</samp></h3> |
| 34 | <p>Retourne true si « string » se trouve dans « array ».</p> |
| 35 | </div> |
| 36 | |
| 37 | <div class="function_doc"> |
| 38 | <h3><samp class="lua"><span class="package">table</span>.key_into(string, array)</samp></h3> |
| 39 | <p>Retourne true si « string » se trouve dans les clés de « array ».</p> |
| 40 | </div> |
| 41 | |
