Skip to content

Components

acoox edited this page May 23, 2021 · 5 revisions

First see Entity Component System and Entities.

A component contains a piece of functionality that can be used across entities. Some examples include:

  • InputComponent: Creates user input events on the entity, to which other components can react.
  • RenderComponent: Renders the entity to the screen.
  • CombatComponent: Gives health and attack stats to an entity.
  • AITaskComponent: Runs AI tasks on an NPC such as enemies.
  • TerrainComponent: Renders the map terrain on the screen.

All components should extend from the base Component class.

Component Lifecycle

A component's lifecycle is the nearly same as the entity to which it is attached (See Entity Lifecycle). When an entity is created, updated, or disposed, then create(), update(), and dispose() are called on each component attached to that entity.

create() vs constructor

What should be put in a component's constructor, and what should go in the create() function?

The constructor will be called when you create the component to add it to an entity. This can be before all components have been added, and before the entity is added to the game world. create() does not get called until the entity is added to the world.

Basically: Only setting constructor parameters and some basic initialisation should be done in the constructor. Everything else, including calls to getComponent(), should wait until the create() call. If the order that you add components to an entity matters, you've done it wrong.

Disabling/Enabling Components

When an entity is disabled, its components are not updated. However, components can be independently enabled/disabled as well. By disabling one or more components while keeping the entity enabled, we can modify that entity's behaviour during gameplay.

Clone this wiki locally