@dcl/sdk 7.0.0-3445274368.commit-063bc43 → 7.0.0-3469489430.commit-9c7979a

package/dist/ecs7/index.d.ts

@@ -1,7 +1,50 @@
 /// <reference types="@dcl/posix" />
 
 /** @public */
-export declare const Animator: ComponentDefinition<ISchema<PBAnimator>, PBAnimator>;
+export declare const Animator: AnimatorComponentDefinition;
+
+/**
+ * @public
+ */
+export declare interface AnimatorComponentDefinition extends ComponentDefinition {
+    /**
+     * @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;
+}
 
 /** @public */
 export declare const AudioSource: ComponentDefinition<ISchema<PBAudioSource>, PBAudioSource>;
@@ -917,7 +960,7 @@ export declare namespace Components {
     /** @public */
     const Transform: ComponentDefinition<ISchema<TransformType>, Partial<TransformType>>;
     /** @public */
-    const Animator: ComponentDefinition<ISchema<PBAnimator>, PBAnimator>;
+    const Animator: AnimatorComponentDefinition;
     /** @public */
     const AudioSource: ComponentDefinition<ISchema<PBAudioSource>, PBAudioSource>;
     /** @public */
@@ -1156,8 +1199,8 @@ export declare type DeepReadonlyObject<T> = {
 export declare type DeepReadonlySet<T> = ReadonlySet<DeepReadonly<T>>;
 
 declare function defineSdkComponents(engine: PreEngine): {
+    Animator: AnimatorComponentDefinition;
     Transform: ComponentDefinition<ISchema<TransformType>, Partial<TransformType>>;
-    Animator: ComponentDefinition<ISchema<PBAnimator>, PBAnimator>;
     AudioSource: ComponentDefinition<ISchema<PBAudioSource>, PBAudioSource>;
     AudioStream: ComponentDefinition<ISchema<PBAudioStream>, PBAudioStream>;
     AvatarAttach: ComponentDefinition<ISchema<PBAvatarAttach>, PBAvatarAttach>;
@@ -2616,10 +2659,6 @@ declare interface PBAnimationState {
     shouldReset?: boolean | undefined;
 }
 
-declare interface PBAnimator {
-    states: PBAnimationState[];
-}
-
 declare interface PBAudioSource {
     playing?: boolean | undefined;
     /** default=1.0f */
@@ -2700,6 +2739,16 @@ declare interface PBGltfContainer {
 }
 
 declare interface PBMaterial {
+    material?: {
+        $case: 'unlit';
+        unlit: PBMaterial_UnlitMaterial;
+    } | {
+        $case: 'pbr';
+        pbr: PBMaterial_PbrMaterial;
+    };
+}
+
+declare interface PBMaterial_PbrMaterial {
     /** default = null */
     texture?: TextureUnion | undefined;
     /** default = 0.5. range value: from 0 to 1 */
@@ -2734,6 +2783,15 @@ declare interface PBMaterial {
     directIntensity?: number | undefined;
 }
 
+declare interface PBMaterial_UnlitMaterial {
+    /** default = null */
+    texture?: TextureUnion | undefined;
+    /** default = 0.5. range value: from 0 to 1 */
+    alphaTest?: number | undefined;
+    /** default =  true */
+    castShadows?: boolean | undefined;
+}
+
 declare interface PBMeshCollider {
     /** default = ColliderLayer.Physics | ColliderLayer.Pointer */
     collisionMask?: number | undefined;
@@ -3665,6 +3723,7 @@ export declare namespace Schemas {
     const Quaternion: ISchema<QuaternionType>;
     const Color3: ISchema<Color3Type>;
     const Color4: ISchema<Color4Type>;
+    const Entity: ISchema<Entity>;
     const Enum: typeof IEnum;
     const Array: typeof IArray;
     const Map: typeof IMap;