Class Entity

Entity

Export

Entity

Date

2023.12.27

Author

yisky

Hierarchy (view full)

EngineObject
- Entity

Constructors

constructor

new Entity(engine, options?): Entity
Parameters
- engine: Engine
- options: EntityOptions = {}
Returns Entity
Overrides EngineObject.constructor

Properties

`Readonly`engine

engine: Engine

`Readonly`guid

guid: string

The entity unique id

Memberof

Entity

name

name: string

The entity name

Memberof

Entity

`Readonly`transform

transform: Transform

The entity owned transform component.

Memberof

Entity

userData

userData: {
[key: string]: any;
}

The entity user data

Memberof

Entity

Accessors

activeInHierarchy

get activeInHierarchy(): boolean
Defines whether the entity is active in the Scene

Returns boolean
Memberof
Entity

activeSelf

get activeSelf(): boolean
The local active state of this entity.

Returns boolean
Memberof
Entity

children

get children(): Entity[]
All sub entities

Returns Entity[]
Memberof
Entity

isRoot

get isRoot(): boolean
Is a root entity

Returns boolean
Memberof
Entity

scene

get scene(): Scene
Scene to which the entity belongs

Returns Scene
Memberof
Entity

visible

set visible(value): void
Set the entity is visible.
Parameters
- value: boolean
Returns void
Memberof
Entity

Methods

addChild

addChild(child): void
Add a child to entity
Parameters
- child: Entity
  child entity
Returns void
Memberof
Entity

addComponent

addComponent<T, B>(type, options?): T
Add a component to the entity
Type Parameters
- T extends Component
- B extends ComponentOptions
Parameters
- type: ComponentCtor<T, B>
  component type
- Optionaloptions: B
  initialization options
Returns T
Memberof
Entity

createChild

createChild(options?): Entity
Create a child entity
Parameters
- options: EntityOptions = {}
  entity options
Returns Entity
Memberof
Entity

destroy

destroy(): void
Destroy the entity itself and all sub entities

Returns void
Memberof
Entity

dispose

dispose(): void
Clear subscribers

Returns void
Memberof
EventDispatcher

Inherited from EngineObject.dispose

emit

emit(event): void
Emit event
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void
Memberof
EventDispatcher

Inherited from EngineObject.emit

getAllComponents

getAllComponents(): Component[]
Get all components on the entity

Returns Component[]
Memberof
Entity

getComponent

getComponent<T, B>(type): T
Get a component from the entity
Type Parameters
- T extends Component
- B extends ComponentOptions
Parameters
- type: ComponentCtor<T, B>
  component type
Returns T
Memberof
Entity

getLocalBounds

getLocalBounds(target, recursive?): Box3
Get the entity local bounds
Parameters
- target: Box3
  output bounds
- Optionalrecursive: boolean = false
  whether to recursive children
Returns Box3
Memberof
Entity

getWorldBounds

getWorldBounds(target, recursive?): Box3
Get the entity world bounds
Parameters
- target: Box3
  output bounds
- Optionalrecursive: boolean = false
  whether to recursive children
Returns Box3
Memberof
Entity

hasComponent

hasComponent<T, B>(type): boolean
Determine whether the entity has a component of the type
Type Parameters
- T extends Component
- B extends ComponentOptions
Parameters
- type: ComponentCtor<T, B>
  component type
Returns boolean
Memberof
Entity

off

off(type, callback?): void
Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.
Parameters
- type: string
- Optionalcallback: SubscriberCallbackFn
  subscriber callback
Returns void
Memberof
EventDispatcher

Inherited from EngineObject.off

on

on(type, callback, options?): void
Subscribe a event
Parameters
- type: string
  event type
- callback: SubscriberCallbackFn
  callback functions
- Optionaloptions: {
  priority?: Priority;
  target?: any;
  } = {}
  options
  - Optionalpriority?: Priority
  - Optionaltarget?: any
Returns void
Memberof
EventDispatcher

Inherited from EngineObject.on

once

once(type, callback, options?): void
Subscribe a event, just emit once
Parameters
- type: string
- callback: SubscriberCallbackFn
  subscriber callback
- options: {
  priority?: Priority;
  target?: any;
  } = {}
  - Optionalpriority?: Priority
  - Optionaltarget?: any
Returns void
Memberof
EventDispatcher

Inherited from EngineObject.once

removeAllChildren

removeAllChildren(): void
Remove all children on the entity

Returns void
Memberof
Entity

removeAllComponents

removeAllComponents(): void
Remove all components on the entity

Returns void
Memberof
Entity

removeChild

removeChild(child): void
Remove a child from entity
Parameters
- child: Entity
Returns void
Memberof
Entity

removeComponent

removeComponent<T, B>(type): void
Remove a component from the entity
Type Parameters
- T extends Component
- B extends ComponentOptions
Parameters
- type: ComponentCtor<T, B>
  component type
Returns void
Memberof
Entity

removeFromParent

removeFromParent(): void
Remove the entity from parent

Returns void
Memberof
Entity

setActive

setActive(isActive): void
Activates/Deactivates the entity, depending on the given true or false value
Parameters
- isActive: boolean
  Activate or deactivate the object, where true activates the entity and false deactivates the entity
Returns void
Memberof
Entity

`Static`findByComponent

findByComponent<T, B>(root, type): Entity[]
Find entities by component
Type Parameters
- T extends Component
- B extends ComponentOptions
Parameters
- root: Entity
- type: ComponentCtor<T, B>
Returns Entity[]
Static
Memberof
Entity

`Static`findByCondition

findByCondition(root, condition): Entity[]
Find entities by condition
Parameters
- root: Entity
- condition: ((entity: Entity) => boolean)
  - - (entity): boolean
    - Parameters
      entity: Entity
      Returns boolean
Returns Entity[]
Static
Memberof
Entity

`Static`findByGUID

findByGUID(root, guid): Entity
Find entity by guid
Parameters
- root: Entity
- guid: string
Returns Entity
Static
Memberof
Entity

`Static`findByName

findByName(root, name): Entity[]
Find entities by name, there may be entities with the same name.
Parameters
- root: Entity
- name: string
Returns Entity[]
Static
Memberof
Entity

`Static`traverse

traverse(root, callback): void
Traverse entity
Parameters
- root: Entity
- callback: ((entity: Entity) => void)
  - - (entity): void
    - Parameters
      entity: Entity
      Returns void
Returns void
Static
Memberof
Entity