属性参数

属性参数用来给已定义的属性附加元数据,类似于脚本语言的 Decorator 或者 C# 的 Attribute。

属性检查器相关参数

参数名说明类型默认值备注
type限定属性的数据类型(Any)undefined详见 type 参数
visible属性检查器 面板中显示或隐藏boolean(注1)详见 visible 参数
displayName属性检查器 面板中显示为另一个名字stringundefined-
tooltip属性检查器 面板中添加属性的 Tooltipstringundefined-
multiline属性检查器 面板中使用多行文本框booleanfalse-
readonly属性检查器 面板中只读booleanfalse-
min限定数值在编辑器中输入的最小值numberundefined-
max限定数值在编辑器中输入的最大值numberundefined-
step指定数值在编辑器中调节的步长numberundefined-
range一次性设置 min、max、step[min, max, step]undefinedstep 值可选
slide属性检查器 面板中显示为滑动条booleanfalse-

序列化相关参数

以下参数不能用于 get 方法:

参数名说明类型默认值备注
serializable序列化该属性booleantrue详见 serializable 参数
formerlySerializedAs指定之前序列化所用的字段名stringundefined重命名属性时,声明这个参数来兼容之前序列化的数据
editorOnly在导出项目前剔除该属性booleanfalse-

其它参数

参数名说明类型默认值备注
default定义属性的默认值(Any)undefined详见 default 参数
notify当属性被赋值时触发指定方法function (oldValue) {}undefined需要定义 default 属性并且不能用于数组
不支持 ES6 定义方式
override当重写父类属性时需要定义该参数为 truebooleanfalse详见 override 参数
animatable该属性是否能被动画编辑器修改booleanundefined-

注 1:visible 的默认值取决于属性名。当属性名以下划线 _ 开头时,默认隐藏,否则默认显示。