narraleaf-react 0.5.0 → 0.6.0

package/dist/game/nlcore/common/game.d.ts

@@ -1,7 +1,8 @@
-import { Game } from "../game";
-import { GameState } from "../../player/gameState";
-import { Storable, Namespace } from "../elements/persistent/storable";
-import { LiveGame } from "../game/liveGame";
-import type { SavedGame } from "../gameTypes";
-export { LiveGame, GameState, Game, Storable, Namespace, };
-export type { SavedGame, };
+import { Game } from "../game";
+import { GameState } from "../../player/gameState";
+import { Storable, Namespace } from "../elements/persistent/storable";
+import { LiveGame } from "../game/liveGame";
+import { Preference } from "../game/preference";
+import type { SavedGame } from "../gameTypes";
+export { LiveGame, GameState, Game, Storable, Namespace, Preference, };
+export type { SavedGame, };

package/dist/game/nlcore/common/player.d.ts

@@ -1,7 +1,7 @@
-import Player from "../../player/elements/Player";
-import GameProviders from "../../player/provider/providers";
-import { useGame } from "../../../game/player/provider/game-state";
-import { useRouter } from "../../player/lib/PageRouter/router";
-export * from "../../player/type";
-export * from "../../player/libElements";
-export { GameProviders, Player, useGame, useRouter, };
+import Player from "../../player/elements/Player";
+import GameProviders from "../../player/provider/providers";
+import { useGame } from "../../../game/player/provider/game-state";
+import { useRouter } from "../../player/lib/PageRouter/router";
+export * from "../../player/type";
+export * from "../../player/libElements";
+export { GameProviders, Player, useGame, useRouter, };

package/dist/game/nlcore/common/position.d.ts

@@ -1,2 +1,2 @@
-import { Align, CommonPosition, Coord2D, CommonPositionType } from "../elements/transform/position";
-export { Align, CommonPosition, Coord2D, CommonPositionType };
+import { Align, CommonPosition, Coord2D, CommonPositionType } from "../elements/transform/position";
+export { Align, CommonPosition, Coord2D, CommonPositionType };

package/dist/game/nlcore/common/transition.d.ts

@@ -1,6 +1,6 @@
-import { Dissolve } from "../elements/transition/transitions/image/dissolve";
-import { FadeIn } from "../elements/transition/transitions/image/fadeIn";
-import { Transition } from "../elements/transition/transition";
-import { ImageTransition } from "../elements/transition/transitions/image/imageTransition";
-import { TextTransition } from "../elements/transition/transitions/text/textTransition";
-export { Transition, ImageTransition, TextTransition, Dissolve, FadeIn, };
+import { Dissolve } from "../elements/transition/transitions/image/dissolve";
+import { FadeIn } from "../elements/transition/transitions/image/fadeIn";
+import { Transition } from "../elements/transition/transition";
+import { ImageTransition } from "../elements/transition/transitions/image/imageTransition";
+import { TextTransition } from "../elements/transition/transitions/text/textTransition";
+export { Transition, ImageTransition, TextTransition, Dissolve, FadeIn, };

package/dist/game/nlcore/common/types.d.ts

@@ -1,9 +1,9 @@
-import { ServiceHandlerCtx } from "../elements/service";
-import { Origins } from "../elements/story";
-import { TransformDefinitions } from "../elements/transform/type";
-import { IGamePluginRegistry } from "../game/plugin/plugin";
-import { LiveGameEventToken } from "../types";
-import { GameHistory } from "../action/gameHistory";
-import { GameConfig, SavedGame } from "../gameTypes";
-export * from "../elements/type";
-export type { GameHistory, IGamePluginRegistry, LiveGameEventToken, Origins, ServiceHandlerCtx, TransformDefinitions, GameConfig, SavedGame, };
+import { ServiceHandlerCtx } from "../elements/service";
+import { Origins } from "../elements/story";
+import { TransformDefinitions } from "../elements/transform/type";
+import { IGamePluginRegistry } from "../game/plugin/plugin";
+import { LiveGameEventToken } from "../types";
+import { GameHistory } from "../action/gameHistory";
+import { GameConfig, SavedGame, NotificationToken, SavedGameMetaData } from "../gameTypes";
+export * from "../elements/type";
+export type { GameHistory, IGamePluginRegistry, LiveGameEventToken, Origins, ServiceHandlerCtx, TransformDefinitions, GameConfig, SavedGame, NotificationToken, SavedGameMetaData, };

