@casual-simulation/aux-common 3.0.18 → 3.0.20-alpha.2922092747

package/runtime/AuxLibraryDefinitions.def

@@ -8838,6 +8838,109 @@ interface RecordFileOptions {
     mimeType?: string;
 }
 
+
+/**
+ * Defines an interface that contains a bunch of options for starting an animation.
+ */
+export interface StartFormAnimationOptions {
+    /**
+     * The Unix time in miliseconds that the animation should start at.
+     */
+    startTime?: number;
+
+    /**
+     * The time within the animation clip that the animation should start at in miliseconds.
+     */
+    initialTime?: number;
+
+    /**
+     * The rate at which the animation plays.
+     * 1 means the animation plays normally.
+     * 2 means the animation plays 2x as quickly.
+     * 0 means that the animation is paused.
+     */
+    timeScale?: number;
+
+    /**
+     * The options for looping the animation.
+     * If omitted, then the animation will play once and finish.
+     */
+    loop?: {
+        /**
+         * The looping mode that should be used.
+         */
+        mode: 'repeat' | 'pingPong';
+
+        /**
+         * The number of times that the animation should repeat for.
+         */
+        count: number;
+    };
+
+    /**
+     * Whether the final animation values should be preserved when the animation finishes.
+     */
+    clampWhenFinished?: boolean;
+
+    /**
+     * The number of miliseconds that the animation should take to cross fade from the previous animation.
+     * If null, then this animation takes over immediately. Additionally, if no previous animation was playing then this animation takes over immediately.
+     */
+    crossFadeDuration?: number;
+
+    /**
+     * Whether to warp animation values during a cross fade.
+     */
+    crossFadeWarp?: boolean;
+
+    /**
+     * The number of miliseconds that the animation should take to fade in.
+     * If null, then the animation will not fade in.
+     */
+    fadeDuration?: number;
+
+    /**
+     * The address that the animations should be loaded from.
+     */
+    animationAddress?: string;
+}
+
+/**
+ * Defines an interface that contains a bunch of options for stopping an animation.
+ */
+export interface StopFormAnimationOptions {
+    /**
+     * The Unix time in miliseconds that the animation should be stopped at.
+     */
+    stopTime?: number;
+
+    /**
+     * The number of miliseconds that the animation should take to fade out.
+     * If null, then the animation will stop immediately.
+     */
+    fadeDuration?: number;
+}
+
+/**
+ * Defines an interface that contains animation information.
+ */
+ export interface FormAnimationData {
+    /**
+     * The name of the animation.
+     */
+    name: string;
+
+    /**
+     * The index that the animation is at.
+     */
+    index: number;
+
+    /**
+     * The duration of the animation in miliseconds.
+     */
+    duration: number;
+}
+
 interface Os {
     /**
          * Sleeps for time in ms.
@@ -9961,6 +10064,44 @@ interface Os {
      */
     calculateRayFromCamera(portal: 'grid' | 'miniGrid' | 'map' | 'miniMap', viewportCoordinates: Vector2): Promise<RaycastRay>;
 
+    /**
+     * Requests that the given address be pre-cached so that it is available for use on a bot.
+     * Returns a promise that resolves once the address has been cached.
+     * @param address The address that should be cached.
+     */
+    bufferFormAddressGLTF(address: string): Promise<void>;
+
+    /**
+     * Starts the given animation on the given bot.
+     * Returns a promise that resolves once the animation has been started.
+     * @param bot The Bot that the animation should be started on.
+     * @param nameOrIndex The name or index of the animation that should be started.
+     * @param options The options that should be used for the animation.
+     */
+    startFormAnimation(bot: Bot, nameOrIndex: string | number, options?: StartFormAnimationOptions): Promise<void>;
+    /**
+     * Starts the given animation on the given bot(s).
+     * Returns a promise that resolves once the animation(s) have been started.
+     * @param botOrBots The bot or list of bots that the animation should be started on.
+     * @param nameOrIndex The name of the animation.
+     * @param options The options for the animation.
+     */
+    startFormAnimation(botOrBots: Bot | string | (Bot | string)[], nameOrIndex: string | number, options?: StartFormAnimationOptions): Promise<void>;
+
+    /**
+     * Stops the animation on the given bot(s).
+     * Returns a promise that resolves when the animations have been stopped.
+     * @param botOrBots The bot or list of bots that the animation(s) should be stopped on.
+     * @param options The options that should be used.
+     */
+    stopFormAnimation(botOrBots: Bot | string | (Bot | string)[], options?: StopFormAnimationOptions): Promise<void>;
+
+    /**
+     * Gets the list of animations that are included in the given the form or bot.
+     * @param botOrAddress The bot, bot ID, or address that the animations should be retrieved from.
+     */
+    listFormAnimations(botOrAddress: Bot | string): Promise<FormAnimationData[]>;
+
     /**
      * Specifies that the given prefix should be interpreted as code.
      * @param prefix The prefix that code tags should start with.