@dcl/ecs 7.0.0-3548419522.commit-ddcf4b7 → 7.0.0

package/README.md

@@ -9,11 +9,10 @@ Run `make build`
 ## Testing
 Run `make test`, you can also debug the test in VS code, selecting the launch `Jest current file` or just `Jest` (this will run all test)
 
-## Wishlist 
+## Wishlist
 Use this project as template for TypeScript libraries
 - [x] as any MutableGroupOf
 - [x] Tests for system
-- [ ] use @dcl/ecs-math https://github.com/decentraland/ecs-math
 - [ ] Basic Components ( Transform ) w/Tests
 - [ ] Sync Component W/Tests
 - [x] CRDT System
@@ -23,4 +22,4 @@ Use this project as template for TypeScript libraries
 - [ ] EntityID generator
 - [ ] Static vs Dynamic entities.
 - [ ] Sync Components ?
-- [ ] Where the state lives ? State cross realms/islands ? StateFull questions. StorableComponent ?
+- [ ] Where the state lives ? State cross realms/islands ? StateFull questions. StorableComponent ?

package/dist/components/extended/Animator.d.ts

@@ -0,0 +1,49 @@
+import { ComponentDefinition, Entity, IEngine, ISchema } from '../../engine';
+import { PBAnimationState, PBAnimator } from '../generated/pb/decentraland/sdk/components/animator.gen';
+/**
+ * @public
+ */
+export declare type AnimatorComponentDefinition = ComponentDefinition<ISchema<PBAnimator>, PBAnimator>;
+/**
+ * @public
+ */
+export interface AnimatorComponentDefinitionExtended extends AnimatorComponentDefinition {
+    /**
+     * @public
+     *
+     * Get a `mutable` version of animator clip
+     * @param entity - entity with Animator component
+     * @param name - the field `name` of the component
+     * @returns the clip or fails if it isn't found
+     */
+    getClip(entity: Entity, name: string): PBAnimationState;
+    /**
+     * @public
+     *
+     * Get a `mutable` version of animator clip
+     * @param entity - entity with Animator component
+     * @param name - the field `name` of the component
+     * @returns the clip or null if it isn't found
+     */
+    getClipOrNull(entity: Entity, name: string): PBAnimationState | null;
+    /**
+     * @public
+     *
+     * Set playing=true the animation `$name`
+     * @param entity - entity with Animator component
+     * @param name - animation name
+     * @param resetCursor - the animation starts at 0 or continues from the current cursor position
+     * @returns true in successful playing, false if it doesn't find the Animator or clip
+     */
+    playSingleAnimation(entity: Entity, name: string, resetCursor?: boolean): boolean;
+    /**
+     * @public
+     *
+     * Set playing=false all animations
+     * @param entity - entity with Animator component
+     * @param resetCursor - the animation stops at 0 or at the current cursor position
+     * @returns true in successful playing, false if it doesn't find the Animator
+     */
+    stopAllAnimations(entity: Entity, resetCursor?: boolean): boolean;
+}
+export declare function defineAnimatorComponent(engine: Pick<IEngine, 'defineComponentFromSchema'>): AnimatorComponentDefinitionExtended;

package/dist/components/extended/Animator.js

@@ -0,0 +1,58 @@
+import { Animator } from '../generated/index.gen';
+export function defineAnimatorComponent(engine) {
+    const theComponent = Animator(engine);
+    /**
+     * @returns The tuple [animator, clip]
+     */
+    function getClipAndAnimator(entity, name) {
+        const anim = theComponent.getMutableOrNull(entity);
+        if (!anim)
+            return [null, null];
+        const state = anim.states.find((item) => item.name === name || item.clip === name);
+        if (!state)
+            return [anim, null];
+        return [anim, state];
+    }
+    return {
+        ...theComponent,
+        getClipOrNull(entity, name) {
+            const [_, state] = getClipAndAnimator(entity, name);
+            return state;
+        },
+        getClip(entity, name) {
+            const [animator, state] = getClipAndAnimator(entity, name);
+            if (!animator) {
+                throw new Error(`There is no Animator found in the entity ${entity}`);
+            }
+            if (!state) {
+                throw new Error(`The Animator component of ${entity} has no the state ${name}`);
+            }
+            return state;
+        },
+        playSingleAnimation(entity, name, shouldReset = true) {
+            const [animator, state] = getClipAndAnimator(entity, name);
+            if (!animator || !state)
+                return false;
+            // Reset all other animations
+            for (const state of animator.states) {
+                state.playing = false;
+                state.shouldReset = true;
+            }
+            state.playing = true;
+            state.shouldReset = shouldReset;
+            return true;
+        },
+        stopAllAnimations(entity, resetCursor = true) {
+            // Get the mutable to modifying
+            const animator = theComponent.getMutableOrNull(entity);
+            if (!animator)
+                return false;
+            // Reset all other animations
+            for (const state of animator.states) {
+                state.playing = false;
+                state.shouldReset = resetCursor;
+            }
+            return true;
+        }
+    };
+}