package/dist/game/nlcore/elements/character/pause.d.ts

@@ -1,8 +1,8 @@
-export type PauseConfig = {
-    duration?: number;
-};
-export type Pausing = Pause | PausingShortcut;
-export declare class Pause {
-    static wait(duration: number): Pause;
-    constructor(config?: Partial<PauseConfig>);
-}
+export type PauseConfig = {
+    duration?: number;
+};
+export type Pausing = Pause | PausingShortcut;
+export declare class Pause {
+    static wait(duration: number): Pause;
+    constructor(config?: Partial<PauseConfig>);
+}

package/dist/game/nlcore/elements/character/sentence.d.ts

@@ -1,25 +1,25 @@
-import type { Character } from "../../elements/character";
-import { Pausing } from "../../elements/character/pause";
-import { Word } from "../../elements/character/word";
-import type { ScriptCtx } from "../../elements/script";
-import { Sound } from "../../elements/sound";
-import { Color, Font } from "../../types";
-export type SentenceConfig = {
-    pause?: boolean | number;
-    voice: Sound | null;
-    character: Character | null;
-    voiceId: string | number | null;
-    color?: Color;
-} & Font;
-export type SentenceUserConfig = Partial<Omit<SentenceConfig, "voice"> & {
-    voice: Sound | string | null | undefined;
-}>;
-export type DynamicWord = (ctx: ScriptCtx) => DynamicWordResult;
-export type DynamicWordResult = string | Word | Pausing | (string | Word | Pausing)[];
-export type StaticWord<T extends string | DynamicWord | Pausing = string | DynamicWord | Pausing> = string | Pausing | Word<T>;
-export type SingleWord = StaticWord | DynamicWord;
-export type SentencePrompt = SingleWord[] | SingleWord;
-export declare class Sentence {
-    constructor(text: SentencePrompt, config?: SentenceUserConfig);
-    copy(): Sentence;
-}
+import type { Character } from "../../elements/character";
+import { Pausing } from "../../elements/character/pause";
+import { Word } from "../../elements/character/word";
+import type { ScriptCtx } from "../../elements/script";
+import { Sound } from "../../elements/sound";
+import { Color, Font } from "../../types";
+export type SentenceConfig = {
+    pause?: boolean | number;
+    voice: Sound | null;
+    character: Character | null;
+    voiceId: string | number | null;
+    color?: Color;
+} & Font;
+export type SentenceUserConfig = Partial<Omit<SentenceConfig, "voice"> & {
+    voice: Sound | string | null | undefined;
+}>;
+export type DynamicWord = (ctx: ScriptCtx) => DynamicWordResult;
+export type DynamicWordResult = string | Word | Pausing | (string | Word | Pausing)[];
+export type StaticWord<T extends string | DynamicWord | Pausing = string | DynamicWord | Pausing> = string | Pausing | Word<T>;
+export type SingleWord = StaticWord | DynamicWord;
+export type SentencePrompt = SingleWord[] | SingleWord;
+export declare class Sentence {
+    constructor(text: SentencePrompt, config?: SentenceUserConfig);
+    copy(): Sentence;
+}

package/dist/game/nlcore/elements/character/word.d.ts

