• 属性参数
    • 属性检查器相关参数
    • 序列化相关参数
    • 其它参数

    属性参数

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

    属性检查器相关参数

    参数名说明类型默认值备注
    type限定属性的数据类型(Any)undefined
    visible在 属性检视器 面板中显示或隐藏boolean(注1)
    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
    formerlySerializedAs指定之前序列化所用的字段名stringundefined重命名属性时，声明这个参数来兼容之前序列化的数据
    editorOnly在导出项目前剔除该属性booleanfalse

    其它参数

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

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

    返回 脚本开发。