package/dist/components/extended/Material.d.ts

@@ -0,0 +1,42 @@
+import { ComponentDefinition, Entity, IEngine, ISchema } from '../../engine';
+import { PBMaterial, PBMaterial_PbrMaterial, PBMaterial_UnlitMaterial } from '../generated/index.gen';
+import { AvatarTexture, Texture, TextureUnion } from '../generated/types.gen';
+/**
+ * @public
+ */
+export declare type MaterialComponentDefinition = ComponentDefinition<ISchema<PBMaterial>, PBMaterial>;
+/**
+ * @public
+ */
+export declare type TextureHelper = {
+    /**
+     * @returns a common texture with a source file
+     */
+    Common: (texture: Texture) => TextureUnion;
+    /**
+     * @returns the avatar texture of userId specified
+     */
+    Avatar: (avatarTexture: AvatarTexture) => TextureUnion;
+};
+/**
+ * @public
+ */
+export interface MaterialComponentDefinitionExtended extends MaterialComponentDefinition {
+    /**
+     * Texture helpers with constructor
+     */
+    Texture: TextureHelper;
+    /**
+     * Create or replace the component Material in the entity specified
+     * @param entity - the entity to link the component
+     * @param material - the Unlit data for this material
+     */
+    setBasicMaterial: (entity: Entity, material: PBMaterial_UnlitMaterial) => void;
+    /**
+     * Create or replace the component Material in the entity specified
+     * @param entity - the entity to link the component
+     * @param material - the PBR data for this material
+     */
+    setPbrMaterial: (entity: Entity, material: PBMaterial_PbrMaterial) => void;
+}
+export declare function defineMaterialComponent(engine: Pick<IEngine, 'defineComponentFromSchema'>): MaterialComponentDefinitionExtended;

package/dist/components/extended/Material.js

@@ -0,0 +1,42 @@
+import { Material } from '../generated/index.gen';
+const TextureHelper = {
+    Common(texture) {
+        return {
+            tex: {
+                $case: 'texture',
+                texture
+            }
+        };
+    },
+    Avatar(avatarTexture) {
+        return {
+            tex: {
+                $case: 'avatarTexture',
+                avatarTexture
+            }
+        };
+    }
+};
+export function defineMaterialComponent(engine) {
+    const theComponent = Material(engine);
+    return {
+        ...theComponent,
+        Texture: TextureHelper,
+        setBasicMaterial(entity, material) {
+            theComponent.createOrReplace(entity, {
+                material: {
+                    $case: 'unlit',
+                    unlit: material
+                }
+            });
+        },
+        setPbrMaterial(entity, material) {
+            theComponent.createOrReplace(entity, {
+                material: {
+                    $case: 'pbr',
+                    pbr: material
+                }
+            });
+        }
+    };
+}

package/dist/components/extended/MeshCollider.d.ts

