Module ECS

The module ecs is exposed by the sdk via @dcl/sdk/ecs

It defines the engine, components & systems for the SDK 7.

Example

import { engine, Transform } from '@dcl/sdk/ecs'
const entity = engine.addEntity()
Transform.create(entity, defaultPosition)

Index

Functions

Engine areConnected createEntityContainer createInputSystem createPointerEventsSystem createTimers createTweenSystem cyclicParentingChecker executeTask getComponentEntityTree getCompositeRootComponent getDefaultOpts getEntitiesWithParent getGlobal getWorldPosition getWorldRotation isEqual removeEntityWithChildren setGlobalPolyfill

Variables

Animator AssetLoad AssetLoadLoadingState AudioEvent AudioSource AudioStream AvatarAttach AvatarBase AvatarEmoteCommand AvatarEquippedData AvatarLocomotionSettings AvatarModifierArea AvatarMovement AvatarMovementInfo AvatarShape Billboard CRDT_MESSAGE_HEADER_LENGTH CameraLayer CameraLayers CameraMode CameraModeArea EngineInfo GlobalLight GltfContainer GltfContainerLoadingState GltfNode GltfNodeModifiers GltfNodeState InputModifier LightSource MainCamera Material MeshCollider MeshRenderer Name NetworkEntity NetworkParent NftShape PlayerIdentityData PointerEvents PointerEventsResult PointerLock PrimaryPointerInfo RESERVED_STATIC_ENTITIES Raycast RaycastResult RealmInfo SYSTEMS_REGULAR_PRIORITY SkyboxTime SyncComponents Tags TextShape TextureCamera Transform TriggerArea TriggerAreaResult Tween TweenSequence TweenState UiBackground UiCanvas UiCanvasInformation UiDropdown UiDropdownResult UiInput UiInputResult UiScrollResult UiText UiTransform VideoEvent VideoPlayer VirtualCamera VisibilityComponent assetLoadLoadingStateSystem componentDefinitionByName engine inputSystem pointerEventsSystem raycastSystem timers triggerAreaEventsSystem tweenSystem videoEventsSystem

Interfaces

