3.7 KiB
Plang
About
The Plang plugin provides a scripting interface to PBot. It has access to PBot internal APIs and state.
The Plang Language
The scripting language is Plang. It was written specifically for PBot, but aims to be powerful enough to be used as a general-purpose scripting language embedded into any Perl application.
This document describes PBot’s Plang plugin. To learn how to use the Plang scripting language, see the Plang documentation.
PBot commands
plang
Use the plang command to run a Plang script.
Usage: plang <code>
plangrepl
The plangrepl command is identical to the
plang command, except the environment is preserved
in-between commands and the types of values is output along with the
value.
PBot built-in Plang functions
Plang lets you add custom built-in functions. Several have been added for PBot; they are described here.
factget
Use the factget function to retrieve metadata from
factoids.
Signature:
factget(channel: String, keyword: String, meta: String = "action") -> String | Null
The factget function takes three paramaters:
channel, keyword and meta. The
meta parameter can be omitted and will default to
"action".
The factget function returns a String
containing the value of the factoid metadata or null if the
factoid does not exist.
factset
Use the factset function to set metadata values for
factoids. The factoid will be created if it does not exist.
Signature:
factset(channel: String, keyword: String, text: String, meta: String = "action") -> String
The factset function takes four parameters:
channel, keyword, text, and
optionally meta. If the meta parameter is
omitted it will default to "action".
The factset function returns a String
containing the value of text.
factappend
Use the factappend function to append text to the
action metadata for factoids.
Signature:
factappend(channel: String, keyword: String, text: String) -> String
The factappend function takes three parameters:
channel, keyword and text.
The factappend function returns a String
containing the value of factoid’s action metadata with
text appended.
userget
Use the userget function to retrieve user metadata.
Signature: userget(name: String) -> Map | Null
The userget function takes one parameter:
name.
The userget function returns a Map
containing all the metadata of the user, or null if there
is no user matching name.
See the Plang Map documentation for a refresher on using Plang maps.
Examples
Basic examples
<pragma-> !plang userget('pragma-')
<PBot> { channels: "global", hostmasks: "*!*@unaffiliated/pragmatic-chaos", botowner: 1 }
<pragma-> !plang userget('pragma-').botowner
<PBot> 1
<pragma-> !plang if userget('pragma-').botowner then print('Greetings master!') else print('Hello mortal.')
<PBot> Greetings master!Karma example
This is just a quick-and-dirty placeholder snippet for now. This
section will be updated with a proper and elaborate demonstration of
creating proper karma commands and triggers.
<pragma-> !plang var karma = Integer(factget('#karma-data', 'pragma-')); karma += 1; factset('#karma-data', 'pragma-', String(karma));
<PBot> 1