Module decorator

Declare the property as boolean

将该属性标记为布尔值。

Declare a standard ES6 or TS Class as a CCClass, please refer to the document

将标准写法的 ES6 或者 TS Class 声明为 CCClass，具体用法请参阅类型定义。

The class name used for serialization.

import { _decorator, Component } from 'cc';
const {ccclass} = _decorator;

// define a CCClass, omit the name
 @ccclass
class NewScript extends Component {
    // ...
}

// define a CCClass with a name
 @ccclass('LoginData')
class LoginData {
    // ...
}

Sets the property so that it does not interop with the animation parts in editor.

设置该属性不参与编辑器中动画相关的交互。

Forbid add multiple instances of the component to the same node.

防止多个相同类型（或子类型）的组件被添加到同一个节点。

import { _decorator, Component } from 'cc';
const {ccclass, disallowMultiple} = _decorator;

@ccclass
@disallowMultiple
class CameraCtrl extends Component {
    // ...
}

Sets the display name of the property in editor.

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

显示名称。

Sets the display order of the property in editor.

设置该属性在编辑器中的显示顺序。

显示顺序。

Enables the editor interoperability of the property.

允许该属性与编辑器交互。

Acts like emptyDecorator if called in form of @x; acts like emptyDecoratorFn if called in form of @x(...args).

当以 @x 形式调用时表现如同 emptyDecorator，当以 @x(...args) 形式调用时表现如同 emptyDecoratorFn。

Makes a CCClass that inherit from component execute in edit mode.
By default, all components are only executed in play mode,
which means they will not have their callback functions executed while the Editor is in edit mode.

允许继承自 Component 的 CCClass 在编辑器里执行。
默认情况下，所有 Component 都只会在运行时才会执行，也就是说它们的生命周期回调不会在编辑器里触发。

import { _decorator, Component } from 'cc';
const {ccclass, executeInEditMode} = _decorator;

 @ccclass
 @executeInEditMode
class NewScript extends Component {
    // ...
}

Set the component priority, it decides at which order the life cycle functions of components will be invoked. Smaller priority get invoked before larger priority. This will affect onLoad, onEnable, start, update and lateUpdate, but onDisable and onDestroy won't be affected.

设置脚本生命周期方法调用的优先级。优先级小于 0 的组件将会优先执行，优先级大于 0 的组件将会延后执行。优先级仅会影响 onLoad, onEnable, start, update 和 lateUpdate，而 onDisable 和 onDestroy 不受影响。

The execution order of life cycle methods for Component. Smaller priority get invoked before larger priority.

import { _decorator, Component } from 'cc';
const {ccclass, executionOrder} = _decorator;

@ccclass
@executionOrder(1)
class CameraCtrl extends Component {
    // ...
}

Declare the property as float

将该属性标记为浮点数。

Define the help documentation url, if given, the component section in the inspector will have a help documentation icon reference to the web page given.

指定当前组件的帮助文档的 url，设置过后，在 属性检查器 中就会出现一个帮助图标，用户点击将打开指定的网页。

The url of the help documentation

import { _decorator, Component } from 'cc';
const {ccclass, help} = _decorator;

@ccclass
@help("app://docs/html/components/spine.html")
class NewScript extends Component {
    // ...
}

Use a customized inspector page in the inspector

自定义当前组件在 属性检查器 中渲染时所用的 UI 页面描述。

The url of the page definition in js

import { _decorator, Component } from 'cc';
const {ccclass, inspector} = _decorator;

@ccclass
@inspector("packages://inspector/inspectors/comps/camera-ctrl.js")
class NewScript extends Component {
    // ...
}

Declare the property as integer

将该属性标记为整数。

Add the current component to the specific menu path in Add Component selector of the inspector panel

将当前组件添加到组件菜单中，方便用户查找。例如 "Rendering/CameraCtrl"。

The path is the menu represented like a pathname. For example the menu could be "Rendering/CameraCtrl".

import { _decorator, Component } from 'cc';
const {ccclass, menu} = _decorator;

@ccclass
@menu("Rendering/CameraCtrl")
class NewScript extends Component {
    // ...
}

Enable multi-line display of the property in editor.

允许在编辑器中对该属性进行多行显示。

When {{executeInEditMode}} is set, this decorator will decide when a node with the component is on focus whether the editor should running in high FPS mode.

当指定了 "executeInEditMode" 以后，playOnFocus 可以在选中当前组件所在的节点时，提高编辑器的场景刷新频率到 60 FPS，否则场景就只会在必要的时候进行重绘。

import { _decorator, Component } from 'cc';
const {ccclass, playOnFocus, executeInEditMode} = _decorator;

@ccclass
@executeInEditMode
@playOnFocus
class CameraCtrl extends Component {
    // ...
}

Sets to convert the value into radian before feed it to the property in editor.

设置在编辑器中赋值该属性前将值先转换为弧度制。

Sets the allowed range of the property in editor.

设置该属性在编辑器中允许设置的范围。

范围。

Sets the allowed max value of the property in editor.

设置该属性在编辑器中允许的最大值。

最大值。

Sets the allowed min value of the property in editor.

设置该属性在编辑器中允许的最小值。

最小值。

Sets the step of the property in editor.

设置该属性在编辑器中的步进值。

步进值。

Sets the property to be read only in editor.

设置该属性在编辑器中仅是可读的。

Declare that the current component relies on another type of component. If the required component doesn't exist, the engine will create a new empty instance of the required component and add to the node.

为声明为 CCClass 的组件添加依赖的其它组件。当组件添加到节点上时，如果依赖的组件不存在，引擎将会自动将依赖组件添加到同一个节点，防止脚本出错。该设置在运行时同样有效。

The required component type

import {_decorator, Sprite, Component} from cc;
import {ccclass, requireComponent} from _decorator;

@ccclass
@requireComponent(Sprite)
class SpriteCtrl extends Component {
    // ...
}

Enable a slider be given to coordinate the property in editor.

允许在编辑器中提供滑动条来调节值

Declare the property as string

将该属性标记为字符串。

Sets the tooltip content of the property in editor.

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

工具提示。

Sets the unit of the property in editor.

设置该属性在编辑器中的计量单位。

计量单位的名称。

Sets the condition to show the property.

设置在编辑器展示该属性的条件。

展示条件，当返回 true 时展示；否则不展示。