sammyette/Hilbish
2
2
Fork 0
mirror of https://github.com/Hilbis/Hilbish synced 2025-04-20 20:43:23 +00:00
Code Issues Releases Wiki Activity

deploy: ff84cfb068c27298b069d45be5b7efdab553dd1a

Browse Source
This commit is contained in:
sammy-ette 2025-03-18 01:48:15 +00:00
parent 9db08d1c23
commit 8438703aaf
5 changed files with 206 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

170
versions/document-lua/docs/api/hilbish/hilbish.messages/index.html
View File

@ -15,4 +15,172 @@
<a href=#readAll class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-5 class=heading>Parameters <a href=#readAll class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-5 class=heading>Parameters
<a href=#parameters-5 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=unreadCount><h4 class=heading>hilbish.messages.unreadCount() <a href=#parameters-5 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=unreadCount><h4 class=heading>hilbish.messages.unreadCount()
<a href=#unreadCount class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-6 class=heading>Parameters <a href=#unreadCount class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-6 class=heading>Parameters
<a href=#parameters-6 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea &copy; 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html> <a href=#parameters-6 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=all><h4 class=heading>hilbish.messages.all()
<a href=#all class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-7 class=heading>Parameters
<a href=#parameters-7 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=clear><h4 class=heading>hilbish.messages.clear()
<a href=#clear class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-8 class=heading>Parameters
<a href=#parameters-8 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=delete><h4 class=heading>hilbish.messages.delete()
<a href=#delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-9 class=heading>Parameters
<a href=#parameters-9 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=read><h4 class=heading>hilbish.messages.read()
<a href=#read class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-10 class=heading>Parameters
<a href=#parameters-10 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=send><h4 class=heading>hilbish.messages.send(message)
<a href=#send class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sends a message.</p><h5 id=parameters-11 class=heading>Parameters
<a href=#parameters-11 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>message</code> <strong><code>hilbish.message</code></strong></p></div><hr><div id=readAll><h4 class=heading>hilbish.messages.readAll()
<a href=#readAll class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-12 class=heading>Parameters
<a href=#parameters-12 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=unreadCount><h4 class=heading>hilbish.messages.unreadCount()
<a href=#unreadCount class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-13 class=heading>Parameters
<a href=#parameters-13 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=all><h4 class=heading>hilbish.messages.all()
<a href=#all class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-14 class=heading>Parameters
<a href=#parameters-14 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=clear><h4 class=heading>hilbish.messages.clear()
<a href=#clear class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-15 class=heading>Parameters
<a href=#parameters-15 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=delete><h4 class=heading>hilbish.messages.delete()
<a href=#delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-16 class=heading>Parameters
<a href=#parameters-16 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=read><h4 class=heading>hilbish.messages.read()
<a href=#read class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-17 class=heading>Parameters
<a href=#parameters-17 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=send><h4 class=heading>hilbish.messages.send(message)
<a href=#send class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sends a message.</p><h5 id=parameters-18 class=heading>Parameters
<a href=#parameters-18 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>message</code> <strong><code>hilbish.message</code></strong></p></div><hr><div id=readAll><h4 class=heading>hilbish.messages.readAll()
<a href=#readAll class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-19 class=heading>Parameters
<a href=#parameters-19 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=unreadCount><h4 class=heading>hilbish.messages.unreadCount()
<a href=#unreadCount class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-20 class=heading>Parameters
<a href=#parameters-20 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=all><h4 class=heading>hilbish.messages.all()
<a href=#all class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-21 class=heading>Parameters
<a href=#parameters-21 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=clear><h4 class=heading>hilbish.messages.clear()
<a href=#clear class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-22 class=heading>Parameters
<a href=#parameters-22 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=delete><h4 class=heading>hilbish.messages.delete(idx)
<a href=#delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Deletes the message at <code>idx</code>.</p><h5 id=parameters-23 class=heading>Parameters
<a href=#parameters-23 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>idx</code> <strong><code>number</code></strong></p></div><hr><div id=read><h4 class=heading>hilbish.messages.read()
<a href=#read class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-24 class=heading>Parameters
<a href=#parameters-24 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=send><h4 class=heading>hilbish.messages.send(message)
<a href=#send class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sends a message.</p><h5 id=parameters-25 class=heading>Parameters
<a href=#parameters-25 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>message</code> <strong><code>hilbish.message</code></strong></p></div><hr><div id=readAll><h4 class=heading>hilbish.messages.readAll()
<a href=#readAll class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-26 class=heading>Parameters
<a href=#parameters-26 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=unreadCount><h4 class=heading>hilbish.messages.unreadCount()
<a href=#unreadCount class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-27 class=heading>Parameters
<a href=#parameters-27 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=all><h4 class=heading>hilbish.messages.all()
<a href=#all class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-28 class=heading>Parameters
<a href=#parameters-28 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=clear><h4 class=heading>hilbish.messages.clear()
<a href=#clear class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-29 class=heading>Parameters
<a href=#parameters-29 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=delete><h4 class=heading>hilbish.messages.delete(idx)
<a href=#delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Deletes the message at <code>idx</code>.</p><h5 id=parameters-30 class=heading>Parameters
<a href=#parameters-30 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>idx</code> <strong><code>number</code></strong><br>r</p></div><hr><div id=read><h4 class=heading>hilbish.messages.read()
<a href=#read class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-31 class=heading>Parameters
<a href=#parameters-31 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=send><h4 class=heading>hilbish.messages.send(message)
<a href=#send class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sends a message.</p><h5 id=parameters-32 class=heading>Parameters
<a href=#parameters-32 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>message</code> <strong><code>hilbish.message</code></strong><br>e</p></div><hr><div id=readAll><h4 class=heading>hilbish.messages.readAll()
<a href=#readAll class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-33 class=heading>Parameters
<a href=#parameters-33 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=unreadCount><h4 class=heading>hilbish.messages.unreadCount()
<a href=#unreadCount class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-34 class=heading>Parameters
<a href=#parameters-34 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=all><h4 class=heading>hilbish.messages.all()
<a href=#all class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-35 class=heading>Parameters
<a href=#parameters-35 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=clear><h4 class=heading>hilbish.messages.clear()
<a href=#clear class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-36 class=heading>Parameters
<a href=#parameters-36 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=delete><h4 class=heading>hilbish.messages.delete(idx)
<a href=#delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Deletes the message at <code>idx</code>.</p><h5 id=parameters-37 class=heading>Parameters
<a href=#parameters-37 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>idx</code> <strong><code>number</code></strong><br>r</p></div><hr><div id=read><h4 class=heading>hilbish.messages.read()
<a href=#read class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-38 class=heading>Parameters
<a href=#parameters-38 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=send><h4 class=heading>hilbish.messages.send(message)
<a href=#send class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sends a message.</p><h5 id=parameters-39 class=heading>Parameters
<a href=#parameters-39 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>message</code> <strong><code>hilbish.message</code></strong><br>e</p></div><hr><div id=readAll><h4 class=heading>hilbish.messages.readAll()
<a href=#readAll class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-40 class=heading>Parameters
<a href=#parameters-40 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=unreadCount><h4 class=heading>hilbish.messages.unreadCount()
<a href=#unreadCount class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-41 class=heading>Parameters
<a href=#parameters-41 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=all><h4 class=heading>hilbish.messages.all()
<a href=#all class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-42 class=heading>Parameters
<a href=#parameters-42 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=clear><h4 class=heading>hilbish.messages.clear()
<a href=#clear class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-43 class=heading>Parameters
<a href=#parameters-43 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=delete><h4 class=heading>hilbish.messages.delete(idx)
<a href=#delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Deletes the message at <code>idx</code>.</p><h5 id=parameters-44 class=heading>Parameters
<a href=#parameters-44 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>idx</code> <strong><code>number</code></strong><br>r</p></div><hr><div id=read><h4 class=heading>hilbish.messages.read()
<a href=#read class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-45 class=heading>Parameters
<a href=#parameters-45 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=send><h4 class=heading>hilbish.messages.send(message)
<a href=#send class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sends a message.</p><h5 id=parameters-46 class=heading>Parameters
<a href=#parameters-46 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>message</code> <strong><code>hilbish.message</code></strong><br>e</p></div><hr><div id=readAll><h4 class=heading>hilbish.messages.readAll()
<a href=#readAll class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-47 class=heading>Parameters
<a href=#parameters-47 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=unreadCount><h4 class=heading>hilbish.messages.unreadCount()
<a href=#unreadCount class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-48 class=heading>Parameters
<a href=#parameters-48 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=all><h4 class=heading>hilbish.messages.all()
<a href=#all class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-49 class=heading>Parameters
<a href=#parameters-49 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=clear><h4 class=heading>hilbish.messages.clear()
<a href=#clear class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-50 class=heading>Parameters
<a href=#parameters-50 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=delete><h4 class=heading>hilbish.messages.delete(idx)
<a href=#delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Deletes the message at <code>idx</code>.</p><h5 id=parameters-51 class=heading>Parameters
<a href=#parameters-51 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>idx</code> <strong><code>number</code></strong><br>r</p></div><hr><div id=read><h4 class=heading>hilbish.messages.read()
<a href=#read class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-52 class=heading>Parameters
<a href=#parameters-52 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=send><h4 class=heading>hilbish.messages.send(message)
<a href=#send class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sends a message.</p><h5 id=parameters-53 class=heading>Parameters
<a href=#parameters-53 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>message</code> <strong><code>hilbish.message</code></strong><br>e</p></div><hr><div id=readAll><h4 class=heading>hilbish.messages.readAll()
<a href=#readAll class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-54 class=heading>Parameters
<a href=#parameters-54 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=unreadCount><h4 class=heading>hilbish.messages.unreadCount()
<a href=#unreadCount class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-55 class=heading>Parameters
<a href=#parameters-55 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=all><h4 class=heading>hilbish.messages.all()
<a href=#all class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-56 class=heading>Parameters
<a href=#parameters-56 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=clear><h4 class=heading>hilbish.messages.clear()
<a href=#clear class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-57 class=heading>Parameters
<a href=#parameters-57 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=delete><h4 class=heading>hilbish.messages.delete(idx)
<a href=#delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Deletes the message at <code>idx</code>.</p><h5 id=parameters-58 class=heading>Parameters
<a href=#parameters-58 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>idx</code> <strong><code>number</code></strong><br>r</p></div><hr><div id=read><h4 class=heading>hilbish.messages.read()
<a href=#read class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-59 class=heading>Parameters
<a href=#parameters-59 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=send><h4 class=heading>hilbish.messages.send(message)
<a href=#send class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sends a message.</p><h5 id=parameters-60 class=heading>Parameters
<a href=#parameters-60 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>message</code> <strong><code>hilbish.message</code></strong><br>e</p></div><hr><div id=readAll><h4 class=heading>hilbish.messages.readAll()
<a href=#readAll class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-61 class=heading>Parameters
<a href=#parameters-61 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=unreadCount><h4 class=heading>hilbish.messages.unreadCount()
<a href=#unreadCount class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-62 class=heading>Parameters
<a href=#parameters-62 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=all><h4 class=heading>hilbish.messages.all()
<a href=#all class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-63 class=heading>Parameters
<a href=#parameters-63 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=clear><h4 class=heading>hilbish.messages.clear()
<a href=#clear class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-64 class=heading>Parameters
<a href=#parameters-64 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=delete><h4 class=heading>hilbish.messages.delete(idx)
<a href=#delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Deletes the message at <code>idx</code>.</p><h5 id=parameters-65 class=heading>Parameters
<a href=#parameters-65 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>idx</code> <strong><code>number</code></strong><br>r</p></div><hr><div id=read><h4 class=heading>hilbish.messages.read()
<a href=#read class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-66 class=heading>Parameters
<a href=#parameters-66 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=send><h4 class=heading>hilbish.messages.send(message)
<a href=#send class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sends a message.</p><h5 id=parameters-67 class=heading>Parameters
<a href=#parameters-67 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>message</code> <strong><code>hilbish.message</code></strong><br>e</p></div><hr><div id=readAll><h4 class=heading>hilbish.messages.readAll()
<a href=#readAll class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-68 class=heading>Parameters
<a href=#parameters-68 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=unreadCount><h4 class=heading>hilbish.messages.unreadCount()
<a href=#unreadCount class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-69 class=heading>Parameters
<a href=#parameters-69 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=all><h4 class=heading>hilbish.messages.all()
<a href=#all class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-70 class=heading>Parameters
<a href=#parameters-70 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=clear><h4 class=heading>hilbish.messages.clear()
<a href=#clear class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-71 class=heading>Parameters
<a href=#parameters-71 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=delete><h4 class=heading>hilbish.messages.delete(idx)
<a href=#delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Deletes the message at <code>idx</code>.</p><h5 id=parameters-72 class=heading>Parameters
<a href=#parameters-72 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>idx</code> <strong><code>number</code></strong></p></div><hr><div id=read><h4 class=heading>hilbish.messages.read()
<a href=#read class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-73 class=heading>Parameters
<a href=#parameters-73 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=send><h4 class=heading>hilbish.messages.send(message)
<a href=#send class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sends a message.</p><h5 id=parameters-74 class=heading>Parameters
<a href=#parameters-74 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>message</code> <strong><code>hilbish.message</code></strong></p></div><hr><div id=readAll><h4 class=heading>hilbish.messages.readAll()
<a href=#readAll class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-75 class=heading>Parameters
<a href=#parameters-75 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=unreadCount><h4 class=heading>hilbish.messages.unreadCount()
<a href=#unreadCount class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-76 class=heading>Parameters
<a href=#parameters-76 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=all><h4 class=heading>hilbish.messages.all()
<a href=#all class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-77 class=heading>Parameters
<a href=#parameters-77 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=clear><h4 class=heading>hilbish.messages.clear()
<a href=#clear class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-78 class=heading>Parameters
<a href=#parameters-78 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=delete><h4 class=heading>hilbish.messages.delete(idx)
<a href=#delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Deletes the message at <code>idx</code>.</p><h5 id=parameters-79 class=heading>Parameters
<a href=#parameters-79 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>idx</code> <strong><code>number</code></strong></p></div><hr><div id=read><h4 class=heading>hilbish.messages.read()
<a href=#read class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-80 class=heading>Parameters
<a href=#parameters-80 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=send><h4 class=heading>hilbish.messages.send(message)
<a href=#send class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sends a message.</p><h5 id=parameters-81 class=heading>Parameters
<a href=#parameters-81 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>message</code> <strong><code>hilbish.message</code></strong></p></div><hr><div id=readAll><h4 class=heading>hilbish.messages.readAll()
<a href=#readAll class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-82 class=heading>Parameters
<a href=#parameters-82 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=unreadCount><h4 class=heading>hilbish.messages.unreadCount()
<a href=#unreadCount class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-83 class=heading>Parameters
<a href=#parameters-83 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=all><h4 class=heading>hilbish.messages.all()
<a href=#all class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-84 class=heading>Parameters
<a href=#parameters-84 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=clear><h4 class=heading>hilbish.messages.clear()
<a href=#clear class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-85 class=heading>Parameters
<a href=#parameters-85 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=delete><h4 class=heading>hilbish.messages.delete()
<a href=#delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Deletes the message at <code>idx</code>.</p><h5 id=parameters-86 class=heading>Parameters
<a href=#parameters-86 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=read><h4 class=heading>hilbish.messages.read()
<a href=#read class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-87 class=heading>Parameters
<a href=#parameters-87 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=send><h4 class=heading>hilbish.messages.send(message)
<a href=#send class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sends a message.</p><h5 id=parameters-88 class=heading>Parameters
<a href=#parameters-88 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>message</code> <strong><code>hilbish.message</code></strong></p></div><hr><div id=readAll><h4 class=heading>hilbish.messages.readAll()
<a href=#readAll class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-89 class=heading>Parameters
<a href=#parameters-89 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=unreadCount><h4 class=heading>hilbish.messages.unreadCount()
<a href=#unreadCount class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=parameters-90 class=heading>Parameters
<a href=#parameters-90 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea &copy; 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>

