属性参数
注意
属性参数用来给已定义的属性附加元数据,类似于脚本语言的 Decorator 或者 C# 的 Attribute
属性检查器相关参数
type
- 说明
限定属性的数据类型
- 类型
(Any)
- 默认值
undefined
visible
- 说明
在 属性检查器 面板中显示或隐藏
- 类型
boolean
- 默认值
true
displayName
- 说明
在 属性检查器 面板中显示为另一个名字
- 类型
string
- 默认值
undefined
readonly
- 说明
在 属性检查器 面板中只读
- 类型
boolean
- 默认值
false
tooltip
- 说明
在 属性检查器 面板中添加属性的 Tooltip
- 类型
string
- 默认值
undefined
min
- 说明
限定属性的最小值
- 类型
number
- 默认值
undefined
max
- 说明
限定属性的最大值
- 类型
number
- 默认值
undefined
step
- 说明
限定属性在 属性检查器 面板中显示的步长
- 类型
number
- 默认值
undefined
range
- 说明
一次性设置 min、max、step
- 类型
[min, max, step]
- 默认值
undefined
slide
- 说明
在 属性检查器 面板中显示为滑动条
- 类型
boolean
- 默认值
false
group
- 说明
在 属性检查器 面板中显示为分组,样式默认为 tab
- 类型
{ name } 或 { id, name, displayOrder, style }
- 默认值
undefined
序列化相关参数
以下参数不能用于 get 方法
参数名 | 说明 | 类型 | 默认 | 备注 |
---|---|---|---|---|
serializable | 序列化该属性 | boolean | true | 无 |
formerlySerializedAs | 指定之前序列化所用的字段名 | string | undefined | 重命名属性时,声明这个参数来兼容之前序列化的数据 |
editorOnly | 在导出项目前剔除该属性 | boolean | false | 无 |
其他参数
参数名 | 说明 | 类型 | 默认 | 备注 |
---|---|---|---|---|
override | 当重写父类属性时需要定义该参数为 true | boolean | false | 无 |
注意
注 1:visible 的默认值取决于属性名。当属性名以下划线 _ 开头时,默认隐藏,否则默认显示。