GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2024-11-25 21:39:27 +01:00
Code Issues Projects Releases Wiki Activity

doc/Plugins/Plang.md: add type annotations

Browse Source
This commit is contained in:
Pragmatic Software 2020-09-03 16:41:19 -07:00
parent c929d4c68f
commit 7c6359481a
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/Plugins/Plang.md
View File

@ -38,7 +38,7 @@ is preserved in-between commands and the types of values is output along with th
Several have been added for PBot; they are described here. Several have been added for PBot; they are described here.
### factget ### factget
factget(channel, keyword, meta = "action") factget(channel: String, keyword: String, meta: String = "action") -> String
Use the `factget` function to retrieve metadata from factoids. Use the `factget` function to retrieve metadata from factoids.
@ -48,7 +48,7 @@ parameter can be omitted and will default to `"action"`.
The `factget` function returns a `String` containing the value of the factoid metadata key. The `factget` function returns a `String` containing the value of the factoid metadata key.
### factset ### factset
factset(channel, keyword, text) factset(channel: String, keyword: String, text: String) -> String
Use the `factset` function to set the `action` metadata value for factoids. Use the `factset` function to set the `action` metadata value for factoids.
@ -57,7 +57,7 @@ The `factset` function takes three parameters: `channel`, `keyword` and `text`.
The `factset` function returns a `String` containing the value of `text`. The `factset` function returns a `String` containing the value of `text`.
### factappend ### factappend
factappend(channel, keyword, text) factappend(channel: String, keyword: String, text: String) -> String
Use the `factappend` function to append text to the `action` metadata for factoids. Use the `factappend` function to append text to the `action` metadata for factoids.
@ -67,7 +67,7 @@ The `factappend` function returns a `String` containing the value of factoid's `
metadata with `text` appended. metadata with `text` appended.
### userget ### userget
userget(name) userget(name: String) -> Map
Use the `userget` function to retrieve user metadata. Use the `userget` function to retrieve user metadata.