Overview

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.

General

SensorVolume

See this page for more information.

AI

AI Observer

The observer component registers the entity to VisionMap and makes it able to see other entities that are registered as 'Observables'.

Vision Map Type

Combination of flags to identify the type of the observer.

Vision

Configuration of the vision sensor with which the entity can observe the world.

Location

Location of the eye sensor (offset from pivot or bone position).

Vision Blocking

Types To Observe

Only entities that belong to these vision map types will be processed for sight.

Factions To Observe

Only entities that belong to these factions will be processed for sight.

Use Custom Filter

Whether the custom condition filter should be used (Schematyc 'ObserverCustomFilter' signal)

AI Observable

The observable component registers the entity to VisionMap and makes it able to be 'seen' by other entities that are registered as 'Observers'.

Vision Map Type

Combination of flags to identify the type of the observable.

Observable Locations

Positions (offset from the pivot or bones) that are checked for visibilty by Observers.

AI Listener

The Listener component registers the entity to AuditionMap and makes it able to perceive sound stimuli. The component is notified when any interesting stimuli is heard.

Factions To Listen To

Only sound stimuli whose source entities belong to these factions will be processed.

Listening Distance Scale

An optional scale that can be applied to increase or reduce the listening distance.

Ear Locations

A collection of locations that will determine if the entity is within hearing range of sound stimuli. Can also be used to cast rays to these locations to determine sound obstruction fall-offs and such.

Use Custom Filter

Whether the custom condition filter should be used (Schematyc 'ListenerCustomFilter' signal)

AI Navigation Markup Shape

The Navigation Markup Shape component is used to create markup shapes, allowing to 'mark' triangles in the NavMesh with various annotations (area types and flags). Annotations can be set in the Scripts/AI/Navigation.xml config file.

AI Navigation Agent

The Navigation Agent component gives the ability to navigate in space, finding paths to desired destinations, following them, and also trying to avoid collisions with other agents.

Movement

Collision Avoidance

Navigation Query Filter

AI Faction

The Faction component stores the faction of the entity. Factions and their relations are defined in the Faction Map (Scripts/AI/Factions.xml)

AI Cover User

The Cover User component works together with movement system and provides an ability to use covers for the entity. Covers are user designed objects (Cover Surface) placed in Sandbox.

AI Behavior Tree

Component providing ability to running a Behavior Tree on the entity. Behavior tree automatically starts after a game is started and stops after game ends.

Behavior Tree Name

Audio

Environment

Attach this to an Area (shape, box, solid, sphere, etc) to assign this environment to the Area.

Listener

Functions similar to a microphone; you listen to the world audio from a Listener position. The most prominent use is to attach it to cameras.

Trigger

Barebone Audio Trigger that handles Audio Triggers created in the Audio Controls Editor.

For more information about Play/Stop behavior, see this page.

Cameras

Camera

This represent a camera in the world from which the level can be rendered. Keep in mind that only one camera can be active at the same time.

Roomscale VR Camera

Expose a new Entity Component that allows for easily creating a Roomscale VR camera. This works quite simply, in that all the user has to do is drag the component into their Schematyc entity, and it'll activate by its own. Additionally, the component automates asynchronous camera injection, effectively retrieving the headset's coordinates as late as possible to avoid unnecessary lag.

Debug

Debug Draw

The Debug Draw component can be used to draw debug text; the text will be drawn at the world position of the parent entity. This component can be useful to mark or highlight specific entities in the world.

Effects

Decal

The Decal Component will project a texture onto geometry and terrain. A typical use case for a decal would be for example blood splashes.

Fog Volume

The Fog Volume Component adds an area of fog around the components position. This can be used to create local areas of fog instead of global fog through the environment editor.

Particle Emitter

The Particle Emitter Component can emit particles at the position of the parent entity.

Rain

This component is the only way to achieve rain in your level. It creates rain in a radius around the entity that you attach this components to.

Water Ripple

Allows to spawn ripples on water surfaces. It is especially useful for cutscenes when non-physicalized entities are moving through a body of water.

Geometry

Advanced Animations

The Advanced Animations Component can be used to play complex animation setups. This could be used for controlling the animation of player or npc in the game.

Alembic Mesh

The Alembic Mesh Component let's you add Geom Caches to the entity.

Animated Mesh

