Interface Spot

スポット.

スポットはマップ (Field) の上に存在し、放送者（プレイヤー） (Broadcaster) が訪問すると生放送が始まります.

interface Spot {
    assets: Readonly<SpotAssetRecord>;
    field?: Field;
    labelFont: Font;
    liveClass: (new () => Live);
    location?: Readonly<CommonOffset>;
    name: string;
    screen?: Screen;
    status: SpotStatus;
    vars?: unknown;
    view: E;
    visited: boolean;
    attach(screen: Screen): void;
    deployOn(field: Field): void;
    disable(): void;
    enable(): void;
    lockedBy(spot: Spot): void;
    lockedBy(): readonly Spot[];
    markAsVisited(): void;
    setAsDestination(): void;
    unlock(spot: Spot): void;
    unsetAsDestination(): void;
}

Properties

assets field? labelFont liveClass location? name screen? status vars? view visited

Methods

attach deployOn disable enable lockedBy markAsVisited setAsDestination unlock unsetAsDestination

Properties

Readonlyassets

assets: Readonly<SpotAssetRecord>

各場面における画像アセット一覧を取得します

Optional Readonlyfield

field?: Field

Spot が登録されたマップを取得します.

マップ Field 上に配置されていないときは undefined が返されます

ReadonlylabelFont

labelFont: Font

マップに名称を描画するとき用いるフォントを取得します.

ReadonlyliveClass

liveClass: (new () => Live)

訪問時に開始する生放送を取得します.

Type declaration

    • new (): Live

    • Returns Live

      生放送処理が定義されたクラス名

Optional Readonlylocation

location?: Readonly<CommonOffset>

スポットの座標

マップ Field 上に配置されていないときは undefined が返されます

Readonlyname

name: string

マップに表示される名称を取得します.

Optional Readonlyscreen

screen?: Screen

訪問時に開始される生放送を描画する環境情報を取得します.

未登録の場合 undefined が返されます

Readonlystatus

status: SpotStatus

Spot の状態を取得します.

Optionalvars

vars?: unknown

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

Readonlyview

view: E

現在描画されているスポットのエンティティ.

Readonlyvisited

visited: boolean

過去に放送者（プレイヤー）が訪問したかどうか取得します.

Methods

attach

  • attach(screen): void

  • 放送者（プレイヤー）が訪問した際、生放送を開始するためのスクリーン環境情報を登録します.

    Parameters

    Returns void

deployOn

  • deployOn(field): void

  • 指定したマップ (Field) に登録します.

    登録することで Broadcaster は Spot を訪問し、生放送できるようになります. 登録すると Spot は画面に描画されるようになります.

    Parameters

    • field: Field

      登録先のマップ

    Returns void

disable

  • disable(): void

  • 放送者（プレイヤー）が目的地として選択できない状態にします.

    Returns void

enable

  • enable(): void

  • 放送者（プレイヤー）が目的地として選択できる状態にします.

    Returns void

lockedBy

  • lockedBy(spot): void

  • 引数で指定された Spot を攻略しなければ訪問可能にならないようにします.

    Parameters

    • spot: Spot

      前提となる Spot

    Returns void

  • lockedBy(): readonly Spot[]

  • この Spot が訪問可能になるまで攻略が必要な Spot 一覧を取得します.

    Returns readonly Spot[]

markAsVisited

  • markAsVisited(): void
  • Internal

    放送者（プレイヤー）が訪問済であると登録します.

    放送者（プレイヤー）が滞在している必要があります.

    本メソッドは放送者（プレイヤー）移動完了時に自動で呼び出されるため、 本ライブラリ利用者が利用する必要はありません.

    Returns void

setAsDestination

  • setAsDestination(): void

  • 放送者（プレイヤー）が目的地としていると設定します.

    Returns void

unlock

  • unlock(spot): void

  • 引数で指定された Spot が攻略されたことを通知します.

    Parameters

    • spot: Spot

      攻略された Spot

    Returns void

unsetAsDestination

  • unsetAsDestination(): void

  • 目的地として設定されていることを解除します.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods