NovaECS - v1.0.11
    Preparing search index...

    Class World

    World manages all entities and components World管理所有实体和组件

    Index

    Constructors

    Properties

    frame: number = 1

    Current frame number (starts from 1); incremented by beginFrame() 当前帧号(从1开始);调用beginFrame()自增

    Accessors

    • get entityCount(): number

      Get total entity count 获取实体总数

      Returns number

    Methods

    • Enter iteration period (called by Query.forEach internally) 进入遍历期(Query.forEach内部调用)

      Returns void

    • Leave iteration period (called by Query.forEach internally) 离开遍历期(Query.forEach内部调用)

      Returns void

    • Convenience method: add component by constructor 便捷方法:通过构造函数添加组件

      Type Parameters

      Parameters

      Returns void

    • Add component to entity (convenience method) 向实体添加组件(便捷方法)

      Type Parameters

      • T

      Parameters

      Returns void

    • Add tag to entity 为实体添加标签

      Parameters

      • e: number
      • name: string

      Returns void

    • Get number of alive entities 获取存活实体数量

      Returns number

    • Begin new frame (call at start of main loop) 开始新帧(在主循环开始时调用)

      Returns void

    • Remove all tags from entity 移除实体的所有标签

      Parameters

      • e: number

      Returns void

    • Create new entity 创建新实体

      Parameters

      • enabled: boolean = true

      Returns number

    • Create tag mask for multiple tag names 为多个标签名称创建掩码

      Parameters

      • tagNames: string[]

      Returns TagBitSet

    • Debug method: list all component stores with their sizes 调试方法:列出所有组件存储及其大小

      Returns { size: number; typeId: number }[]

    • Destroy entity and remove all its components 销毁实体并移除其所有组件

      Parameters

      • e: number

      Returns void

    • Get current epoch/frame number for change tracking 获取当前时代/帧号用于变更追踪

      Returns number

    • Get all component type IDs that have active stores 获取所有有活动存储的组件类型ID

      Returns number[]

    • Get all alive entities 获取所有存活的实体

      Returns number[]

    • Get component from entity (convenience method) 从实体获取组件(便捷方法)

      Type Parameters

      • T

      Parameters

      Returns undefined | T

    • Get entities that have specific tag 获取具有特定标签的实体

      Parameters

      • name: string

      Returns number[]

    • Get all components with their type IDs for an entity 获取实体的所有组件及其类型ID

      Parameters

      • e: number

      Returns { component: unknown; typeId: number }[]

    • Get entity's tag bit set 获取实体的标签位集

      Parameters

      • e: number

      Returns undefined | TagBitSet

    • Get all tag names for an entity 获取实体的所有标签名称

      Parameters

      • e: number

      Returns string[]

    • Get a resource by key 通过键获取资源

      Type Parameters

      • T

      Parameters

      • key: new (...args: any[]) => T

      Returns undefined | T

    • Get entity signature (component bitset) 获取实体签名(组件位集)

      Parameters

      • e: number

      Returns Bitset

    • Get tag mask manager for bit operations 获取标签掩码管理器用于位操作

      Returns TagMaskManager

    • Check if entity has component (convenience method) 检查实体是否有组件(便捷方法)

      Type Parameters

      • T

      Parameters

      Returns boolean

    • Check if entity has tag 检查实体是否具有标签

      Parameters

      • e: number
      • name: string

      Returns boolean

    • Check if entity is alive 检查实体是否存活

      Parameters

      • entity: number

      Returns boolean

    • Check if entity is enabled 检查实体是否启用

      Parameters

      • entity: number

      Returns boolean

    • Manually mark component as changed - call after modifying component fields in systems 手动标记某组件"已被修改"——在系统里改了字段后调用

      Type Parameters

      • T

      Parameters

      Returns void

    • Register query for delta notifications 注册查询以接收增量通知

      Parameters

      Returns void

    • Remove component from entity (convenience method) 从实体移除组件(便捷方法)

      Type Parameters

      • T

      Parameters

      Returns void

    • Remove tag from entity 从实体移除标签

      Parameters

      • e: number
      • name: string

      Returns void

    • Set component data for entity (convenience method) 为实体设置组件数据(便捷方法)

      Type Parameters

      • T

      Parameters

      Returns void

    • Set entity enabled state 设置实体启用状态

      Parameters

      • entity: number
      • enabled: boolean

      Returns void

    • Set a resource by key 通过键设置资源

      Type Parameters

      • T

      Parameters

      • key: new (...args: any[]) => T
      • val: T

      Returns void

    • Unregister query from delta notifications 取消注册查询的增量通知

      Parameters

      Returns void