Home > @gglib/ecs-components

ecs-components package

Classes

Class Description
BoundingVolumeComponent The BoundingVolumeComponent adds bounding capability to an entity
BruteForceCullVisitor
CameraComponent An abstract component that describes a camera
DistanceConstraint
FpsComponent
KeyboardComponent A component that listens for keyboard events
LightComponent Adds a light source capability to an entity
LimitScaleConstraint Constraints the scale of a transform in local space
LimitTranslationConstraint Constraints the translation of a transform in local or global space
LookAtConstraint
LoopComponent
MeshComponent A component that knows how to render a model
MeshPartComponent A component that knows how to render a mesh part
ModelComponent A component that knows how to render a model
MouseComponent A component that listens for mouse events and tracks mouse state
OccTree
OrthographicCameraComponent Adds orthographic camera capability to an entity
PerspectiveCameraComponent Adds perspective camera capability to an entity
QuadTree
RendererComponent
SceneryLinkComponent A component where others can register if they have something to contribute to scene rendering
SpatialCullVisitor
SpatialSystemComponent
SpriteComponent A component that knows how to render sprites
TimeComponent A component that tracks the elapsed game and real time between frames.
TouchComponent
TransformComponent Provides access to the position rotation and scale of an entity
Tween
TweenComponent Component that works off tween animations
WASDComponent
WebXRComponent

Functions

Function Description
createGame(options, tap) Creates a root entity and adds common components

Interfaces

Interface Description
CreateGameOptions Options for the createGame() function
CullVisitor
GameTime A named timer with a time scale factor
LightComponentOptions Constructor options for LightComponent
LimitScaleOptions Options for the LimitScaleConstraint
LimitTranslationOptions Options for the LimitTranslationConstraint
LoopComponentOptions Constructor options for the LoopComponent
OrthographicCameraOptions Constructor options for OrthographicCameraComponent
PerspectiveCameraOptions Constructor options for PerspectiveCameraComponent
RendererComponentOptions
SceneryCollectable
SceneryCollector
SpatialEntry
SpatialNode
SpatialQuery
SpatialSystem
SpatialSystemComponentOptions
SpriteComponentOptions Constructor and setup options for the SpriteComponent
SpriteSlice Slice offsets describing a 9-patch sprite
SpriteSourceOptions Structure that defines a sprite with its sprite sheet texture
TimeClock A timer object holding elapsed and accumulated time values
TimeComponentOptions Constructor options for TimeComponent
TransformComponentOptions Constructor options for TransformComponent
TweenOptions Constructor options for Tween
WASDComponentOptions

Type Aliases

Type Alias Description
MouseComponentOptions Constructor options for MouseComponent
TouchComponentOptions Constructor options for the TouchComponent
TweenEventName Tween event names