dot big bang

Developer API
Menu

Class Component

All
  • Public
  • Public/Protected
  • All

Hierarchy

Index

Properties

Accessors

Properties

Readonly id

id: string

The 36-character identifier string of the Component. The id is unique within the Entity is belongs to. Currently, the same id may be used by another Component on a different Entity.

Readonly type

type: ComponentType

The type of the Component.

Accessors

entity

  • Gets the Entity the Component is part of. This throws an exception if the Component is not in an Entity. Use the isInEntity property to test for that.

    Returns Entity

game

  • Gets the Game the Component is part of (via the Entity it belongs to). This throws an exception if the Component is not in the game. Use the isInGame property to test for that.

    Returns Game<{ saveData: SaveData<any, any> }>

isInEntity

  • get isInEntity(): boolean

  • Returns true if the Component is part of an Entity.

    Returns boolean

isInGame

  • get isInGame(): boolean

  • Returns true if the Component is part of the Game (via the Entity it belongs to).

    Returns boolean