@@ -1,18 +1,18 @@
-import { Color, Font } from "../../types";
-import { DynamicWord } from "../../elements/character/sentence";
-import { Pausing } from "../../elements/character/pause";
-export type WordConfig = {
-    className: string;
-    ruby: string;
-    color: Color;
-    pause: boolean;
-    cps?: number;
-} & Font;
-export declare class Word<T extends string | DynamicWord | Pausing = string | DynamicWord | Pausing> {
-    static isWord(obj: any): obj is Word;
-    static color(text: string | Word, color: Color): Word;
-    static bold(text: string | Word): Word;
-    static italic(text: string | Word): Word;
-    constructor(text: T, config?: Partial<WordConfig>);
-    toString(): string;
-}
+import { Color, Font } from "../../types";
+import { DynamicWord } from "../../elements/character/sentence";
+import { Pausing } from "../../elements/character/pause";
+export type WordConfig = {
+    className: string;
+    ruby: string;
+    color: Color;
+    pause: boolean;
+    cps?: number;
+} & Font;
+export declare class Word<T extends string | DynamicWord | Pausing = string | DynamicWord | Pausing> {
+    static isWord(obj: any): obj is Word;
+    static color(text: string | Word, color: Color): Word;
+    static bold(text: string | Word): Word;
+    static italic(text: string | Word): Word;
+    constructor(text: T, config?: Partial<WordConfig>);
+    toString(): string;
+}

package/dist/game/nlcore/elements/character.d.ts

