narraleaf-react 0.4.4 → 0.6.0

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>>;
+}

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

@@ -1,91 +1,102 @@
-import type { TransformDefinitions } from "../../elements/transform/type";
-import { Color, CommonDisplayableConfig, ImageSrc } from "../../types";
-import { LogicAction } from "../../game";
-import { FlexibleTuple, SelectElementFromEach } from "../../../../util/data";
-import { Chained, Proxied } from "../../action/chain";
-import { Displayable } from "../../elements/displayable/displayable";
-import { EventfulDisplayable } from "../../../player/elements/displayable/type";
-import { ImageTransition } from "../../elements/transition/transitions/image/imageTransition";
-import { Layer } from "../../elements/layer";
-export type TagDefinition<T extends TagGroupDefinition | null> = T extends TagGroupDefinition ? TagDefinitionObject<T> : never;
-export type TagDefinitionObject<T extends TagGroupDefinition> = {
-    groups: T;
-    defaults: SelectElementFromEach<T>;
-    resolve: TagSrcResolver<T>;
-};
-type ImageSrcType<T extends TagGroupDefinition | null = TagGroupDefinition | null> = T extends TagGroupDefinition ? TagDefinition<T> : (Color | ImageSrc);
-export interface IImageUserConfig<Tag extends TagGroupDefinition | null = TagGroupDefinition | null> extends CommonDisplayableConfig {
-    /**
-     * The name of the image, only for debugging purposes
-     */
-    name: string;
-    /**
-     * If set to false, the image won't be initialized unless you call `init` method
-     * @default true
-     */
-    autoInit: boolean;
-    /**
-     * Image Src, see [Image](https://react.narraleaf.com/documentation/core/elements/image) for more information
-     */
-    src: ImageSrcType<Tag>;
-    /**
-     * Auto resize image's width to fit the screen
-     * @default false
-     */
-    autoFit: boolean;
-    /**
-     * layer of the image
-     */
-    layer?: Layer;
-}
-export type TagGroupDefinition = string[][];
-export type TagSrcResolver<T extends TagGroupDefinition> = (...tags: SelectElementFromEach<T>) => string;
-export declare class Image<Tags extends TagGroupDefinition | null = TagGroupDefinition | null> extends Displayable<ImageDataRaw, Image, TransformDefinitions.ImageTransformProps> implements EventfulDisplayable {
-    constructor(config?: Partial<IImageUserConfig<Tags>>);
-    /**
-     * Set the source of the image
-     *
-     * - Tag-based image: the src will be resolved from the tags
-     * - Static image: the src will be a string or StaticImageData
-     * @example
-     * ```ts
-     * image.char("path/to/image.png", new Dissolve(1000));
-     * ```
-     * @example
-     * ```ts
-     * image.char(["happy", "t-shirt", "shorts"], new Dissolve(1000));
-     * ```
-     * @chainable
-     */
-    char(src: ImageSrc | Color, transition?: ImageTransition): Proxied<Image, Chained<LogicAction.Actions>>;
-    char(tags: SelectElementFromEach<Tags> | FlexibleTuple<SelectElementFromEach<Tags>>, transition?: ImageTransition): Proxied<Image, Chained<LogicAction.Actions>>;
-    /**
-     * Add a wearable to the image
-     * @param children - Wearable image or images
-     */
-    addWearable(children: Image | Image[]): this;
-    /**
-     * Add a wearable to the image
-     *
-     * Alias of {@link Image.addWearable}
-     * @param children - Wearable image or images
-     */
-    wear(children: Image | Image[]): this;
-    /**
-     * Bind this image to a parent image as a wearable
-     * @param parent - The parent image
-     */
-    bindWearable(parent: Image): this;
-    /**
-     * Bind this image to a parent image as a wearable
-     *
-     * Alias of {@link Image.bindWearable}
-     * @param parent - The parent image
-     */
-    asWearableOf(parent: Image): this;
-    /**
-     * Use layer for the image, will override the layer in the image config
-     */
-    useLayer(layer: Layer | null): this;
-}
-export {};
+import type { TransformDefinitions } from "../../elements/transform/type";
+import { Color, CommonDisplayableConfig, ImageSrc } from "../../types";
+import { LogicAction } from "../../game";
+import { FlexibleTuple, SelectElementFromEach } from "../../../../util/data";
+import { Chained, Proxied } from "../../action/chain";
+import { Displayable } from "../../elements/displayable/displayable";
+import { EventfulDisplayable } from "../../../player/elements/displayable/type";
+import { ImageTransition } from "../../elements/transition/transitions/image/imageTransition";
+import { Layer } from "../../elements/layer";
+export type TagDefinition<T extends TagGroupDefinition | null> = T extends TagGroupDefinition ? TagDefinitionObject<T> : never;
+export type TagDefinitionObject<T extends TagGroupDefinition> = {
+    groups: T;
+    defaults: SelectElementFromEach<T>;
+    resolve: TagSrcResolver<T>;
+};
+type ImageSrcType<T extends TagGroupDefinition | null = TagGroupDefinition | null> = T extends TagGroupDefinition ? TagDefinition<T> : (Color | ImageSrc);
+export interface IImageUserConfig<Tag extends TagGroupDefinition | null = TagGroupDefinition | null> extends CommonDisplayableConfig {
+    /**
+     * The name of the image, only for debugging purposes
+     */
+    name: string;
+    /**
+     * If set to false, the image won't be initialized unless you call `init` method
+     * @default true
+     */
+    autoInit: boolean;
+    /**
+     * Image Src, see [Image](https://react.narraleaf.com/documentation/core/elements/image) for more information
+     */
+    src: ImageSrcType<Tag>;
+    /**
+     * Auto resize image's width to fit the screen
+     * @default false
+     */
+    autoFit: boolean;
+    /**
+     * layer of the image
+     */
+    layer?: Layer;
+    /**
+     * Darkness of the image, between 0 and 1
+     * @default 0
+     */
+    darkness?: number;
+}
+export type TagGroupDefinition = string[][];
+export type TagSrcResolver<T extends TagGroupDefinition> = (...tags: SelectElementFromEach<T>) => string;
+export declare class Image<Tags extends TagGroupDefinition | null = TagGroupDefinition | null> extends Displayable<ImageDataRaw, Image, TransformDefinitions.ImageTransformProps> implements EventfulDisplayable {
+    constructor(config?: Partial<IImageUserConfig<Tags>>);
+    /**
+     * Set the source of the image
+     *
+     * - Tag-based image: the src will be resolved from the tags
+     * - Static image: the src will be a string or StaticImageData
+     * @example
+     * ```ts
+     * image.char("path/to/image.png", new Dissolve(1000));
+     * ```
+     * @example
+     * ```ts
+     * image.char(["happy", "t-shirt", "shorts"], new Dissolve(1000));
+     * ```
+     * @chainable
+     */
+    char(src: ImageSrc | Color, transition?: ImageTransition): Proxied<Image, Chained<LogicAction.Actions>>;
+    char(tags: SelectElementFromEach<Tags> | FlexibleTuple<SelectElementFromEach<Tags>>, transition?: ImageTransition): Proxied<Image, Chained<LogicAction.Actions>>;
+    /**
+     * Set the darkness of the image
+     * @param darkness - The darkness of the image, between 0 and 1
+     * @chainable
+     */
+    darken(darkness: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Image, Chained<LogicAction.Actions>>;
+    /**
+     * Add a wearable to the image
+     * @param children - Wearable image or images
+     */
+    addWearable(children: Image | Image[]): this;
+    /**
+     * Add a wearable to the image
+     *
+     * Alias of {@link Image.addWearable}
+     * @param children - Wearable image or images
+     */
+    wear(children: Image | Image[]): this;
+    /**
+     * Bind this image to a parent image as a wearable
+     * @param parent - The parent image
+     */
+    bindWearable(parent: Image): this;
+    /**
+     * Bind this image to a parent image as a wearable
+     *
+     * Alias of {@link Image.bindWearable}
+     * @param parent - The parent image
+     */
+    asWearableOf(parent: Image): this;
+    /**
+     * Use layer for the image, will override the layer in the image config
+     */
+    useLayer(layer: Layer | null): this;
+}
+export {};

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

@@ -1,74 +1,74 @@
-import { Color, CommonDisplayableConfig } from "../../types";
-import { Chained, Proxied } from "../../action/chain";
-import { LogicAction } from "../../action/logicAction";
-import type { TransformDefinitions } from "../../elements/transform/type";
-import { Displayable } from "../../elements/displayable/displayable";
-import { EventfulDisplayable } from "../../../player/elements/displayable/type";
-import { Layer } from "../../elements/layer";
-export type TextConfig = {
-    alignX: "left" | "center" | "right";
-    alignY: "top" | "center" | "bottom";
-    className?: string;
-    layer: Layer | undefined;
-};
-export type TextState = {
-    fontSize: number;
-    display: boolean;
-    text: string;
-};
-export interface ITextUserConfig extends CommonDisplayableConfig {
-    /**
-     * Where to align the text horizontally
-     * @default "center"
-     */
-    alignX: "left" | "center" | "right";
-    /**
-     * Where to align the text vertically
-     * @default "center"
-     */
-    alignY: "top" | "center" | "bottom";
-    className?: string;
-    /**
-     * The font size of the text, see [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size)
-     *
-     * **Only supports px unit**
-     * @default 16
-     */
-    fontSize: number;
-    /**
-     * The color of the text, supports {@link Color} and hex string
-     * @default "#000000"
-     */
-    fontColor: Color;
-    /**
-     * The text content
-     */
-    text: string;
-    /**
-     * Layer of the text
-     */
-    layer?: Layer;
-}
-export declare class Text extends Displayable<TextDataRaw, Text, TransformDefinitions.TextTransformProps> implements EventfulDisplayable {
-    constructor(config: Partial<ITextUserConfig>);
-    constructor(text: string, config?: Partial<ITextUserConfig>);
-    /**
-     * Set the text of the Text
-     * @chainable
-     */
-    setText(text: string): Proxied<Text, Chained<LogicAction.Actions>>;
-    /**
-     * Set the font color of the Text
-     * @chainable
-     */
-    setFontColor(color: Color, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Text, Chained<LogicAction.Actions>>;
-    /**
-     * Set the font color of the Text
-     * @chainable
-     */
-    setFontSize(fontSize: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Text, Chained<LogicAction.Actions>>;
-    /**
-     * Use a layer for the Text, will override the layer in the text config
-     */
-    useLayer(layer: Layer): this;
-}
+import { Color, CommonDisplayableConfig } from "../../types";
+import { Chained, Proxied } from "../../action/chain";
+import { LogicAction } from "../../action/logicAction";
+import type { TransformDefinitions } from "../../elements/transform/type";
+import { Displayable } from "../../elements/displayable/displayable";
+import { EventfulDisplayable } from "../../../player/elements/displayable/type";
+import { Layer } from "../../elements/layer";
+export type TextConfig = {
+    alignX: "left" | "center" | "right";
+    alignY: "top" | "center" | "bottom";
+    className?: string;
+    layer: Layer | undefined;
+};
+export type TextState = {
+    fontSize: number;
+    display: boolean;
+    text: string;
+};
+export interface ITextUserConfig extends CommonDisplayableConfig {
+    /**
+     * Where to align the text horizontally
+     * @default "center"
+     */
+    alignX: "left" | "center" | "right";
+    /**
+     * Where to align the text vertically
+     * @default "center"
+     */
+    alignY: "top" | "center" | "bottom";
+    className?: string;
+    /**
+     * The font size of the text, see [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/font-size)
+     *
+     * **Only supports px unit**
+     * @default 16
+     */
+    fontSize: number;
+    /**
+     * The color of the text, supports {@link Color} and hex string
+     * @default "#000000"
+     */
+    fontColor: Color;
+    /**
+     * The text content
+     */
+    text: string;
+    /**
+     * Layer of the text
+     */
+    layer?: Layer;
+}
+export declare class Text extends Displayable<TextDataRaw, Text, TransformDefinitions.TextTransformProps> implements EventfulDisplayable {
+    constructor(config: Partial<ITextUserConfig>);
+    constructor(text: string, config?: Partial<ITextUserConfig>);
+    /**
+     * Set the text of the Text
+     * @chainable
+     */
+    setText(text: string): Proxied<Text, Chained<LogicAction.Actions>>;
+    /**
+     * Set the font color of the Text
+     * @chainable
+     */
+    setFontColor(color: Color, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Text, Chained<LogicAction.Actions>>;
+    /**
+     * Set the font color of the Text
+     * @chainable
+     */
+    setFontSize(fontSize: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Text, Chained<LogicAction.Actions>>;
+    /**
+     * Use a layer for the Text, will override the layer in the text config
+     */
+    useLayer(layer: Layer): this;
+}

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

@@ -1,23 +1,33 @@
-import { CommonDisplayableConfig } from "../types";
-import { TransformDefinitions } from "../elements/transform/type";
-import { Displayable } from "../elements/displayable/displayable";
-import { EventfulDisplayable } from "../../player/elements/displayable/type";
-import { Image } from "../elements/displayable/image";
-import { Text } from "../elements/displayable/text";
-export interface ILayerUserConfig extends CommonDisplayableConfig {
-    /**
-     * The z-index of the layer, higher z-index will be rendered on top of the lower z-index, allows negative values.
-     *
-     * **Note**: the default background layer has a z-index of -1, and the default displayable layer has a z-index of 0.
-     */
-    zIndex: number;
-}
-export declare class Layer extends Displayable<LayerDataRaw, Layer, TransformDefinitions.ImageTransformProps> implements EventfulDisplayable {
-    constructor(name?: string, config?: Partial<ILayerUserConfig>);
-    /**
-     * Include displayables in the layer.
-     *
-     * Same as {@link Displayable.useLayer}
-     */
-    include(elements: (Image | Text)[] | Image | Text): this;
-}
+import { CommonDisplayableConfig } from "../types";
+import { LogicAction } from "../action/logicAction";
+import { TransformDefinitions } from "../elements/transform/type";
+import { Displayable } from "../elements/displayable/displayable";
+import { EventfulDisplayable } from "../../player/elements/displayable/type";
+import { Image } from "../elements/displayable/image";
+import { Text } from "../elements/displayable/text";
+import { Chained, Proxied } from "../action/chain";
+export interface ILayerUserConfig extends CommonDisplayableConfig {
+    /**
+     * The z-index of the layer, higher z-index will be rendered on top of the lower z-index, allows negative values.
+     *
+     * **Note**: the default background layer has a z-index of -1, and the default displayable layer has a z-index of 0.
+     */
+    zIndex: number;
+}
+export declare class Layer extends Displayable<LayerDataRaw, Layer, TransformDefinitions.ImageTransformProps> implements EventfulDisplayable {
+    constructor(name?: string, config?: Partial<ILayerUserConfig>);
+    /**
+     * Include displayables in the layer.
+     *
+     * Same as {@link Displayable.useLayer}
+     */
+    include(elements: (Image | Text)[] | Image | Text): this;
+    /**
+     * Set the z-index of the layer
+     *
+     * @chainable
+     * @param zIndex - The z-index of the layer
+     * @returns The layer itself
+     */
+    setZIndex(zIndex: number): Proxied<Layer, Chained<LogicAction.Actions>>;
+}