Function RegisterComponent

  • 注册组件

    使用

    Register Component

    在组件类定义上注册组件,配合扩展 ComponentMap 接口后可使用 Entity.getComponent 等方法。

    将同时使用

    Serializable

    进行注册为可序列化。

    See

    Serializable

    Type Parameters

    Parameters

    • component: {
          dependencies?: (keyof ComponentMap)[];
          menu?: string;
          menuOrder?: number;
          name: K;
          single?: boolean;
      }

      组件名称,默认使用类名称

      • Optional dependencies?: (keyof ComponentMap)[]

        所依赖的组件列表。当该组件被添加Entity上时,会补齐缺少的依赖组件。

      • Optional menu?: string

        组件菜单路径。

      • Optional menuOrder?: number

        组件菜单优先级(从低到高)。

      • name: K

        组件名称,默认构造函数名称。当组件重名时可以使用该参数进行取别名,并且在接口 ComponentMap 中相应调整。

      • Optional single?: boolean

        是否唯一,同类型组件只允许一个。

    Returns ((constructor: Constructor<ComponentMap[K]>) => void)

Generated using TypeDoc