Rboot 文档--脚本Script

脚本Script

Script 脚本并没有提供太多开箱即用的脚本,除了一个help脚本,其他的需要开发者根据自己的需求去开发。

help脚本用法

help 脚本提供了两挑命令:

  • !help <script>:查看脚本帮助信息,当命令不带脚本名称时会列出所有脚本帮助信息,带脚本名称只列出此脚本的帮助信息
  • !ruleset <script>:查看已经注册的脚本规则集,使用方法同上一个方法

编写脚本

在框架下的 scripts 文件夹下有复杂应用案例,以下为脚本的简答介绍

hello world

package main

import "github.com/ghaoo/rboot"

func init() {
   // 注册脚本
   rboot.RegisterScripts(`hello`, rboot.Script{
      // 脚本处理函数
      Action: func(bot *rboot.Robot, incoming *rboot.Message) []*rboot.Message {
         return rboot.NewMessages("Hello World!")
      },
      Ruleset:     map[string]string{`hello`: `^hello`}, // 脚本规则集
      Usage:       "hello`: say hello world",
      Description: `example 'Hello World' script for rboot`,
   })
}

这就是一个简单的 hello world 脚本,在我们安装中创建的项目下创建一个 hello.go 文件,并将上面的代码复制进去,重新编译运行,输入 hello 试试看。

脚本剖析

rboot.RegisterScripts
RegisterScripts 方法是用来注册脚本的,它需要两个参数,脚本名称和一个包含脚本信息的rboot.Script

rboot.Script
Script定义了一个完整的脚本结构,具体如下:

type Script struct {
   Action      SetupFunc         // 脚本解析函数
   Ruleset     map[string]string // 脚本规则集合
   Usage       string            // 脚本帮助信息
   Description string            // 脚本简介
}

Ruleset

脚本规则集合,规则匹配器支持脚本包含多条匹配规则,一个脚本可以定义一系列规则,我们可以把一个脚本扩展成一类功能的脚本集。

SetupFunc

SetupFunc 是脚本的解析函数,它有两个参数,Robot实体*Robot 和 传入消息(incoming)*Message,输出为 []*Message,在此方法里,我们可以利用Robot实体和传入消息实现我们想要的功能。

输出消息为 []*Message,方便一次发送多条消息。

在消息转接器将消息(Incoming Message)发送给机器人,并经过规则匹配器找到匹配的脚本后,机器人会把消息发送给脚本处理函数,并将脚本的规则名称正则匹配参数一并通过Header附加到消息中。

规则名称正则匹配参数的获取方法为:

...
...
func setup(bot *rboot.Robot, in *rboot.Message) []*rboot.Message {
   rule := in.Header.Get("rule") // 规则名称
   args := in.Header["args"]     // 正则匹配参数
   ...
   ...
}

Usage:脚本的使用说明
Description:脚本简介

发送消息

发送消息除了在脚本函数中返回消息,也可以使用 SendTextOutgoing 方法

使用方法:

// SendText 为发送文本消息,需指定接收人
bot.SendText("Hello World!", "zhangsan")

// Outgoing 为发送消息结构体
msg := &rboot.Message{...}
bot.Outgoing(msg)
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,236评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,867评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,715评论 0 340
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,899评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,895评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,733评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,085评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,722评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,025评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,696评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,816评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,447评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,057评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,254评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,204评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,561评论 2 343

推荐阅读更多精彩内容