diff --git a/versions/yarn/docs/api/index.xml b/versions/yarn/docs/api/index.xml index b9b8a759..dfb3459a 100644 --- a/versions/yarn/docs/api/index.xml +++ b/versions/yarn/docs/api/index.xml @@ -9,6 +9,6 @@ Parameters This function has no parameters. Types Snail A Snail is a shell script interpreter instance. Methods dir(path) Changes the directory of the snail instance.Module terminalhttps://rosettea.github.io/Hilbish/versions/yarn/docs/api/terminal/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/yarn/docs/api/terminal/Introduction The terminal library is a simple and lower level library for certain terminal interactions. Functions restoreState() Restores the last saved state of the terminal saveState() Saves the current state of the terminal. setRaw() Puts the terminal into raw mode. size() Gets the dimensions of the terminal. Returns a table with width and height terminal.restoreState() Restores the last saved state of the terminal -Parameters This function has no parameters.Module yarnhttps://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/ Introduction Yarn is a simple multithreading library. Threads are individual Lua states, so they do NOT share the same environment as the code that runs the thread. Bait and Commanders are shared though, so you can throw hooks from 1 thread to another. +Parameters This function has no parameters.Module yarnhttps://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/Introduction Yarn is a simple multithreading library. Threads are individual Lua states, so they do NOT share the same environment as the code that runs the thread. Bait and Commanders are shared though, so you can throw hooks from 1 thread to another. Example: -1local yarn = require 'yarn' 2 3-- calling t will run the yarn thread. 4local t = yarn.thread(print) 5t 'printing from another lua state!' Types Thread Methods \ No newline at end of file +1local yarn = require 'yarn' 2 3-- calling t will run the yarn thread. 4local t = yarn.thread(print) 5t 'printing from another lua state!' Functions thread(fun) -> @Thread Creates a new, fresh Yarn thread. \ No newline at end of file diff --git a/versions/yarn/docs/api/yarn/index.html b/versions/yarn/docs/api/yarn/index.html index 3e5a7ad2..c9ed8aa9 100644 --- a/versions/yarn/docs/api/yarn/index.html +++ b/versions/yarn/docs/api/yarn/index.html @@ -9,7 +9,10 @@ Bait and Commanders are shared though, so you can throw hooks from 1 th 3-- calling t will run the yarn thread. 4local t = yarn.thread(print) 5t 'printing from another lua state!' -

Types +

Functions +

thread(fun) -> @ThreadCreates a new, fresh Yarn thread.

yarn.thread(fun) -> Thread +

Creates a new, fresh Yarn thread.
fun is the function that will run in the thread.

Parameters +

This function has no parameters.

Types


Thread

Methods

\ No newline at end of file diff --git a/versions/yarn/index.xml b/versions/yarn/index.xml index 0368290c..3f550417 100644 --- a/versions/yarn/index.xml +++ b/versions/yarn/index.xml @@ -71,9 +71,9 @@ Parameters This function has no parameters. Types Snail A Snail is a shell script interpreter instance. Methods dir(path) Changes the directory of the snail instance.Module terminalhttps://rosettea.github.io/Hilbish/versions/yarn/docs/api/terminal/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/yarn/docs/api/terminal/Introduction The terminal library is a simple and lower level library for certain terminal interactions. Functions restoreState() Restores the last saved state of the terminal saveState() Saves the current state of the terminal. setRaw() Puts the terminal into raw mode. size() Gets the dimensions of the terminal. Returns a table with width and height terminal.restoreState() Restores the last saved state of the terminal -Parameters This function has no parameters.Module yarnhttps://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/ Introduction Yarn is a simple multithreading library. Threads are individual Lua states, so they do NOT share the same environment as the code that runs the thread. Bait and Commanders are shared though, so you can throw hooks from 1 thread to another. +Parameters This function has no parameters.Module yarnhttps://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/yarn/docs/api/yarn/Introduction Yarn is a simple multithreading library. Threads are individual Lua states, so they do NOT share the same environment as the code that runs the thread. Bait and Commanders are shared though, so you can throw hooks from 1 thread to another. Example: -1local yarn = require 'yarn' 2 3-- calling t will run the yarn thread. 4local t = yarn.thread(print) 5t 'printing from another lua state!' Types Thread MethodsNotificationhttps://rosettea.github.io/Hilbish/versions/yarn/docs/features/notifications/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/yarn/docs/features/notifications/Hilbish features a simple notification system which can be used by other plugins and parts of the shell to notify the user of various actions. This is used via the hilbish.message interface. +1local yarn = require 'yarn' 2 3-- calling t will run the yarn thread. 4local t = yarn.thread(print) 5t 'printing from another lua state!' Functions thread(fun) -> @Thread Creates a new, fresh Yarn thread.Notificationhttps://rosettea.github.io/Hilbish/versions/yarn/docs/features/notifications/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/yarn/docs/features/notifications/Hilbish features a simple notification system which can be used by other plugins and parts of the shell to notify the user of various actions. This is used via the hilbish.message interface. A message is defined as a table with the following properties: icon: A unicode/emoji icon for the notification. title: The title of the message text: Message text/body channel: The source of the message. This should be a unique and easily readable text identifier.Optionshttps://rosettea.github.io/Hilbish/versions/yarn/docs/features/opts/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/yarn/docs/features/opts/Opts are simple toggle or value options a user can set in Hilbish. As toggles, there are things like autocd or history saving. As values, there is the motd which the user can either change to a custom string or disable. Opts are accessed from the hilbish.opts table. Here they can either be read or modified