Skip to main content

Components

Components encapsulate functionality that can be added to or removed from entities. For example, a component can enable an entity to play sound, render a 3D model, or execute scripts.

You can add components to entities using the OasisW editor or the engine API. The properties that a component exposes are listed in the inspector when the entity is selected.

Component Types

The OasisW engine has various components defined:

ComponentDescription
AnimSpecifies state graphs and animations that can be executed in the entity hierarchy.
Audio ListenerSpecifies the position of the listener for 3D audio playback.
ButtonCreates user interface buttons.
CameraRenders the scene from the location of the entity.
CollisionAssigns a collision volume to the entity.
ElementDefines user interface text or image elements.
Layout ChildOverrides default layout group properties for a single element.
Layout GroupAutomatically sets the position and scale of child user interface elements.
LightAttaches a dynamic light source to the entity.
Particle SystemAttaches a particle system to the entity.
Rigid BodyAdds the entity to the scene's physics simulation.
RenderRenders graphics primitives or render assets.
ScreenDefines the area and rendering of the user interface.
ScriptAllows the entity to run JavaScript fragments to implement custom behavior.
ScrollbarDefines a scrolling control for a Scrollview component.
Scroll ViewDefines a scrollable area in a user interface.
SoundPlays audio assets.
SpriteRenders 2D graphics at the location of the entity.

Deprecated Components

OasisW still provides some deprecated components. These components should not be used in new projects.

ComponentDescription
AnimationSpecifies animations that can be executed on the model specified by the entity's model component.
ModelRenders a 3D model at the location of the entity.