9
versions/document-lua/docs/api/hilbish/hilbish.runner/index.html
View File

@ -41,14 +41,11 @@ shell script if fennel eval has an error.</p><div class=highlight><pre tabindex=
<a href=#parameters-4 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong></p></div><hr><div id=add><h4 class=heading>hilbish.runner.add(name, runner) <a href=#parameters-4 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong></p></div><hr><div id=add><h4 class=heading>hilbish.runner.add(name, runner)
<a href=#add class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Adds a runner to the table of available runners. If runner is a table, <a href=#add class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Adds a runner to the table of available runners. If runner is a table,
it must have the run function in it.</p><h5 id=parameters-5 class=heading>Parameters it must have the run function in it.</p><h5 id=parameters-5 class=heading>Parameters
<a href=#parameters-5 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong> <a href=#parameters-5 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong></p><p><code>runner</code> <strong><code>function|table</code></strong></p></div><hr><div id=get><h4 class=heading>hilbish.runner.get(name)
<code>runner</code> <strong><code>function</code></strong></p></div><hr><div id=get><h4 class=heading>hilbish.runner.get(name)
<a href=#get class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Get a runner by name.</p><h5 id=parameters-6 class=heading>Parameters <a href=#get class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Get a runner by name.</p><h5 id=parameters-6 class=heading>Parameters
<a href=#parameters-6 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong></p></div><hr><div id=set><h4 class=heading>hilbish.runner.set(name, runner) <a href=#parameters-6 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong></p></div><hr><div id=set><h4 class=heading>hilbish.runner.set(name, runner)
<a href=#set class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sets a runner by name. The runner table must have the run function in it.</p><h5 id=parameters-7 class=heading>Parameters <a href=#set class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sets a runner by name. The runner table must have the run function in it.</p><h5 id=parameters-7 class=heading>Parameters
<a href=#parameters-7 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong> <a href=#parameters-7 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>name</code> <strong><code>string</code></strong></p><p><code>runner</code> <strong><code>table</code></strong></p></div><hr><div id=exec><h4 class=heading>hilbish.runner.exec(cmd, runnerName)
<code>runner</code> <strong><code>table</code></strong></p></div><hr><div id=exec><h4 class=heading>hilbish.runner.exec(cmd, runnerName)
<a href=#exec class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Executes cmd with a runner. If runnerName isn&rsquo;t passed, it uses <a href=#exec class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Executes cmd with a runner. If runnerName isn&rsquo;t passed, it uses
the user&rsquo;s current runner.</p><h5 id=parameters-8 class=heading>Parameters the user&rsquo;s current runner.</p><h5 id=parameters-8 class=heading>Parameters
<a href=#parameters-8 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>cmd</code> <strong><code>string</code></strong> <a href=#parameters-8 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>cmd</code> <strong><code>string</code></strong></p><p><code>runnerName</code> <strong><code>string?</code></strong></p></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea &copy; 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
<code>runnerName</code> <strong><code>string?</code></strong></p></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea &copy; 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>

