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 createTweenSystem cyclicParentingChecker executeTask getComponentEntityTree getCompositeRootComponent isEqual removeEntityWithChildren

Interfaces

AnimatorComponentDefinitionExtended AudioSourceComponentDefinitionExtended AudioStreamComponentDefinitionExtended AvatarTexture BaseComponent BorderRect ByteBuffer ComponentData CompositeComponent CompositeComponent_DataEntry CompositeDefinition GrowOnlyValueSetComponentDefinition IEngine IEngineOptions INetowrkEntityType INetowrkParentType ISchema ISyncComponentsType LastWriteWinElementSetComponentDefinition MapComponentDefinition MaterialComponentDefinitionExtended MeshColliderComponentDefinitionExtended MeshRendererComponentDefinitionExtended Move NameType PBAnimationState PBAnimator PBAudioEvent PBAudioSource PBAudioStream PBAvatarAttach PBAvatarBase PBAvatarEmoteCommand PBAvatarEquippedData PBAvatarModifierArea PBAvatarShape PBBillboard PBCameraMode PBCameraModeArea PBColor3 PBColor4 PBEngineInfo PBGltfContainer PBGltfContainerLoadingState PBMaterial PBMaterial_PbrMaterial PBMaterial_UnlitMaterial PBMeshCollider PBMeshCollider_BoxMesh PBMeshCollider_CylinderMesh PBMeshCollider_PlaneMesh PBMeshCollider_SphereMesh PBMeshRenderer PBMeshRenderer_BoxMesh PBMeshRenderer_CylinderMesh PBMeshRenderer_PlaneMesh PBMeshRenderer_SphereMesh PBNftShape PBPlayerIdentityData PBPointerEvents PBPointerEventsResult PBPointerEvents_Entry PBPointerEvents_Info PBPointerLock PBPosition PBQuaternion PBRaycast PBRaycastResult PBRealmInfo PBTextShape PBTween PBTweenSequence PBTweenState PBUiBackground PBUiCanvasInformation PBUiDropdown PBUiDropdownResult PBUiInput PBUiInputResult PBUiText PBUiTransform PBVector2 PBVector3 PBVideoEvent PBVideoPlayer PBVisibilityComponent PointerEventsSystem RaycastHit RaycastSystem Rect Rotate Scale Spec Texture TextureHelper TextureUnion TransformComponentExtended TweenComponentDefinitionExtended TweenHelper VideoEventsSystem VideoTexture

Type Aliases

AppendValueMessage AppendValueMessageBody 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 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 ToOptional TransformComponent TransformType TransformTypeWithOptionals Transport TransportMessage TweenSystem Unpacked ValueSetOptions Vector3Type VideoEventsSystemCallback uint32

Namespaces

AppendValueOperation AvatarTexture BorderRect ComponentData Composite CompositeComponent CompositeComponent_DataEntry CompositeDefinition CrdtMessageProtocol DeleteComponent DeleteComponentNetwork DeleteEntity DeleteEntityNetwork EntityUtils Move PBAnimationState PBAnimator PBAudioEvent PBAudioSource PBAudioStream PBAvatarAttach PBAvatarBase PBAvatarEmoteCommand PBAvatarEquippedData PBAvatarModifierArea PBAvatarShape PBBillboard PBCameraMode PBCameraModeArea PBColor3 PBColor4 PBEngineInfo PBGltfContainer PBGltfContainerLoadingState PBMaterial PBMaterial_PbrMaterial PBMaterial_UnlitMaterial PBMeshCollider PBMeshCollider_BoxMesh PBMeshCollider_CylinderMesh PBMeshCollider_PlaneMesh PBMeshCollider_SphereMesh PBMeshRenderer PBMeshRenderer_BoxMesh PBMeshRenderer_CylinderMesh PBMeshRenderer_PlaneMesh PBMeshRenderer_SphereMesh PBNftShape PBPlayerIdentityData PBPointerEvents PBPointerEventsResult PBPointerEvents_Entry PBPointerEvents_Info PBPointerLock PBPosition PBQuaternion PBRaycast PBRaycastResult PBRealmInfo PBTextShape PBTween PBTweenSequence PBTweenState PBUiBackground PBUiCanvasInformation PBUiDropdown PBUiDropdownResult PBUiInput PBUiInputResult PBUiText PBUiTransform PBVector2 PBVector3 PBVideoEvent PBVideoPlayer PBVisibilityComponent PutComponentOperation PutNetworkComponentOperation RaycastHit Rect Rotate Scale Schemas Texture TextureUnion VideoTexture