@@ -0,0 +1,42 @@
+import { ComponentDefinition, Entity, IEngine, ISchema } from '../../engine';
+import { ColliderLayer, PBMeshCollider } from '../generated/index.gen';
+/**
+ * @public
+ */
+export declare type MeshColliderComponentDefinition = ComponentDefinition<ISchema<PBMeshCollider>, PBMeshCollider>;
+/**
+ * @public
+ */
+export interface MeshColliderComponentDefinitionExtended extends MeshColliderComponentDefinition {
+    /**
+     * @public
+     * Set a box in the MeshCollider component
+     * @param entity - entity to create or replace the MeshCollider component
+     * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
+     */
+    setBox(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
+    /**
+     * @public
+     * Set a plane in the MeshCollider component
+     * @param entity - entity to create or replace the MeshCollider component
+     * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
+     */
+    setPlane(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
+    /**
+     * @public
+     * Set a cylinder in the MeshCollider component
+     * @param entity - entity to create or replace the MeshCollider component
+     * @param radiusBottom - radius of bottom of cylinder
+     * @param radiusTop - radius of top of cylinder
+     * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
+     */
+    setCylinder(entity: Entity, radiusBottom?: number, radiusTop?: number, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
+    /**
+     * @public
+     * Set a sphere in the MeshCollider component
+     * @param entity - entity to create or replace the MeshCollider component
+     * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
+     */
+    setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
+}
+export declare function defineMeshColliderComponent(engine: Pick<IEngine, 'defineComponentFromSchema'>): MeshColliderComponentDefinitionExtended;

package/dist/components/extended/MeshCollider.js

@@ -0,0 +1,41 @@
+import { MeshCollider } from '../generated/index.gen';
+export function defineMeshColliderComponent(engine) {
+    const theComponent = MeshCollider(engine);
+    function getCollisionMask(layers) {
+        if (Array.isArray(layers)) {
+            return layers
+                .map((item) => item)
+                .reduce((prev, item) => prev | item, 0);
+        }
+        else if (layers) {
+            return layers;
+        }
+    }
+    return {
+        ...theComponent,
+        setBox(entity, colliderLayers) {
+            theComponent.createOrReplace(entity, {
+                mesh: { $case: 'box', box: {} },
+                collisionMask: getCollisionMask(colliderLayers)
+            });
+        },
+        setPlane(entity, colliderLayers) {
+            theComponent.createOrReplace(entity, {
+                mesh: { $case: 'plane', plane: {} },
+                collisionMask: getCollisionMask(colliderLayers)
+            });
+        },
+        setCylinder(entity, radiusBottom, radiusTop, colliderLayers) {
+            theComponent.createOrReplace(entity, {
+                mesh: { $case: 'cylinder', cylinder: { radiusBottom, radiusTop } },
+                collisionMask: getCollisionMask(colliderLayers)
+            });
+        },
+        setSphere(entity, colliderLayers) {
+            theComponent.createOrReplace(entity, {
+                mesh: { $case: 'sphere', sphere: {} },
+                collisionMask: getCollisionMask(colliderLayers)
+            });
+        }
+    };
+}

package/dist/components/extended/MeshRenderer.d.ts

@@ -0,0 +1,40 @@
+import { ComponentDefinition, Entity, IEngine, ISchema } from '../../engine';
+import { PBMeshRenderer } from '../generated/index.gen';
+/**
+ * @public
+ */
+export declare type MeshRendererComponentDefinition = ComponentDefinition<ISchema<PBMeshRenderer>, PBMeshRenderer>;
+/**
+ * @public
+ */
+export interface MeshRendererComponentDefinitionExtended extends MeshRendererComponentDefinition {
+    /**
+     * @public
+     * Set a box in the MeshRenderer component
+     * @param entity - entity to create or replace the MeshRenderer component
+     * @param uvs - uvs coord
+     */
+    setBox(entity: Entity, uvs?: number[]): void;
+    /**
+     * @public
+     * Set a plane in the MeshRenderer component
+     * @param entity - entity to create or replace the MeshRenderer component
+     * @param uvs - uvs coord
+     */
+    setPlane(entity: Entity, uvs?: number[]): void;
+    /**
+     * @public
+     * Set a cylinder in the MeshRenderer component
+     * @param entity - entity to create or replace the MeshRenderer component
+     * @param radiusBottom -
+     * @param radiusTop -
+     */
+    setCylinder(entity: Entity, radiusBottom?: number, radiusTop?: number): void;
+    /**
+     * @public
+     * Set a sphere in the MeshRenderer component
+     * @param entity - entity to create or replace the MeshRenderer component
+     */
+    setSphere(entity: Entity): void;
+}
+export declare function defineMeshRendererComponent(engine: Pick<IEngine, 'defineComponentFromSchema'>): MeshRendererComponentDefinitionExtended;

package/dist/components/extended/MeshRenderer.js

@@ -0,0 +1,27 @@
+import { MeshRenderer } from '../generated/index.gen';
+export function defineMeshRendererComponent(engine) {
+    const theComponent = MeshRenderer(engine);
+    return {
+        ...theComponent,
+        setBox(entity, uvs) {
+            theComponent.createOrReplace(entity, {
+                mesh: { $case: 'box', box: { uvs: uvs || [] } }
+            });
+        },
+        setPlane(entity, uvs) {
+            theComponent.createOrReplace(entity, {
+                mesh: { $case: 'plane', plane: { uvs: uvs || [] } }
+            });
+        },
+        setCylinder(entity, radiusBottom, radiusTop) {
+            theComponent.createOrReplace(entity, {
+                mesh: { $case: 'cylinder', cylinder: { radiusBottom, radiusTop } }
+            });
+        },
+        setSphere(entity) {
+            theComponent.createOrReplace(entity, {
+                mesh: { $case: 'sphere', sphere: {} }
+            });
+        }
+    };
+}

package/dist/components/generated/Animator.gen.d.ts

@@ -0,0 +1,8 @@
+import { ISchema } from '../../schemas/ISchema';
+import { PBAnimator } from './pb/decentraland/sdk/components/animator.gen';
+/**
+ *
+ */
+export declare const AnimatorSchema: ISchema<PBAnimator> & {
+    COMPONENT_ID: number;
+};

package/dist/components/generated/Animator.gen.js

@@ -0,0 +1,19 @@
+import { PBAnimator } from './pb/decentraland/sdk/components/animator.gen';
+/**
+ *
+ */
+export const AnimatorSchema = {
+    COMPONENT_ID: 1042,
+    serialize(value, builder) {
+        const writer = PBAnimator.encode(value);
+        const buffer = new Uint8Array(writer.finish(), 0, writer.len);
+        builder.writeBuffer(buffer, false);
+    },
+    deserialize(reader) {
+        return PBAnimator.decode(reader.buffer(), reader.remainingBytes());
+    },
+    create() {
+        // TODO: this is a hack.
+        return PBAnimator.decode(new Uint8Array());
+    }
+};

package/dist/components/generated/AudioSource.gen.d.ts

@@ -0,0 +1,8 @@
+import { ISchema } from '../../schemas/ISchema';
+import { PBAudioSource } from './pb/decentraland/sdk/components/audio_source.gen';
+/**
+ *
+ */
+export declare const AudioSourceSchema: ISchema<PBAudioSource> & {
+    COMPONENT_ID: number;
+};

package/dist/components/generated/AudioSource.gen.js

@@ -0,0 +1,19 @@
+import { PBAudioSource } from './pb/decentraland/sdk/components/audio_source.gen';
+/**
+ *
+ */
+export const AudioSourceSchema = {
+    COMPONENT_ID: 1020,
+    serialize(value, builder) {
+        const writer = PBAudioSource.encode(value);
+        const buffer = new Uint8Array(writer.finish(), 0, writer.len);
+        builder.writeBuffer(buffer, false);
+    },
+    deserialize(reader) {
+        return PBAudioSource.decode(reader.buffer(), reader.remainingBytes());
+    },
+    create() {
+        // TODO: this is a hack.
+        return PBAudioSource.decode(new Uint8Array());
+    }
+};

package/dist/components/generated/AudioStream.gen.d.ts

@@ -0,0 +1,8 @@
+import { ISchema } from '../../schemas/ISchema';
+import { PBAudioStream } from './pb/decentraland/sdk/components/audio_stream.gen';
+/**
+ *
+ */
+export declare const AudioStreamSchema: ISchema<PBAudioStream> & {
+    COMPONENT_ID: number;
+};

package/dist/components/generated/AudioStream.gen.js

@@ -0,0 +1,19 @@
+import { PBAudioStream } from './pb/decentraland/sdk/components/audio_stream.gen';
+/**
+ *
+ */
+export const AudioStreamSchema = {
+    COMPONENT_ID: 1021,
+    serialize(value, builder) {
+        const writer = PBAudioStream.encode(value);
+        const buffer = new Uint8Array(writer.finish(), 0, writer.len);
+        builder.writeBuffer(buffer, false);
+    },
+    deserialize(reader) {
+        return PBAudioStream.decode(reader.buffer(), reader.remainingBytes());
+    },
+    create() {
+        // TODO: this is a hack.
+        return PBAudioStream.decode(new Uint8Array());
+    }
+};

package/dist/components/generated/AvatarAttach.gen.d.ts

@@ -0,0 +1,8 @@
+import { ISchema } from '../../schemas/ISchema';
+import { PBAvatarAttach } from './pb/decentraland/sdk/components/avatar_attach.gen';
+/**
+ *
+ */
+export declare const AvatarAttachSchema: ISchema<PBAvatarAttach> & {
+    COMPONENT_ID: number;
+};

package/dist/components/generated/AvatarAttach.gen.js

@@ -0,0 +1,19 @@
+import { PBAvatarAttach } from './pb/decentraland/sdk/components/avatar_attach.gen';
+/**
+ *
+ */
+export const AvatarAttachSchema = {
+    COMPONENT_ID: 1073,
+    serialize(value, builder) {
+        const writer = PBAvatarAttach.encode(value);
+        const buffer = new Uint8Array(writer.finish(), 0, writer.len);
+        builder.writeBuffer(buffer, false);
+    },
+    deserialize(reader) {
+        return PBAvatarAttach.decode(reader.buffer(), reader.remainingBytes());
+    },
+    create() {
+        // TODO: this is a hack.
+        return PBAvatarAttach.decode(new Uint8Array());
+    }
+};

package/dist/components/generated/AvatarModifierArea.gen.d.ts

@@ -0,0 +1,8 @@
+import { ISchema } from '../../schemas/ISchema';
+import { PBAvatarModifierArea } from './pb/decentraland/sdk/components/avatar_modifier_area.gen';
+/**
+ *
+ */
+export declare const AvatarModifierAreaSchema: ISchema<PBAvatarModifierArea> & {
+    COMPONENT_ID: number;
+};

package/dist/components/generated/AvatarModifierArea.gen.js

@@ -0,0 +1,19 @@
+import { PBAvatarModifierArea } from './pb/decentraland/sdk/components/avatar_modifier_area.gen';
+/**
+ *
+ */
+export const AvatarModifierAreaSchema = {
+    COMPONENT_ID: 1070,
+    serialize(value, builder) {
+        const writer = PBAvatarModifierArea.encode(value);
+        const buffer = new Uint8Array(writer.finish(), 0, writer.len);
+        builder.writeBuffer(buffer, false);
+    },
+    deserialize(reader) {
+        return PBAvatarModifierArea.decode(reader.buffer(), reader.remainingBytes());
+    },
+    create() {
+        // TODO: this is a hack.
+        return PBAvatarModifierArea.decode(new Uint8Array());
+    }
+};

package/dist/components/generated/AvatarShape.gen.d.ts

@@ -0,0 +1,8 @@
+import { ISchema } from '../../schemas/ISchema';
+import { PBAvatarShape } from './pb/decentraland/sdk/components/avatar_shape.gen';
+/**
+ *
+ */
+export declare const AvatarShapeSchema: ISchema<PBAvatarShape> & {
+    COMPONENT_ID: number;
+};

package/dist/components/generated/AvatarShape.gen.js

@@ -0,0 +1,19 @@
+import { PBAvatarShape } from './pb/decentraland/sdk/components/avatar_shape.gen';
+/**
+ *
+ */
+export const AvatarShapeSchema = {
+    COMPONENT_ID: 1080,
+    serialize(value, builder) {
+        const writer = PBAvatarShape.encode(value);
+        const buffer = new Uint8Array(writer.finish(), 0, writer.len);
+        builder.writeBuffer(buffer, false);
+    },
+    deserialize(reader) {
+        return PBAvatarShape.decode(reader.buffer(), reader.remainingBytes());
+    },
+    create() {
+        // TODO: this is a hack.
+        return PBAvatarShape.decode(new Uint8Array());
+    }
+};

package/dist/components/generated/Billboard.gen.d.ts

@@ -0,0 +1,8 @@
+import { ISchema } from '../../schemas/ISchema';
+import { PBBillboard } from './pb/decentraland/sdk/components/billboard.gen';
+/**
+ *
+ */
+export declare const BillboardSchema: ISchema<PBBillboard> & {
+    COMPONENT_ID: number;
+};

package/dist/components/generated/Billboard.gen.js

@@ -0,0 +1,19 @@
+import { PBBillboard } from './pb/decentraland/sdk/components/billboard.gen';
+/**
+ *
+ */
+export const BillboardSchema = {
+    COMPONENT_ID: 1090,
+    serialize(value, builder) {
+        const writer = PBBillboard.encode(value);
+        const buffer = new Uint8Array(writer.finish(), 0, writer.len);
+        builder.writeBuffer(buffer, false);
+    },
+    deserialize(reader) {
+        return PBBillboard.decode(reader.buffer(), reader.remainingBytes());
+    },
+    create() {
+        // TODO: this is a hack.
+        return PBBillboard.decode(new Uint8Array());
+    }
+};

package/dist/components/generated/CameraMode.gen.d.ts

@@ -0,0 +1,8 @@
+import { ISchema } from '../../schemas/ISchema';
+import { PBCameraMode } from './pb/decentraland/sdk/components/camera_mode.gen';
+/**
+ *
+ */
+export declare const CameraModeSchema: ISchema<PBCameraMode> & {
+    COMPONENT_ID: number;
+};

package/dist/components/generated/CameraMode.gen.js

@@ -0,0 +1,19 @@
+import { PBCameraMode } from './pb/decentraland/sdk/components/camera_mode.gen';
+/**
+ *
+ */
+export const CameraModeSchema = {
+    COMPONENT_ID: 1072,
+    serialize(value, builder) {
+        const writer = PBCameraMode.encode(value);
+        const buffer = new Uint8Array(writer.finish(), 0, writer.len);
+        builder.writeBuffer(buffer, false);
+    },
+    deserialize(reader) {
+        return PBCameraMode.decode(reader.buffer(), reader.remainingBytes());
+    },
+    create() {
+        // TODO: this is a hack.
+        return PBCameraMode.decode(new Uint8Array());
+    }
+};

package/dist/components/generated/CameraModeArea.gen.d.ts

@@ -0,0 +1,8 @@
+import { ISchema } from '../../schemas/ISchema';
+import { PBCameraModeArea } from './pb/decentraland/sdk/components/camera_mode_area.gen';
+/**
+ *
+ */
+export declare const CameraModeAreaSchema: ISchema<PBCameraModeArea> & {
+    COMPONENT_ID: number;
+};

package/dist/components/generated/CameraModeArea.gen.js

@@ -0,0 +1,19 @@
+import { PBCameraModeArea } from './pb/decentraland/sdk/components/camera_mode_area.gen';
+/**
+ *
+ */
+export const CameraModeAreaSchema = {
+    COMPONENT_ID: 1071,
+    serialize(value, builder) {
+        const writer = PBCameraModeArea.encode(value);
+        const buffer = new Uint8Array(writer.finish(), 0, writer.len);
+        builder.writeBuffer(buffer, false);
+    },
+    deserialize(reader) {
+        return PBCameraModeArea.decode(reader.buffer(), reader.remainingBytes());
+    },
+    create() {
+        // TODO: this is a hack.
+        return PBCameraModeArea.decode(new Uint8Array());
+    }
+};

package/dist/components/generated/GltfContainer.gen.d.ts

@@ -0,0 +1,8 @@
+import { ISchema } from '../../schemas/ISchema';
+import { PBGltfContainer } from './pb/decentraland/sdk/components/gltf_container.gen';
+/**
+ *
+ */
+export declare const GltfContainerSchema: ISchema<PBGltfContainer> & {
+    COMPONENT_ID: number;
+};