5
versions/document-lua/docs/api/hilbish/index.xml
View File

@ -11,7 +11,10 @@ hilbish.messages.read() Parameters This function has no parameters.
hilbish.messages.send(message) Sends a message. hilbish.messages.send(message) Sends a message.
Parameters message hilbish.message Parameters message hilbish.message
hilbish.messages.readAll() Parameters This function has no parameters. hilbish.messages.readAll() Parameters This function has no parameters.
hilbish.messages.unreadCount() Parameters This function has no parameters.</description></item><item><title>Module hilbish.module</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</guid><description>Introduction The hilbish.module interface provides a function to load Hilbish plugins/modules. Hilbish modules are Go-written plugins (see https://pkg.go.dev/plugin ) that are used to add functionality to Hilbish that cannot be written in Lua for any reason. hilbish.messages.unreadCount() Parameters This function has no parameters.
hilbish.messages.all() Parameters This function has no parameters.
hilbish.messages.clear() Parameters This function has no parameters.
hilbish.messages.delete() Parameters This function has no parameters.</description></item><item><title>Module hilbish.module</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</guid><description>Introduction The hilbish.module interface provides a function to load Hilbish plugins/modules. Hilbish modules are Go-written plugins (see https://pkg.go.dev/plugin ) that are used to add functionality to Hilbish that cannot be written in Lua for any reason.
Note that you don&amp;rsquo;t ever need to use the load function that is here as modules can be loaded with a require call like Lua C modules, and the search paths can be changed with the paths property here.</description></item><item><title>Module hilbish.os</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/</guid><description> Introduction Provides simple text information properties about the current operating system. This mainly includes the name and version. Note that you don&amp;rsquo;t ever need to use the load function that is here as modules can be loaded with a require call like Lua C modules, and the search paths can be changed with the paths property here.</description></item><item><title>Module hilbish.os</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/</guid><description> Introduction Provides simple text information properties about the current operating system. This mainly includes the name and version.
Static module fields family Family name of the current OS name Pretty name of the current OS version Version of the current OS</description></item><item><title>Module hilbish.runner</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/</guid><description>Introduction The runner interface contains functions that allow the user to change how Hilbish interprets interactive input. Users can add and change the default runner for interactive input to any language or script of their choosing. A good example is using it to write command in Fennel. Static module fields family Family name of the current OS name Pretty name of the current OS version Version of the current OS</description></item><item><title>Module hilbish.runner</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/</guid><description>Introduction The runner interface contains functions that allow the user to change how Hilbish interprets interactive input. Users can add and change the default runner for interactive input to any language or script of their choosing. A good example is using it to write command in Fennel.
Runners are functions that evaluate user input. The default runners in Hilbish can run shell script and Lua code. Runners are functions that evaluate user input. The default runners in Hilbish can run shell script and Lua code.

31
versions/document-lua/docs/getting-started/index.html
View File

@ -25,8 +25,29 @@ It is configured and scripted via Lua, so the config file is a Lua file.
You can use any pure Lua library to do whatever you want.</p><p>Hilbish&rsquo;s sample configuration is usually located in <code>hilbish.dataDir .. '/.hilbishrc.lua'</code>. You can use any pure Lua library to do whatever you want.</p><p>Hilbish&rsquo;s sample configuration is usually located in <code>hilbish.dataDir .. '/.hilbishrc.lua'</code>.
You can print that path via Lua to see what it is: <code>print(hilbish.dataDir .. '/.hilbishrc.lua')</code>. You can print that path via Lua to see what it is: <code>print(hilbish.dataDir .. '/.hilbishrc.lua')</code>.
As an example, it will usually will result in <code>/usr/share/hilbish/.hilbishrc.lua</code> on Linux.</p><p>To edit your user configuration, you can copy that file to <code>hilbish.userDir.config .. '/hilbish/init.lua'</code>, As an example, it will usually will result in <code>/usr/share/hilbish/.hilbishrc.lua</code> on Linux.</p><p>To edit your user configuration, you can copy that file to <code>hilbish.userDir.config .. '/hilbish/init.lua'</code>,
which follows XDG on Linux and MacOS, and is located in %APPDATA% on Windows.</p><p>As the directory is usually <code>~/.config</code> on Linux, you can run this command to copy it:<br><code>cp /usr/share/hilbish/.hilbishrc.lua ~/.config/hilbish/init.lua</code></p><p>Now you can get to editing it. Since it&rsquo;s just a Lua file, having basic which follows XDG on Linux and MacOS, and is located in %APPDATA% on Windows.</p><p>As the directory is usually <code>~/.config</code> on Linux, you can run this command to copy it:<br><code>cp /usr/share/hilbish/.hilbishrc.lua ~/.config/hilbish/init.lua</code></p><p>Now we can get to customization!</p><p>If we closely examine a small snippet of the default config:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln> 1</span><span class=cl><span class=c1>-- Default Hilbish config</span>
knowledge of Lua would help. All of Lua&rsquo;s standard libraries and functions </span></span><span class=line><span class=ln> 2</span><span class=cl><span class=c1>-- .. with some omitted code .. --</span>
from Lua 5.4 are available. Hilbish has some custom and modules that are </span></span><span class=line><span class=ln> 3</span><span class=cl>
available. To see them, you can run the <code>doc</code> command. This also works as </span></span><span class=line><span class=ln> 4</span><span class=cl><span class=kd>local</span> <span class=kr>function</span> <span class=nf>doPrompt</span><span class=p>(</span><span class=n>fail</span><span class=p>)</span>
general documentation for other things.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea &copy; 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html> </span></span><span class=line><span class=ln> 5</span><span class=cl> <span class=n>hilbish.prompt</span><span class=p>(</span><span class=n>lunacolors.format</span><span class=p>(</span>
</span></span><span class=line><span class=ln> 6</span><span class=cl> <span class=s1>&#39;{blue}%u {cyan}%d &#39;</span> <span class=o>..</span> <span class=p>(</span><span class=n>fail</span> <span class=ow>and</span> <span class=s1>&#39;{red}&#39;</span> <span class=ow>or</span> <span class=s1>&#39;{green}&#39;</span><span class=p>)</span> <span class=o>..</span> <span class=s1>&#39;∆ &#39;</span>
</span></span><span class=line><span class=ln> 7</span><span class=cl> <span class=p>))</span>
</span></span><span class=line><span class=ln> 8</span><span class=cl><span class=kr>end</span>
</span></span><span class=line><span class=ln> 9</span><span class=cl>
</span></span><span class=line><span class=ln>10</span><span class=cl><span class=n>doPrompt</span><span class=p>()</span>
</span></span><span class=line><span class=ln>11</span><span class=cl>
</span></span><span class=line><span class=ln>12</span><span class=cl><span class=n>bait.catch</span><span class=p>(</span><span class=s1>&#39;command.exit&#39;</span><span class=p>,</span> <span class=kr>function</span><span class=p>(</span><span class=n>code</span><span class=p>)</span>
</span></span><span class=line><span class=ln>13</span><span class=cl> <span class=n>doPrompt</span><span class=p>(</span><span class=n>code</span> <span class=o>~=</span> <span class=mi>0</span><span class=p>)</span>
</span></span><span class=line><span class=ln>14</span><span class=cl><span class=kr>end</span><span class=p>)</span>
</span></span></code></pre></div><p>We see a whopping <strong>three</strong> Hilbish libraries being used in this part of code.
First is of course, named after the shell itself, <a href=../api/hilbish><code>hilbish</code></a>
. This is kind of a
&ldquo;catch-all&rdquo; namespace for functions that directly related to shell functionality/settings.</p><p>And as we can see, the <a href=../api/hilbish/#prompt>hilbish.prompt</a>
function is used
to change our prompt. Change our prompt to what, exactly?</p><p>The doc for the function states that the verbs <code>%u</code> and <code>%d</code>are used for username and current directory
of the shell, respectively.</p><p>We wrap this in the <a href=../lunacolors><code>lunacolors.format</code></a>
function, to give
our prompt some nice color.</p><p>But you might have also noticed that this is in the <code>doPrompt</code> function, which is called once,
and then used again in a <a href=../api/bait>bait</a>
hook. Specifically, the <code>command.exit</code> hook,
which is called after a command exits, so when it finishes running.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea &copy; 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>

5
versions/document-lua/index.xml
View File

@ -68,7 +68,10 @@ hilbish.messages.read() Parameters This function has no parameters.
hilbish.messages.send(message) Sends a message. hilbish.messages.send(message) Sends a message.
Parameters message hilbish.message Parameters message hilbish.message
hilbish.messages.readAll() Parameters This function has no parameters. hilbish.messages.readAll() Parameters This function has no parameters.
hilbish.messages.unreadCount() Parameters This function has no parameters.</description></item><item><title>Module hilbish.module</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</guid><description>Introduction The hilbish.module interface provides a function to load Hilbish plugins/modules. Hilbish modules are Go-written plugins (see https://pkg.go.dev/plugin ) that are used to add functionality to Hilbish that cannot be written in Lua for any reason. hilbish.messages.unreadCount() Parameters This function has no parameters.
hilbish.messages.all() Parameters This function has no parameters.
hilbish.messages.clear() Parameters This function has no parameters.
hilbish.messages.delete() Parameters This function has no parameters.</description></item><item><title>Module hilbish.module</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.module/</guid><description>Introduction The hilbish.module interface provides a function to load Hilbish plugins/modules. Hilbish modules are Go-written plugins (see https://pkg.go.dev/plugin ) that are used to add functionality to Hilbish that cannot be written in Lua for any reason.
Note that you don&amp;rsquo;t ever need to use the load function that is here as modules can be loaded with a require call like Lua C modules, and the search paths can be changed with the paths property here.</description></item><item><title>Module hilbish.os</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/</guid><description> Introduction Provides simple text information properties about the current operating system. This mainly includes the name and version. Note that you don&amp;rsquo;t ever need to use the load function that is here as modules can be loaded with a require call like Lua C modules, and the search paths can be changed with the paths property here.</description></item><item><title>Module hilbish.os</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.os/</guid><description> Introduction Provides simple text information properties about the current operating system. This mainly includes the name and version.
Static module fields family Family name of the current OS name Pretty name of the current OS version Version of the current OS</description></item><item><title>Module hilbish.runner</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/</guid><description>Introduction The runner interface contains functions that allow the user to change how Hilbish interprets interactive input. Users can add and change the default runner for interactive input to any language or script of their choosing. A good example is using it to write command in Fennel. Static module fields family Family name of the current OS name Pretty name of the current OS version Version of the current OS</description></item><item><title>Module hilbish.runner</title><link>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/document-lua/docs/api/hilbish/hilbish.runner/</guid><description>Introduction The runner interface contains functions that allow the user to change how Hilbish interprets interactive input. Users can add and change the default runner for interactive input to any language or script of their choosing. A good example is using it to write command in Fennel.
Runners are functions that evaluate user input. The default runners in Hilbish can run shell script and Lua code. Runners are functions that evaluate user input. The default runners in Hilbish can run shell script and Lua code.