CocosCreator脚本中editor参数的含义

谁借莪１个温暖的怀抱￠ 2022-05-28 12:35 1006阅读 0赞

**本文摘录自** [CocosCreator官方文档][CocosCreator]

editor常常结合requireComponent参数使用，主要用来指定当前组件的依赖组件。

# editor 参数 #

editor 只能定义在 cc.Component 的子类里。

cc.Class({
      extends: cc.Component,
    
      editor: {
    
        // 允许当前组件在编辑器模式下运行。
        // 默认情况下，所有组件都只会在运行时执行，也就是说它们的生命周期回调在编辑器模式下并不会触发。
        //
        // 值类型：Boolean
        // 默认值：false
        executeInEditMode: false,
    
        // requireComponent 参数用来指定当前组件的依赖组件。
        // 当组件添加到节点上时，如果依赖的组件不存在，引擎将会自动将依赖组件添加到同一个节点，防止脚本出错。
        // 该选项在运行时同样有效。
        // 
        // 值类型：Function （必须是继承自 cc.Component 的构造函数，如 cc.Sprite）
        // 默认值：null
        requireComponent: null,
    
        // 脚本生命周期回调的执行优先级。
        // 小于 0 的脚本将优先执行，大于 0 的脚本将最后执行。
        // 该优先级只对 onLoad, onEnable, start, update 和 lateUpdate 有效，对 onDisable 和 onDestroy 无效。
        //
        // 值类型：Number
        // 默认值：0
        executionOrder: 0,
    
        // 当本组件添加到节点上后，禁止同类型（含子类）的组件再添加到同一个节点，
        // 防止逻辑发生冲突。
        // 
        // 值类型：Boolean
        // 默认值：false
        disallowMultiple: false,
    
        // menu 用来将当前组件添加到组件菜单中，方便用户查找。
        // 
        // 值类型：String （如 "Rendering/Camera"）
        // 默认值：""
        menu: "",
    
        // 当设置了 "executeInEditMode" 以后，playOnFocus 可以用来设定选中当前组件所在的节点时，
        // 编辑器的场景刷新频率。
        // playOnFocus 如果设置为 true，场景渲染将保持 60 FPS，如果为 false，场景就只会在必要的时候进行重绘。
        // 
        // 值类型：Boolean
        // 默认值：false
        playOnFocus: false,
    
        // 自定义当前组件在 **属性检查器** 中渲染时所用的网页 url。
        // 
        // 值类型：String
        // 默认值：""
        inspector: "",
    
        // 自定义当前组件在编辑器中显示的图标 url。
        // 
        // 值类型：String
        // 默认值：""
        icon: "",
    
        // 指定当前组件的帮助文档的 url，设置过后，在 **属性检查器** 中就会出现一个帮助图标，
        // 用户点击将打开指定的网页。
        // 
        // 值类型：String
        // 默认值：""
        help: "",
      }
    });

[CocosCreator]: http://docs.cocos.com/creator/manual/zh/scripting/reference/class.html