GitHub
/
pbot
mirror of https://github.com/pragma-/pbot.git
3
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc/Commands.md: add Functions

This commit is contained in:
Pragmatic Software 2020-02-16 12:22:05 -08:00
parent fcf8605389
commit c7a5443d68
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/Commands.md
View File

@ -13,6 +13,7 @@
* [Built-in commands](#built-in-commands) * [Built-in commands](#built-in-commands)
* [Creating new built-in commands](#creating-new-built-in-commands) * [Creating new built-in commands](#creating-new-built-in-commands)
* [Plugins](#plugins) * [Plugins](#plugins)
* [Functions](#functions)
* [Factoids](#factoids) * [Factoids](#factoids)
* [Code Factoids](#code-factoids) * [Code Factoids](#code-factoids)
* [Modules](#modules) * [Modules](#modules)
@ -205,6 +206,18 @@ stand-alone self-contained units of code that can be loaded by the PBot owner.
* only bot owner can install and load PBot Plugins * only bot owner can install and load PBot Plugins
* PBot Plugins have access to PBot internal API functions and data structures * PBot Plugins have access to PBot internal API functions and data structures
#### Functions
Functions are commands that accept input, manipulate it and then output the result. They are extremely
useful with [piping](#piping) or [command substituting](#substitution).
For example, the `uri_escape` function demonstrated in the [Substitutions](#substitutions) section earlier
makes text safe for use in a URL. We also saw the `sed` and `uc` functions demonstrated in [Piping](#piping).
Functions can be loaded via PBot Plugins.
* only bot owner can load new Functions
* Functions have access to PBot internal API functions and data structures
### Factoids ### Factoids
Factoids are another type of command. Factoids are simple text commands which Factoids are another type of command. Factoids are simple text commands which
anybody can create. In their most basic form, they simply display their text anybody can create. In their most basic form, they simply display their text