noury/mirror-chatterino2
1
0
Fork 0
mirror of https://github.com/Chatterino/chatterino2.git synced 2024-11-21 22:24:07 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fix up docs

Browse source
This commit is contained in:
Mm2PL 2023-02-04 01:26:20 +01:00
parent 760ec89e07
commit 43c3fec3f3
No known key found for this signature in database
GPG key ID: 94AC9B80EFA15ED9
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/wip-plugins.md
View file

@ -44,7 +44,7 @@ An example plugin is available at [https://github.com/Mm2PL/Chatterino-test-plug
The following parts of the Lua standard library are loaded: The following parts of the Lua standard library are loaded:
- `_G` (all globals) - `_G` (most globals)
- `table` - `table`
- `string` - `string`
- `math` - `math`
@ -56,7 +56,7 @@ The official manual for them is available [here](https://www.lua.org/manual/5.4/
All Chatterino functions are exposed in a global table called `c2`. The following functions are available All Chatterino functions are exposed in a global table called `c2`. The following functions are available
### `register_command(name, handler)` #### `register_command(name, handler)`
Registers a new command called `name` which when executed will call `handler`. Registers a new command called `name` which when executed will call `handler`.
Returns `true` if everything went ok, `false` if there already exists another Returns `true` if everything went ok, `false` if there already exists another
@ -72,7 +72,7 @@ function cmdWords(ctx)
c2.system_msg(ctx.channelName, "Words are: " .. table.concat(ctx.words, " ")) c2.system_msg(ctx.channelName, "Words are: " .. table.concat(ctx.words, " "))
end end
c2.register_command("/wordsl", cmdWords) c2.register_command("/words", cmdWords)
``` ```
Limitations/known issues: Limitations/known issues:
@ -81,7 +81,7 @@ Limitations/known issues:
rebuilding the window content caused by reloading another plugin will solve this rebuilding the window content caused by reloading another plugin will solve this
- spaces in command names aren't handled very well (https://github.com/Chatterino/chatterino2/issues/1517) - spaces in command names aren't handled very well (https://github.com/Chatterino/chatterino2/issues/1517)
### `send_msg(channel, text)` #### `send_msg(channel, text)`
Sends a message to `channel` with the specified text. Also executes commands. Sends a message to `channel` with the specified text. Also executes commands.
@ -100,7 +100,7 @@ Limitations/Known issues:
- it is possible to trigger your own Lua command with this causing a potentially infinite loop - it is possible to trigger your own Lua command with this causing a potentially infinite loop
### `system_msg(channel, text)` #### `system_msg(channel, text)`
Creates a system message and adds it to the twitch channel specified by Creates a system message and adds it to the twitch channel specified by
`channel`. Returns `true` if everything went ok, `false` otherwise. It will `channel`. Returns `true` if everything went ok, `false` otherwise. It will