@m2c2kit/addons 0.3.14 → 0.3.15

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Canvas } from 'canvaskit-wasm';
-import { CompositeOptions, Size, RgbaColor, Composite, M2Node, GlobalVariables, TextOptions, IText, M2NodeEvent, CallbackOptions, Point, ShapeOptions, LabelHorizontalAlignmentMode, Transition, StoryOptions, Story, Scene, SceneOptions } from '@m2c2kit/core';
+import { CompositeOptions, Size, RgbaColor, Composite, M2Node, GlobalVariables, TextOptions, IText, StringInterpolationMap, M2NodeEvent, CallbackOptions, Point, ShapeOptions, LabelHorizontalAlignmentMode, Transition, StoryOptions, Story, Scene, SceneOptions } from '@m2c2kit/core';
 
 interface GridOptions extends CompositeOptions {
     /** Number of rows in the grid. Must be 1 or greater */
@@ -101,6 +101,8 @@ interface ButtonOptions extends CompositeOptions, TextOptions {
     backgroundColor?: RgbaColor;
     /** Color of button text. Default is WebColors.White */
     fontColor?: RgbaColor;
+    /** Names of multiple fonts to use for text. For example, if a text font and an emoji font are to be used together. Must have been previously loaded */
+    fontNames?: Array<string>;
 }
 declare class Button extends Composite implements IText {
     compositeType: string;
@@ -113,6 +115,10 @@ declare class Button extends Composite implements IText {
     fontSize: number;
     private _text;
     private _fontColor;
+    private _fontName;
+    private _fontNames;
+    private _interpolation;
+    private _localize;
     private backgroundPaint?;
     /**
      * A simple button of rectangle with text centered inside.
@@ -132,6 +138,14 @@ declare class Button extends Composite implements IText {
     set backgroundColor(backgroundColor: RgbaColor);
     get fontColor(): RgbaColor;
     set fontColor(fontColor: RgbaColor);
+    get fontName(): string | undefined;
+    set fontName(fontName: string | undefined);
+    get fontNames(): Array<string> | undefined;
+    set fontNames(fontNames: Array<string> | undefined);
+    get interpolation(): StringInterpolationMap;
+    set interpolation(interpolation: StringInterpolationMap);
+    get localize(): boolean;
+    set localize(localize: boolean);
     /**
      * Duplicates a node using deep copy.
      *
@@ -473,6 +487,7 @@ interface KeyTapMetadata {
     buttons: number;
 }
 declare class VirtualKeyboard extends Composite {
+    compositeType: string;
     private keyboardHorizontalPaddingPercent;
     private keyboardVerticalPaddingPercent;
     private keyHorizontalPaddingPercent;
@@ -490,6 +505,8 @@ declare class VirtualKeyboard extends Composite {
     private showKeyDownPreview;
     private shiftActivated;
     private shiftKeyShape;
+    private keyShapes;
+    _isUserInteractionEnabled: boolean;
     /**
      * An on-screen keyboard that can be used to enter text.
      *
@@ -512,6 +529,14 @@ declare class VirtualKeyboard extends Composite {
      */
     onKeyUp(callback: (virtualKeyboardEvent: VirtualKeyboardEvent) => void, options?: CallbackOptions): void;
     private addVirtualKeyboardEventListener;
+    /**
+     * Does the `VirtualKeyboard` respond to user events? Default is true.
+     */
+    get isUserInteractionEnabled(): boolean;
+    /**
+     * Does the `VirtualKeyboard` respond to user events? Default is true.
+     */
+    set isUserInteractionEnabled(isUserInteractionEnabled: boolean);
     update(): void;
     draw(canvas: Canvas): void;
     warmup(canvas: Canvas): void;
@@ -684,4 +709,157 @@ declare class CountdownScene extends Scene {
     constructor(options: CountdownSceneOptions);
 }
 
-export { Button, type ButtonOptions, CountdownScene, type CountdownSceneOptions, Dialog, type DialogEvent, type DialogOptions, DialogResult, DrawPad, type DrawPadEvent, DrawPadEventType, type DrawPadItem, type DrawPadItemEvent, DrawPadItemEventType, type DrawPadOptions, type DrawPadStroke, Grid, type GridOptions, type InstructionScene, Instructions, type InstructionsOptions, type KeyConfiguration, type KeyTapMetadata, type StrokeInteraction, type TimerShape, VirtualKeyboard, type VirtualKeyboardEvent, type VirtualKeyboardOptions, type VirtualKeyboardRow };
+interface LocalePickerOptions extends CompositeOptions {
+    /** Background color of dialog box. Default is WebColors.White */
+    backgroundColor?: RgbaColor;
+    /** Locales to choose from in the dialog box. Default is the locales in the game's `Translation`. */
+    localeOptions?: Array<LocaleOption>;
+    /** What to show as the currently selected locale in the picker. Default is the game's current locale. */
+    currentLocale?: string;
+    /** Alpha level for the overlay that dims the scene underneath the dialog box. Default is .5 */
+    overlayAlpha?: number;
+    /** Size of dialog box. Default is automatically sized to fit the number of locale options. */
+    size?: Size;
+    /** Corner radius of dialog box; can be used to make rounded corners */
+    cornerRadius?: number;
+    /** Font size of locale options in dialog box. Default is 24. */
+    fontSize?: number;
+    /** Font color of locale options in dialog box. Default is WebColors.Black */
+    fontColor?: RgbaColor;
+    /** Image to use for LocalePicker. Default is a globe SVG, 32x32. */
+    icon?: LocalePickerIcon;
+    /** Position of the LocalePicker icon. Default is &#123; x: 32, y: 32 &#125; */
+    iconPosition: Point;
+    /** Should the selection in the LocalePicker automatically switch the game's locale? Default is true. */
+    automaticallyChangeLocale?: boolean;
+}
+interface LocalePickerIcon {
+    /** The HTML SVG tag, in string form, that will be rendered to display the locale.
+     * Must begin with &#60;svg> and end with &#60;/svg> */
+    svgString?: string;
+    /** Name of image to use for LocalePicker. Must have been previously loaded */
+    imageName?: string;
+    /** Height to scale image to */
+    height: number;
+    /** Width to scale image to */
+    width: number;
+}
+interface LocaleOption {
+    /** Human-readable text description of the locale. */
+    text: string;
+    /** SVG of the locale. */
+    svg?: LocaleSvg;
+    /** Locale in language-country format, xx-YY. */
+    locale: string;
+}
+interface LocalePickerResult {
+    /** Locale that was selected. Is undefined if dialog was dismissed. */
+    locale?: string;
+}
+interface LocalePickerEvent extends M2NodeEvent {
+    result: LocalePickerResult;
+}
+interface LocaleSvg {
+    /** The HTML SVG tag, in string form, that will be rendered to display the locale.
+     * Must begin with &#60;svg> and end with &#60;/svg> */
+    svgString: string;
+    /** Height to scale image to */
+    height: number;
+    /** Width to scale image to */
+    width: number;
+}
+declare class LocalePicker extends Composite {
+    compositeType: string;
+    zPosition: number;
+    private readonly DEFAULT_FONT_SIZE;
+    automaticallyChangeLocale: boolean;
+    private _localeOptions;
+    private _backgroundColor;
+    private _fontSize;
+    private _fontColor;
+    private _currentLocale?;
+    private _cornerRadius;
+    private _overlayAlpha;
+    private _icon;
+    private _iconPosition;
+    private iconSprite?;
+    /**
+     * Wrap displayed locale in double angle quotes if it is the current locale.
+     * Note: Although the code editor will allow us to enter almost any
+     * unicode character, it will not render correctly if the font does
+     * not support the character. Thus, be careful to use characters that
+     * are supported by the font. For example, check a page like
+     * https://www.fontspace.com/roboto-font-f13281 to see which characters
+     * are supported by Roboto Regular, which is often the default font in
+     * m2c2kit. Emoji or checkmarks like ✓ are not in Roboto Regular!
+     */
+    private readonly LEFT_SELECTION_INDICATOR;
+    private readonly RIGHT_SELECTION_INDICATOR;
+    /**
+     * An icon and dialog box for selecting a locale from a list of options.
+     *
+     * @remarks This composite node is composed of a dialog box that appears
+     * when the user taps a globe icon. Typically, the `LocalePicker` will be
+     * added as a free node to the game so that it exists independently of
+     * the game's scenes. The dialog box contains a list of locales that the
+     * user can choose from. By default, this list is populated with the locales
+     * in the game's `Translation` object. When the user selects a locale, the
+     * dialog box disappears and the locale is set as the game's current locale.
+     *  The dialog box is automatically sized to fit the number of locale
+     * options.
+     *
+     * @example
+     * let localePicker: LocalePicker;
+     * if (game.getParameter<boolean>("show_locale_picker")) {
+     *   localePicker = new LocalePicker();
+     *   game.addFreeNode(localePicker);
+     * }
+     *
+     * @param options - {@link LocalePickerOptions}
+     */
+    constructor(options?: LocalePickerOptions);
+    /**
+     * Executes a callback when the user selects a locale.
+     *
+     * @param callback - function to execute
+     * @param options - {@link CallbackOptions}
+     */
+    onResult(callback: (localePickerEvent: LocalePickerEvent) => void, options?: CallbackOptions): void;
+    initialize(): void;
+    private handleLocaleSelection;
+    private setDialogVisibility;
+    get backgroundColor(): RgbaColor;
+    set backgroundColor(backgroundColor: RgbaColor);
+    get fontSize(): number;
+    set fontSize(fontSize: number);
+    get fontColor(): RgbaColor;
+    set fontColor(fontColor: RgbaColor);
+    get cornerRadius(): number;
+    set cornerRadius(cornerRadius: number);
+    get overlayAlpha(): number;
+    set overlayAlpha(alpha: number);
+    get icon(): LocalePickerIcon;
+    set icon(icon: LocalePickerIcon);
+    get iconPosition(): Point;
+    set iconPosition(position: Point);
+    get localeOptions(): Array<LocaleOption>;
+    set localeOptions(options: Array<LocaleOption>);
+    get currentLocale(): string | undefined;
+    set currentLocale(locale: string | undefined);
+    update(): void;
+    draw(canvas: Canvas): void;
+    warmup(canvas: Canvas): void;
+    /**
+     * Duplicates a node using deep copy.
+     *
+     * @remarks This is a deep recursive clone (node and children).
+     * The uuid property of all duplicated nodes will be newly created,
+     * because uuid must be unique.
+     *
+     * @param newName - optional name of the new, duplicated node. If not
+     * provided, name will be the new uuid
+     */
+    duplicate(newName?: string): LocalePicker;
+}
+
+export { Button, type ButtonOptions, CountdownScene, type CountdownSceneOptions, Dialog, type DialogEvent, type DialogOptions, DialogResult, DrawPad, type DrawPadEvent, DrawPadEventType, type DrawPadItem, type DrawPadItemEvent, DrawPadItemEventType, type DrawPadOptions, type DrawPadStroke, Grid, type GridOptions, type InstructionScene, Instructions, type InstructionsOptions, type KeyConfiguration, type KeyTapMetadata, type LocaleOption, LocalePicker, type LocalePickerEvent, type LocalePickerIcon, type LocalePickerOptions, type LocalePickerResult, type StrokeInteraction, type TimerShape, VirtualKeyboard, type VirtualKeyboardEvent, type VirtualKeyboardOptions, type VirtualKeyboardRow };