AnimatorComponentDefinitionExtended AssetLoadLoadingStateSystem AudioSourceComponentDefinitionExtended AudioStreamComponentDefinitionExtended AvatarMovementSettings AvatarTexture BaseComponent BorderRect ByteBuffer CameraTransition CameraTransitionHelper CinematicSettings ComponentData CompositeComponent CompositeComponent_DataEntry CompositeDefinition FlatMaterial FlatTexture GrowOnlyValueSetComponentDefinition IEngine IEngineOptions INetowrkEntityType INetowrkParentType ISchema ISyncComponentsType InputModifierComponentDefinitionExtended InputModifierHelper LastWriteWinElementSetComponentDefinition LightSourceComponentDefinitionExtended LightSourceHelper MapComponentDefinition MaterialComponentDefinitionExtended MeshColliderComponentDefinitionExtended MeshRendererComponentDefinitionExtended Move MoveContinuous NameType Orthographic PBAnimationState PBAnimator PBAssetLoad PBAssetLoadLoadingState PBAudioEvent PBAudioSource PBAudioStream PBAvatarAttach PBAvatarBase PBAvatarEmoteCommand PBAvatarEquippedData PBAvatarLocomotionSettings PBAvatarModifierArea PBAvatarMovement PBAvatarMovementInfo PBAvatarShape PBBillboard PBCameraLayer PBCameraLayers PBCameraMode PBCameraModeArea PBColor3 PBColor4 PBEngineInfo PBGlobalLight PBGltfContainer PBGltfContainerLoadingState PBGltfNode PBGltfNodeModifiers PBGltfNodeModifiers_GltfNodeModifier PBGltfNodeState PBInputModifier PBInputModifier_StandardInput PBLightSource PBLightSource_Point PBLightSource_Spot PBMainCamera PBMaterial PBMaterial_GltfMaterial PBMaterial_PbrMaterial PBMaterial_UnlitMaterial PBMeshCollider PBMeshCollider_BoxMesh PBMeshCollider_CylinderMesh PBMeshCollider_GltfMesh PBMeshCollider_PlaneMesh PBMeshCollider_SphereMesh PBMeshRenderer PBMeshRenderer_BoxMesh PBMeshRenderer_CylinderMesh PBMeshRenderer_GltfMesh PBMeshRenderer_PlaneMesh PBMeshRenderer_SphereMesh PBNftShape PBPlayerIdentityData PBPointerEvents PBPointerEventsResult PBPointerEvents_Entry PBPointerEvents_Info PBPointerLock PBPosition PBPrimaryPointerInfo PBQuaternion PBRaycast PBRaycastResult PBRealmInfo PBSkyboxTime PBTextShape PBTextureCamera PBTriggerArea PBTriggerAreaResult PBTriggerAreaResult_Trigger PBTween PBTweenSequence PBTweenState PBUiBackground PBUiCanvas PBUiCanvasInformation PBUiDropdown PBUiDropdownResult PBUiInput PBUiInputResult PBUiScrollResult PBUiText PBUiTransform PBVector2 PBVector3 PBVideoEvent PBVideoPlayer PBVirtualCamera PBVisibilityComponent Perspective PointerEventsSystem RaycastHit RaycastSystem ReadonlyFlatMaterial ReadonlyFlatTexture Rect Rotate RotateContinuous Scale ScrollPositionValue Spec TagsComponentDefinitionExtended TagsType Texture TextureHelper TextureMove TextureMoveContinuous TextureUnion TransformComponentExtended TriggerAreaComponentDefinitionExtended TriggerAreaEventsSystem TweenComponentDefinitionExtended TweenHelper UiCanvasTexture VideoEventsSystem VideoTexture VirtualCameraComponentDefinitionExtended

Type Aliases

AppendValueMessage AppendValueMessageBody AssetLoadLoadingStateSystemCallback AvatarEquippedDataComponentDefinitionExtended AvatarEquippedDataType AvatarShapeComponentDefinitionExtended AvatarShapeType Color3Type Color4Type ComponentDefinition Composite CompositeProvider CompositeResource CompositeRootType ConflictResolutionMessage Coords CrdtMessage CrdtMessageBody CrdtMessageHeader CrdtNetworkMessageBody DeepReadonly DeepReadonlyMap DeepReadonlyObject DeepReadonlySet DeleteComponentMessage DeleteComponentMessageBody DeleteComponentNetworkMessage DeleteComponentNetworkMessageBody DeleteEntityMessage DeleteEntityMessageBody DeleteEntityNetworkMessage DeleteEntityNetworkMessageBody Entity EventSystemCallback EventSystemOptions EventSystemOptionsCallback ExcludeUndefined GSetComponentGetter GlobalDirectionRaycastOptions GlobalDirectionRaycastSystemOptions GlobalTargetRaycastOptions GlobalTargetRaycastSystemOptions IEntityContainer IInputSystem INetowrkEntity INetowrkParent ISyncComponents IncludeUndefined InstanceCompositeOptions JsonArray JsonMap JsonPrimitive JsonSchemaExtended LocalDirectionRaycastOptions LocalDirectionRaycastSystemOptions LwwComponentGetter MapResult NameComponent OnChangeFunction OnlyNonUndefinedTypes OnlyOptionalUndefinedTypes PutComponentMessage PutComponentMessageBody PutNetworkComponentMessage PutNetworkComponentMessageBody QuaternionType RaycastSystemCallback RaycastSystemOptions ReadOnlyGrowOnlyValueSetComponentDefinition ReadOnlyLastWriteWinElementSetComponentDefinition ReadonlyComponentSchema ReadonlyPrimitive ReceiveMessage SystemFn SystemItem TargetEntityRaycastOptions TargetEntityRaycastSystemOptions Task TimerCallback TimerId Timers ToOptional TransformComponent TransformType TransformTypeWithOptionals Transport TransportMessage TriggerAreaEventSystemCallback TweenSystem Unpacked ValueSetOptions Vector3Type VideoEventsSystemCallback WorldTransformEngine uint32

