scratch 开发自定义插件

自定义插件需要两步:

  1. 登录ScratchX平台
  2. 加载自定义程序

第一步相对固定,打开网站地址为:http://scratchx.org/#scratch,选择“Load Experimental Extension”按钮,在右上角或者“More Blocks”模块下,如图

第二步是在弹窗中输入自己的脚本程序,程序语法按照Scratch的要求实现即可,包含三部分,其格式是固定的,框架如下:

  • 功能实现
  • 模块描述
  • 注册插件
(function(ext) {
    // 当插件退出时要做的事情
    ext._shutdown = function() {};

    // 状态描述,用于提示插件的错误信息,比如不支持浏览器及版本等
    ext._getStatus = function() {
        return {status: 2, msg: 'Ready'};
    };

    // 功能实现
    ext.my_first_block = function() {
        // 当模块运行时要执行的功能
    };

    // 模块描述
    var descriptor = {
        blocks: [
            // 模块类型, 模块名称, 对应方法名称,参数依次对应的默认值
            [' ', 'my first block', 'my_first_block'],
        ],
        menus:{
            my_first_menu:['one','two','three']
        },
        url:'https://github.com/zacSuo/ScratchSerial',
        displayName: 'suoxd123-s first scratch demo'
    };

    // 注册扩展插件
    ScratchExtensions.register('My first extension', descriptor, ext);
})({});

功能实现部分,只需要在对应的功能函数中实现程序即可,函数名称中就类似常规程序开发,函数前需要使用ext.来引用。

其中_shutdown 和_getStatus是两个默认要实现的方法,shutdown用于在插件退出时执行,空函数表示不执行任何功能,getStatus用于标志当前插件状态,有不同颜色在插件栏的右上角,共有三种状态,如下所示:

颜色 默认意义
0 红色 出现错误

1

黄色 等待
2 绿色 就绪

模块描述部分,整体使用descriptor作为json结构,其中blocks用于对应模块描述,需要特别说明的是模块类型,具体包含如下,每个模块参数使用%标记,其中分别使用%n表示数值,%s表示字符串,%m.列表名称表示列表:

模块类型及含义
类型名称 对应含义
‘ ’(空格) 实时执行的命令(等待执行完成)
‘w’ 异步执行的命令(不等待)
‘r’ 实时反馈
‘R’ 异步反馈
‘h’ 显示模型(异步,当执行时返回Bool型True)
‘b’ Bool型反馈,类似‘r’,不过仅返回‘True’、‘False’

其中,menus用于列表的定义,方便其它地方的调用;url用于点击“About [插件名称]”时跳转,displayName用于作为插件的显示名称,替换注册时候用的名称,没有这个参数会直接显示注册时候的名称。

注册插件部分,这个相对比较固定,按照对应格式把信息增加上即可。

欢迎感兴趣的朋友一起加QQ群交流学习。

猜你喜欢

转载自blog.csdn.net/suoxd123/article/details/84646749