Entity Components (From Engine Version 5.6)

Overview

The Entity Component system removes the need for CRYENGINE game code to expose and manage Entities within a scene. Furthermore, the system has been designed to provide a modular and an intuitive way for Developers to construct games, both at a system and at an Entity level.

The interaction model (within the Sandbox Editor) allows Developers to create empty (blank) Entity containers which in turn house the advanced game logic all wrapped into specific Components. Some examples of the Components are: Mesh, Lights, Constraints and even Character Controllers. With these types of Components users can develop prefabs that can be placed by Level Designers throughout a game for standardization.

The Components panel contains all of the available Components that can be applied to an Entity. This article details the individual settings for each of the Components.

When these Entity Components have been applied to an Entity, a new subsection appears in the Properties of that Entity:

It can be removed from the entity by clicking the button in the top-right corner and choosing Remove.

Transformation

Many of the components have a Transform setting. This allows their position and orientation to be offset from the entity they are attached to, while still following it.

SettingDescription
TranslationThe positional offset in relation to the entity - for example a value of 0,0,1 will mean an offset of one unit upwards (Z axis).
RotationThe rotation offset in relation to the entity.
ScaleThe scale offset in relation to the entity. The linking symbol locks the scaling so that the values are relative to each other. For e.g. a value of 1,2,3, scaled by 2x would result in 2,4,6. (if unlocked then the scaling cannot be guaranteed).

In This Section