积木设计规范

1. 积木分类的设计规范

1.1 积木分类

积木分类是指将相同类型的积木块放在同一个合集下面,形成一个类别。

目前,积木分成三类:输入类积木、输出类积木、其他类型积木。

  1   输入类积木

指传感器类信息输入、或者数值、侦测类的功能积木块。

如 “麦克风响度”。

  2   输出类积木

指将执行器类信息或者动力输出类积木。

如 “前进以动力(50)%(1)秒”

  3   其他类积木

指无法分辨,或符合性较高的积木块,如 WiFi 等。

如 “识别(汉语)语音(3)秒钟”。

1.2 积木块推荐色

在 mBlock 中,许多用户通过颜色辨别和寻找对应的积木块,因此将不同类型的积木统一成一致的颜色是非常有必要的。

我们在扩展设计器中给出了推荐的积木分类的色值,若无特殊情况请在推荐色系中选择积木分类的颜色。

1.3 分类图标

图标格式:

  • 格式:SVG
  • 尺寸:100*100
  • 底色:透明底
  • 颜色:彩色图标

分类图标所使用颜色需要与所对应的积木块颜色保持一致。

1.4 积木图标

图标格式:

  • 格式:SVG
  • 尺寸:100*100
  • 底色:透明底
  • 颜色:白色

积木图标的设计原则

积木图标在积木块中的意义在于:

  • 替代积木块中的主语,短化积木块的长度,方便阅读;
  • 表明积木块所属的设备或扩展,方便用户寻找对应的积木块;

1.5 积木分类名称

积木分类名称建议在6字以内。


2. 积木的设计规范

2.1 积木块描述规范

标点符号、空格的规范

建议参照 Scratch 3.0 的中文积木情况,建立如下标点规范。

  1. x、y、z 轴如无意外,一律小写
  2. :() 使用英文输入法输入
  3. 中英文混排时,使用空格
  4. 积木块主语与其他中英文之间留出空隙
  5. 数字与中文之间不用空格

() 内备注使用说明规范

在建议规范下,建议使用(),对如下内容进行备注。

不再对返回值范围进行标准。

通过积木文档告知用户,仅标注单位。

对返回值的单位进行备注。

2.2 积木块参数的处理方式

考虑到 Scratch 尽可能少报错的原则,以及客观上硬件积木涉及 Python 的转码,建议规范如下:

  • 对输入参数进行强制的类型转换,使其变为能够被积木块接受的值。其中浮点转换成整数遵循四舍五入的原则。
  • 输入参数缺省的,或是强制转换后的参数值仍不能被积木块接受的,该积木块不执行。
  • 转换完后值的大小,高于上限的取上限,低于下限取下限。

下面举例讨论三种情况:整数类型、浮点类型、字符串类型。

整数类型

  • RGB灯序号:参数范围为整数的积木块

  • 整数会被正常地执行,低于下限取下限,高于上限取上限

  • 浮点数会被四舍五入为整数后执行

  • 字符串会检测是否”长的像数字“,长的像的会被转换成整数,长的不像的积木块不执行

浮点类型

  • 蜂鸣器节拍数:参数范围为0以上的整数。

  • 整数会被当做浮点数执行

  • 浮点数正常执行

  • 字符串会检测是否”长的像数字“,长的像的会被转换成数值,长的不像的积木块不执行

字符串

所有类型都可以被转换成字符串并执行。

results matching ""

    No results matching ""