The Animated Mesh Component play animation for an animated mesh. This would normally be used for basic geometry with one simple animation like a fan.

Mesh

The Mesh Component adds static geometry to the entity which can be physicalized with a Rigid-body component.

Lights

Environment Probe

With the Environment Probes Components you have the ability to place cubemaps throughout the level. It is very useful especially with reflective materials because it will automatically assign the cubemap to anything within its radius.

Point Light

The Point Light adds a light source to the entity which emits light in all directions, it behaves light a light bulb in the real world.

Projector Light

The Projector Light Component adds a light to entity which projects/emits light in a certain direction based on projection texture. Typical used for a flashlight as an example.

Physics

Area

Creates a physical area with a primitive shape with custom gravity/buoyancy settings.

Shape Properties

Buoyancy Parameters

Box Collider

Adds a physical box part to the physics only (without any StatObj). It still uses an entity slot.

Capsule Collider

Adds a physical capsule part to the physics only (without any StatObj). It still uses an entity slot.

Character Controller

Creates living entity (PE_LIVING) physics for the entity. As an alternative, consider using Sample Rigidbody Actor.

Maximum Climb Angle

Cylinder Collider

Adds a physical cylinder part to the physics only (without any StatObj). It still uses an entity slot.

RigidBody

Physicalizes the entity as a rigidbody or a static (depending on the type). Adds mesh components and primitive collider components as parts. Note that those components alone will not physicalize the entity, they can only add parts to an entity that is physicalized through other means, such as RigidBody component.

Buoyancy Parameters

Sample Rigidbody Actor

Physicalizes the entity as PE_WALKING_RIGID, which is a suggested replacement for PE_LIVING. It has the same sweep-based main geometry movement, customizable set of ground sampling rays (as opposed to PE_LIVING fixed one at the center), and it's derived from PE_RIGID, meaning that it can seamlessly interact with other physicalized objects (the original PE_LIVINGs are simulated independently from normal physicalized objects, and thus their interactions are not as immediate and responsive). It naturally uses all geometries that were added to the entity, same as a RigidBody would (cgf's, physical colliders).

Sphere Collider

Adds a physical sphere part to the physics only (without any StatObj). It still uses an entity slot.

Thruster

A simple component that can accelerate the entity by applying constant impulse per frame (which generates a force that accelerates the entity).

VR Interaction

Creates physicalized hand objects and allows holding other physicalized objects with VR controllers by physically constraining them to "hands".

Vehicle Physics

Physicalizes the entity as PE_WHEELEDVEHICLE (a rigidbody-derived wheeled vehicle)

Engine Parameters

Gear Parameters

Gears (1, 2, 3, etc)

Wheel Collider

Adds a cylindrical wheel geometry with a suspension to the vehicle. The top of the suspension spring is the component's origin.

Physics Constraint

Internal Breakable Joint

Creates an internal breakable joint between physical entity parts. A joint can either connect two parts, or one part to the 'ground' (connecting parts are determined automatically by checking intersections). When the entity receives impulses (from collisions or other sources), it recomputes internal forces between joints and breaks the ones that have their limits breached. Broken joints can optionally create a dynamic constraint between broken parts instead of fully disconnecting them. If the limit that broke was twist, it creates a 'hinge' (1 DOF) constraint around the joint's z axis, otherwise a bend constraint (2 DOF).

Parts that separate from the main entity are always physicalized as rigid entities (PE_RIGID).

Dynamic Constraint

Line Constraint

Constrains entity movement to a line, relative to another entity. The other entity is passed to the ConstrainToEntity function, or it can be 'the world' if ConstrainToPoint is used. Rotation can optionally be fully disabled as well.

Plane Constraint

Constrains entity movement to a plane, relative to another entity. The other entity is passed to ConstrainToEntity function, or it can be 'the world' if ConstrainToPoint is used. Rotation can optionally be limited as well.

Point Constraint

Creates a point-to-point constraint between 2 entities. The other entity is passed to ConstrainToEntity function, or it can be 'the world' if ConstrainToPoint is used. Rotation can be constrained in two dimensions: as rotation around the constraint axis and as bending of that axis on one entity's frame relative to it the other entity's frame.

Utilities

Child Entity

Spawns an entity of the specified class at the component's location when the child entity component instance is created.