Interface Broadcaster

放送者（プレイヤー）.

放送者（プレイヤー）はマップの上 (Field) を移動でき、 Spot を訪問すると生放送します. BroadcasterBuilder を使ってインスタンスを作成してください.

interface Broadcaster {
    destination?: Spot;
    field?: Field;
    live?: Live;
    location?: Readonly<CommonOffset>;
    onDepart: Trigger<void>;
    onEnter: Trigger<Spot>;
    onLiveEnd: Trigger<Live>;
    onStop: Trigger<void>;
    speed: number;
    status: BroadcasterStatus;
    staying?: Spot;
    vars?: unknown;
    view: E;
    backFromLive(): void;
    departTo(spot: Spot): void;
    goToLive(live: Live): void;
    jumpTo(spot: Spot): void;
    standOn(field: Field): void;
    stop(): void;
}

Properties

destination? field? live? location? onDepart onEnter onLiveEnd onStop speed status staying? vars? view

Methods

backFromLive departTo goToLive jumpTo standOn stop

Properties

Optional Readonlydestination

destination?: Spot

放送者（プレイヤー）が現在向かっている Spot.

目的地がない場合、 undefined を返します

Optional Readonlyfield

field?: Field

放送者（プレイヤー）が所属するマップ (Field).

マップ (Field) 上にいないときは undefined が返されます

Optional Readonlylive

live?: Live

放送者（プレイヤー）が現在している生放送.

生放送中でない場合、 undefined を返します

Optional Readonlylocation

location?: Readonly<CommonOffset>

放送者（プレイヤー）の座標

マップ (Field) 上にいないときは undefined が返されます

ReadonlyonDepart

onDepart: Trigger<void>

Spot に向かって移動を開始した際発火されます.

ReadonlyonEnter

onEnter: Trigger<Spot>

Spot に到達した際発火されます. 引数には到達した Spot が格納されます.

ReadonlyonLiveEnd

onLiveEnd: Trigger<Live>

Spot での生放送が終了した際発火されます.

ReadonlyonStop

onStop: Trigger<void>

Spot への移動中に移動をキャンセルした際発火されます.

speed

speed: number

移動速度. 1フレームで移動する距離 (画面座標系) で指定します

Readonlystatus

status: BroadcasterStatus

放送者（プレイヤー）の現在の状態を取得します.

Optional Readonlystaying

staying?: Spot

放送者（プレイヤー）が現在滞在中または生放送をしている Spot.

滞在中でない場合 undefined を返します.

Optionalvars

vars?: unknown

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

Readonlyview

view: E

現在描画されている放送者（プレイヤー）のエンティティ.

Methods

backFromLive

  • backFromLive(): void
  • Internal

    生放送が終わったため、再びマップで移動可能状態にします.

    生放送中でない場合、実行に失敗します. Spot に滞在している必要があります.

    本メソッドは自動で呼び出されるため、 本ライブラリ利用者が実行する必要はありません.

    Returns void

departTo

  • departTo(spot): void

  • 指定した Spot へ移動し始めます.

    移動は 1フレームあたり speed の距離進みます. 放送者（プレイヤー）はマップ (Field) を登録している必要があります. 放送者（プレイヤー）は移動中でない必要があります. 移動中の場合は停止させてください.

    Parameters

    • spot: Spot

      目的地として設定する Spot

    Returns void

    See

    • standOn
    • stop

goToLive

  • goToLive(live): void
  • Internal

    生放送が開始したことを通知します.

    Spot に滞在している必要があります

    本メソッドは自動で呼び出されるため、 本ライブラリ利用者が実行する必要はありません.

    Parameters

    • live: Live

      開始された生放送

    Returns void

jumpTo

  • jumpTo(spot): void

  • 指定した Spot の場所にワープします.

    移動速度 speed の制約は受けず、移動は瞬間で完了します. 放送者（プレイヤー）はマップ (Field) を登録している必要があります. 放送者（プレイヤー）は移動中でない必要があります. 移動中の場合は停止させてください.

    Parameters

    • spot: Spot

      ワープ先

    Returns void

    See

    • standOn
    • stop

standOn

  • standOn(field): void

  • 指定したマップ (Field) に登録し、マップの上を移動できるようにします.

    本メソッドを実行すると放送者（プレイヤー）が画面上に描画されるようになります.

    Parameters

    • field: Field

      登録先マップ

    Returns void

stop

  • stop(): void

  • 移動中の場合、移動を中止します.

    現在地で待機を開始します. 放送者（プレイヤー）はマップ (Field) を登録している必要があります. 放送者（プレイヤー）は移動中でない場合、実行に失敗します.

    Returns void

    See

    • standOn
    • destination

Settings

Member Visibility

On This Page

Properties
Methods