Namespaces

AppendValueOperation AvatarMovementSettings AvatarTexture BorderRect CameraTransition CinematicSettings ComponentData Composite CompositeComponent CompositeComponent_DataEntry CompositeDefinition CrdtMessageProtocol DeleteComponent DeleteComponentNetwork DeleteEntity DeleteEntityNetwork EntityUtils Move MoveContinuous Orthographic PBAnimationState PBAnimator PBAssetLoad PBAssetLoadLoadingState PBAudioEvent PBAudioSource PBAudioStream PBAvatarAttach PBAvatarBase PBAvatarEmoteCommand PBAvatarEquippedData PBAvatarLocomotionSettings PBAvatarModifierArea PBAvatarMovement PBAvatarMovementInfo PBAvatarShape PBBillboard PBCameraLayer PBCameraLayers PBCameraMode PBCameraModeArea PBColor3 PBColor4 PBEngineInfo PBGlobalLight PBGltfContainer PBGltfContainerLoadingState PBGltfNode PBGltfNodeModifiers PBGltfNodeModifiers_GltfNodeModifier PBGltfNodeState PBInputModifier PBInputModifier_StandardInput PBLightSource PBLightSource_Point PBLightSource_Spot PBMainCamera PBMaterial PBMaterial_GltfMaterial PBMaterial_PbrMaterial PBMaterial_UnlitMaterial PBMeshCollider PBMeshCollider_BoxMesh PBMeshCollider_CylinderMesh PBMeshCollider_GltfMesh PBMeshCollider_PlaneMesh PBMeshCollider_SphereMesh PBMeshRenderer PBMeshRenderer_BoxMesh PBMeshRenderer_CylinderMesh PBMeshRenderer_GltfMesh PBMeshRenderer_PlaneMesh PBMeshRenderer_SphereMesh PBNftShape PBPlayerIdentityData PBPointerEvents PBPointerEventsResult PBPointerEvents_Entry PBPointerEvents_Info PBPointerLock PBPosition PBPrimaryPointerInfo PBQuaternion PBRaycast PBRaycastResult PBRealmInfo PBSkyboxTime PBTextShape PBTextureCamera PBTriggerArea PBTriggerAreaResult PBTriggerAreaResult_Trigger PBTween PBTweenSequence PBTweenState PBUiBackground PBUiCanvas PBUiCanvasInformation PBUiDropdown PBUiDropdownResult PBUiInput PBUiInputResult PBUiScrollResult PBUiText PBUiTransform PBVector2 PBVector3 PBVideoEvent PBVideoPlayer PBVirtualCamera PBVisibilityComponent Perspective PutComponentOperation PutNetworkComponentOperation RaycastHit Rect Rotate RotateContinuous Scale Schemas ScrollPositionValue Texture TextureMove TextureMoveContinuous TextureUnion UiCanvasTexture VideoTexture

Enumerations

AvatarAnchorPointType AvatarControlType AvatarModifierType BackgroundTextureMode BillboardMode CameraType ColliderLayer ComponentType CrdtMessageType EasingFunction EntityMappingMode EntityState Font GltfNodeStateValue InputAction LoadingState MaterialTransparencyMode MediaState NftFrameType PointerEventType PointerFilterMode PointerType ProcessMessageResultType RaycastQueryType RaycastShape ShowScrollBar TextAlignMode TextWrap TextureFilterMode TextureMovementType TextureWrapMode TransitionMode TriggerAreaEventType TriggerAreaMeshType TweenLoop TweenStateStatus VideoState YGAlign YGDisplay YGEdge YGFlexDirection YGJustify YGOverflow YGPositionType YGUnit YGWrap

Settings

Member Visibility

Theme