@@ -1,52 +1,56 @@
-import { LogicAction } from "../game";
-import { Color } from "../types";
-import { DeepPartial } from "../../../util/data";
-import { Actionable } from "../action/actionable";
-import { Chained, Proxied } from "../action/chain";
-import { Sentence, SentencePrompt, SentenceUserConfig, SingleWord } from "../elements/character/sentence";
-export type CharacterConfig = {
-    color?: Color;
-};
-export interface Character {
-    (content: string, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
-    (content: Sentence): Proxied<Character, Chained<LogicAction.Actions>>;
-    (content: SentencePrompt, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
-    (texts: TemplateStringsArray, ...words: SingleWord[]): Proxied<Character, Chained<LogicAction.Actions>>;
-}
-export declare class Character extends Actionable<CharacterStateData, Character> {
-    constructor(name: string | null, config?: DeepPartial<CharacterConfig>);
-    /**
-     * Say something
-     * @example
-     * ```typescript
-     * character.say("Hello, world!");
-     * ```
-     * @example
-     * ```typescript
-     * character
-     *     .say("Hello, world!")
-     *     .say("Hello, world!");
-     * ```
-     * @example
-     * ```typescript
-     * character.say(new Sentence(character, [
-     *     "Hello, ",
-     *     new Word("world", {color: "#f00"}), // Some words can be colored
-     * ]));
-     * @example
-     * ```typescript
-     * character.say`Hello, ${Word.color("world", "#f00")}!`;
-     * ```
-     * @chainable
-     */
-    say(content: string, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
-    say(content: Sentence): Proxied<Character, Chained<LogicAction.Actions>>;
-    say(content: SentencePrompt, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
-    say(texts: TemplateStringsArray, ...words: SingleWord[]): Proxied<Character, Chained<LogicAction.Actions>>;
-    setName(name: string): Proxied<Character, Chained<LogicAction.Actions>>;
-    apply(content: string, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
-    apply(content: Sentence): Proxied<Character, Chained<LogicAction.Actions>>;
-    apply(content: SentencePrompt, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
-    apply(texts: TemplateStringsArray, ...words: SingleWord[]): Proxied<Character, Chained<LogicAction.Actions>>;
-}
-export declare const Narrator: Character;
+import { LogicAction } from "../game";
+import { Color } from "../types";
+import { DeepPartial } from "../../../util/data";
+import { Actionable } from "../action/actionable";
+import { Chained, Proxied } from "../action/chain";
+import { Sentence, SentencePrompt, SentenceUserConfig, SingleWord } from "../elements/character/sentence";
+export type CharacterConfig = {
+    color?: Color;
+};
+export interface Character {
+    (content: string, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
+    (content: Sentence): Proxied<Character, Chained<LogicAction.Actions>>;
+    (content: SentencePrompt, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
+    (texts: TemplateStringsArray, ...words: SingleWord[]): Proxied<Character, Chained<LogicAction.Actions>>;
+}
+export declare class Character extends Actionable<CharacterStateData, Character> {
+    constructor(name: string | null, config?: DeepPartial<CharacterConfig>);
+    /**
+     * Say something
+     * @example
+     * ```typescript
+     * character.say("Hello, world!");
+     * ```
+     * @example
+     * ```typescript
+     * character
+     *     .say("Hello, world!")
+     *     .say("Hello, world!");
+     * ```
+     * @example
+     * ```typescript
+     * character.say(new Sentence(character, [
+     *     "Hello, ",
+     *     new Word("world", {color: "#f00"}), // Some words can be colored
+     * ]));
+     * @example
+     * ```typescript
+     * character.say`Hello, ${Word.color("world", "#f00")}!`;
+     * ```
+     * @example
+     * ```typescript
+     * character`Hello, ${Word.color("world", "#f00")}!`;
+     * ```
+     * @chainable
+     */
+    say(content: string, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
+    say(content: Sentence): Proxied<Character, Chained<LogicAction.Actions>>;
+    say(content: SentencePrompt, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
+    say(texts: TemplateStringsArray, ...words: SingleWord[]): Proxied<Character, Chained<LogicAction.Actions>>;
+    setName(name: string): Proxied<Character, Chained<LogicAction.Actions>>;
+    apply(content: string, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
+    apply(content: Sentence): Proxied<Character, Chained<LogicAction.Actions>>;
+    apply(content: SentencePrompt, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
+    apply(texts: TemplateStringsArray, ...words: SingleWord[]): Proxied<Character, Chained<LogicAction.Actions>>;
+}
+export declare const Narrator: Character;

package/dist/game/nlcore/elements/condition.d.ts

@@ -1,20 +1,20 @@
-import { LogicAction } from "../action/logicAction";
-import { Actionable } from "../action/actionable";
-import { Chained, Proxied } from "../action/chain";
-import { LambdaHandler, ActionStatements } from "../elements/type";
-export declare class Lambda<T = any> {
-}
-export declare class Condition<Closed extends true | false = false> extends Actionable {
-    /**
-     * @chainable
-     */
-    static If(condition: Lambda | LambdaHandler<boolean>, action: ActionStatements): Proxied<Condition, Chained<LogicAction.Actions>>;
-    /**
-     * @chainable
-     */
-    ElseIf(condition: Closed extends false ? (Lambda | LambdaHandler<boolean>) : never, action: Closed extends false ? ActionStatements : never): Closed extends false ? Proxied<Condition, Chained<LogicAction.Actions>> : never;
-    /**
-     * @chainable
-     */
-    Else(action: Closed extends false ? ActionStatements : never): Closed extends false ? Proxied<Condition<true>, Chained<LogicAction.Actions>> : never;
-}
+import { LogicAction } from "../action/logicAction";
+import { Actionable } from "../action/actionable";
+import { Chained, Proxied } from "../action/chain";
+import { LambdaHandler, ActionStatements } from "../elements/type";
+export declare class Lambda<T = any> {
+}
+export declare class Condition<Closed extends true | false = false> extends Actionable {
+    /**
+     * @chainable
+     */
+    static If(condition: Lambda | LambdaHandler<boolean>, action: ActionStatements): Proxied<Condition, Chained<LogicAction.Actions>>;
+    /**
+     * @chainable
+     */
+    ElseIf(condition: Closed extends false ? (Lambda | LambdaHandler<boolean>) : never, action: Closed extends false ? ActionStatements : never): Closed extends false ? Proxied<Condition, Chained<LogicAction.Actions>> : never;
+    /**
+     * @chainable
+     */
+    Else(action: Closed extends false ? ActionStatements : never): Closed extends false ? Proxied<Condition<true>, Chained<LogicAction.Actions>> : never;
+}

package/dist/game/nlcore/elements/control.d.ts

@@ -1,76 +1,76 @@
-import { Actionable } from "../action/actionable";
-import { Awaitable } from "../../../util/data";
-import { ActionStatements } from "./type";
-export declare class Control extends Actionable {
-    /**
-     * Execute actions in order, waiting for each action to complete
-     * @chainable
-     */
-    static do(actions: ActionStatements): ChainedControl;
-    /**
-     * Execute actions in order, do not wait for this action to complete
-     * @chainable
-     */
-    static doAsync(actions: ActionStatements): ChainedControl;
-    /**
-     * Execute all actions at the same time, waiting for any one action to complete
-     * @chainable
-     */
-    static any(actions: ActionStatements): ChainedControl;
-    /**
-     * Execute all actions at the same time, waiting for all actions to complete
-     * @chainable
-     */
-    static all(actions: ActionStatements): ChainedControl;
-    /**
-     * Execute all actions at the same time, do not wait for all actions to complete
-     * @chainable
-     */
-    static allAsync(actions: ActionStatements): ChainedControl;
-    /**
-     * Execute actions multiple times
-     * @chainable
-     */
-    static repeat(times: number, actions: ActionStatements): ChainedControl;
-    /**
-     * Sleep for a duration
-     * @chainable
-     */
-    static sleep(duration: number | Awaitable<any> | Promise<any>): ChainedControl;
-    constructor(/**@internal */ config?: Partial<ControlConfig>);
-    /**
-     * Execute actions in order, waiting for each action to complete
-     * @chainable
-     */
-    do(actions: ActionStatements): ChainedControl;
-    /**
-     * Execute actions in order, do not wait for this action to complete
-     * @chainable
-     */
-    doAsync(actions: ActionStatements): ChainedControl;
-    /**
-     * Execute all actions at the same time, waiting for any one action to complete
-     * @chainable
-     */
-    any(actions: ActionStatements): ChainedControl;
-    /**
-     * Execute all actions at the same time, waiting for all actions to complete
-     * @chainable
-     */
-    all(actions: ActionStatements): ChainedControl;
-    /**
-     * Execute all actions at the same time, do not wait for all actions to complete
-     * @chainable
-     */
-    allAsync(actions: ActionStatements): ChainedControl;
-    /**
-     * Execute actions multiple times
-     * @chainable
-     */
-    repeat(times: number, actions: ActionStatements): ChainedControl;
-    /**
-     * Sleep for a duration
-     * @chainable
-     */
-    sleep(duration: number | Awaitable<any> | Promise<any>): ChainedControl;
-}
+import { Actionable } from "../action/actionable";
+import { Awaitable } from "../../../util/data";
+import { ActionStatements } from "./type";
+export declare class Control extends Actionable {
+    /**
+     * Execute actions in order, waiting for each action to complete
+     * @chainable
+     */
+    static do(actions: ActionStatements): ChainedControl;
+    /**
+     * Execute actions in order, do not wait for this action to complete
+     * @chainable
+     */
+    static doAsync(actions: ActionStatements): ChainedControl;
+    /**
+     * Execute all actions at the same time, waiting for any one action to complete
+     * @chainable
+     */
+    static any(actions: ActionStatements): ChainedControl;
+    /**
+     * Execute all actions at the same time, waiting for all actions to complete
+     * @chainable
+     */
+    static all(actions: ActionStatements): ChainedControl;
+    /**
+     * Execute all actions at the same time, do not wait for all actions to complete
+     * @chainable
+     */
+    static allAsync(actions: ActionStatements): ChainedControl;
+    /**
+     * Execute actions multiple times
+     * @chainable
+     */
+    static repeat(times: number, actions: ActionStatements): ChainedControl;
+    /**
+     * Sleep for a duration
+     * @chainable
+     */
+    static sleep(duration: number | Awaitable<any> | Promise<any>): ChainedControl;
+    constructor(/**@internal */ config?: Partial<ControlConfig>);
+    /**
+     * Execute actions in order, waiting for each action to complete
+     * @chainable
+     */
+    do(actions: ActionStatements): ChainedControl;
+    /**
+     * Execute actions in order, do not wait for this action to complete
+     * @chainable
+     */
+    doAsync(actions: ActionStatements): ChainedControl;
+    /**
+     * Execute all actions at the same time, waiting for any one action to complete
+     * @chainable
+     */
+    any(actions: ActionStatements): ChainedControl;
+    /**
+     * Execute all actions at the same time, waiting for all actions to complete
+     * @chainable
+     */
+    all(actions: ActionStatements): ChainedControl;
+    /**
+     * Execute all actions at the same time, do not wait for all actions to complete
+     * @chainable
+     */
+    allAsync(actions: ActionStatements): ChainedControl;
+    /**
+     * Execute actions multiple times
+     * @chainable
+     */
+    repeat(times: number, actions: ActionStatements): ChainedControl;
+    /**
+     * Sleep for a duration
+     * @chainable
+     */
+    sleep(duration: number | Awaitable<any> | Promise<any>): ChainedControl;
+}

package/dist/game/nlcore/elements/displayable/displayable.d.ts

@@ -1,76 +1,76 @@
-import { Actionable } from "../../action/actionable";
-import { Transform } from "../../elements/transform/transform";
-import { Chained, Proxied } from "../../action/chain";
-import { LogicAction } from "../../action/logicAction";
-import { EventfulDisplayable } from "../../../player/elements/displayable/type";
-import type { TransformDefinitions } from "../../elements/transform/type";
-export declare abstract class Displayable<StateData extends Record<string, any>, Self extends Displayable<any, any, any>, TransformType extends TransformDefinitions.Types = TransformDefinitions.Types> extends Actionable<StateData, Self> implements EventfulDisplayable {
-    /**
-     * Set Image Position
-     *
-     * @param position - The position of the image, expected {@link RawPosition} or {@link IPosition}
-     * @param duration - The duration of the position animation
-     * @param easing - The easing of the position animation
-     * @chainable
-     */
-    pos(position: TransformDefinitions.ImageTransformProps["position"], duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
-    /**
-     * Set Image Scale
-     * @param scale - The scale of the image, between 0 and 1
-     * @param duration - The duration of the scale animation
-     * @param easing - The easing of the scale animation
-     * @chainable
-     */
-    scale(scale: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
-    /**
-     * Set Image Rotation
-     * @param rotation - The rotation of the image, in degrees
-     * @param duration - The duration of the rotation animation
-     * @param easing - The easing of the rotation animation
-     * @chainable
-     */
-    rotate(rotation: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
-    /**
-     * Set Image Opacity
-     * @param opacity - The opacity of the image, between 0 and 1
-     * @param duration - The duration of the opacity animation
-     * @param easing - The easing of the opacity animation
-     * @chainable
-     */
-    opacity(opacity: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
-    /**
-     * Apply a transform to the Displayable
-     * @chainable
-     */
-    transform(transform: Transform<TransformType>): Proxied<Self, Chained<LogicAction.Actions, Self>>;
-    /**
-     * Show the Displayable
-     *
-     * if options are provided, the displayable will show with the provided transform options
-     * @example
-     * ```ts
-     * text.show({
-     *     duration: 1000,
-     * });
-     * ```
-     * @chainable
-     */
-    show(): Proxied<Self, Chained<LogicAction.Actions>>;
-    show(options: Transform<TransformType>): Proxied<Self, Chained<LogicAction.Actions>>;
-    show(options: Partial<TransformDefinitions.CommonTransformProps>): Proxied<Self, Chained<LogicAction.Actions>>;
-    /**
-     * Hide the Displayable
-     *
-     * if options are provided, the displayable will hide with the provided transform options
-     * @example
-     * ```ts
-     * text.hide({
-     *     duration: 1000,
-     * });
-     * ```
-     * @chainable
-     */
-    hide(): Proxied<Self, Chained<LogicAction.Actions>>;
-    hide(options: Transform<TransformType>): Proxied<Self, Chained<LogicAction.Actions>>;
-    hide(options: Partial<TransformDefinitions.CommonTransformProps>): Proxied<Self, Chained<LogicAction.Actions>>;
-}
+import { Actionable } from "../../action/actionable";
+import { Transform } from "../../elements/transform/transform";
+import { Chained, Proxied } from "../../action/chain";
+import { LogicAction } from "../../action/logicAction";
+import { EventfulDisplayable } from "../../../player/elements/displayable/type";
+import type { TransformDefinitions } from "../../elements/transform/type";
+export declare abstract class Displayable<StateData extends Record<string, any>, Self extends Displayable<any, any, any>, TransformType extends TransformDefinitions.Types = TransformDefinitions.Types> extends Actionable<StateData, Self> implements EventfulDisplayable {
+    /**
+     * Set Image Position
+     *
+     * @param position - The position of the image, expected {@link RawPosition} or {@link IPosition}
+     * @param duration - The duration of the position animation
+     * @param easing - The easing of the position animation
+     * @chainable
+     */
+    pos(position: TransformDefinitions.ImageTransformProps["position"], duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
+    /**
+     * Set Image Scale
+     * @param scale - The scale of the image, between 0 and 1
+     * @param duration - The duration of the scale animation
+     * @param easing - The easing of the scale animation
+     * @chainable
+     */
+    scale(scale: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
+    /**
+     * Set Image Rotation
+     * @param rotation - The rotation of the image, in degrees
+     * @param duration - The duration of the rotation animation
+     * @param easing - The easing of the rotation animation
+     * @chainable
+     */
+    rotate(rotation: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
+    /**
+     * Set Image Opacity
+     * @param opacity - The opacity of the image, between 0 and 1
+     * @param duration - The duration of the opacity animation
+     * @param easing - The easing of the opacity animation
+     * @chainable
+     */
+    opacity(opacity: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
+    /**
+     * Apply a transform to the Displayable
+     * @chainable
+     */
+    transform(transform: Transform<TransformType>): Proxied<Self, Chained<LogicAction.Actions, Self>>;
+    /**
+     * Show the Displayable
+     *
+     * if options are provided, the displayable will show with the provided transform options
+     * @example
+     * ```ts
+     * text.show({
+     *     duration: 1000,
+     * });
+     * ```
+     * @chainable
+     */
+    show(): Proxied<Self, Chained<LogicAction.Actions>>;
+    show(options: Transform<TransformType>): Proxied<Self, Chained<LogicAction.Actions>>;
+    show(options: Partial<TransformDefinitions.CommonTransformProps>): Proxied<Self, Chained<LogicAction.Actions>>;
+    /**
+     * Hide the Displayable
+     *
+     * if options are provided, the displayable will hide with the provided transform options
+     * @example
+     * ```ts
+     * text.hide({
+     *     duration: 1000,
+     * });
+     * ```
+     * @chainable
+     */
+    hide(): Proxied<Self, Chained<LogicAction.Actions>>;
+    hide(options: Transform<TransformType>): Proxied<Self, Chained<LogicAction.Actions>>;
+    hide(options: Partial<TransformDefinitions.CommonTransformProps>): Proxied<Self, Chained<LogicAction.Actions>>;
+}