Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPropertyOptions

CCClass property options

Hierarchy

  • IExposedAttributes
    • IPropertyOptions

Index

Properties

Optional __noImplicit

__noImplicit: undefined | false | true

注意:这是一个内部选项。 此选项是为了在 @property 的基础上精确实现 @serializable@editable以及所有新增的独立装饰器的行为。

当此字段为 true 时。以下规则将不再生效:

  • 只要 @property 未显式指定选项 .serializable === false,就开启序列化;
  • 只要 @property 未显式指定选项 .visible === false 且目标属性的名称不以下划线开头,就开启编辑器交互。 反之,由以下规则取代:
  • 当且仅当 @property 显式指定了 .serializable === true 时才开启序列化;
  • 当且仅当 @property 显式指定了 .visible === true 时才开启编辑器交互。

Optional animatable

animatable: undefined | false | true

Optional displayName

displayName: undefined | string

该属性在编辑器中的显示名称。

Optional displayOrder

displayOrder: undefined | number

Optional editorOnly

editorOnly: undefined | false | true

该属性是否仅仅在编辑器环境中生效。

Optional formerlySerializedAs

formerlySerializedAs: undefined | string

该属性的曾用名。

Optional max

max: undefined | number

当该属性为数值类型时,指定了该属性允许的最大值。

Optional min

min: undefined | number

当该属性为数值类型时,指定了该属性允许的最小值。

Optional multiline

multiline: undefined | false | true

Optional override

override: undefined | false | true

是否覆盖基类中的同名属性。

Optional radian

radian: undefined | false | true

转换为弧度

Optional range

range: number[]

当该属性为数值类型时,指定了该属性允许的范围。

Optional readonly

readonly: undefined | false | true

指定该属性是否为可读的。

Optional serializable

serializable: undefined | false | true

该属性是否参与序列化和反序列化。

Optional slide

slide: undefined | false | true

当该属性为数值类型时,是否在编辑器中提供滑动条来调节值。

Optional step

step: undefined | number

当该属性为数值类型时并在编辑器中提供了滑动条时,指定了滑动条的步长。

Optional tooltip

tooltip: undefined | string

该属性在编辑器中的工具提示内容。

Optional type

type: any

指定属性的类型。

Optional unit

unit: undefined | string

Optional url

url: undefined | string

Optional visible

visible: boolean | (() => boolean)

控制是否在编辑器中显示该属性。

Generated using TypeDoc