ゲームの残り時間を制御、描画します.

interface Ticker {
    container?: E;
    digit: number;
    font: Font;
    onExpire: Trigger<void>;
    onValue: Trigger<number>;
    prefix: string;
    rawValue: number;
    status: TickerStatus;
    suffix: string;
    value: number;
    vars?: unknown;
    add(frame: number): void;
    disable(): void;
    enable(): void;
    set(frame: number): void;
}

Hierarchy

  • NumberLabel
    • Ticker

Properties

container?: E

ラベル付き数値を描画するエンティティ. (このエンティティの子にラベルが登録されます.)

digit: number

表示する数値の桁数を取得します.

font: Font

描画に使用するフォントを取得します.

onExpire: Trigger<void>

残り時間が 0 になった際に発火するトリガ

onValue: Trigger<number>

値が変化したとき発火されるトリガ

prefix: string

数値に前置するテキストを取得します

rawValue: number

残り時間を取得します. (フレーム単位、負の値あり、小数点以下あり)

status: TickerStatus

残り時間の変更を受け付けるか状態を取得します

suffix: string

数値に後置するテキストを取得します

value: number

残り時間を取得します. (秒単位、0秒以上、小数点以下切り捨て)

vars?: unknown

ライブラリ利用者が自由に使えるフィールドです.

Methods

  • 残り時間の値 (フレーム数) を追加します.

    カウントダウン形式の場合、引数に負の値を設定してください.

    Parameters

    • frame: number

      追加する値 (フレーム数)

    Returns void

  • 残り時間を設定しようとしても無視します.

    Returns void

  • 残り時間を設定できるようにします.

    Returns void

  • 引数の値に残り時間 (フレーム数) を設定します.

    Parameters

    • frame: number

      設定する値

    Returns void