Interface SpotConfigure

Spot を新規作成する際の各種設定を格納します.

interface SpotConfigure {
    image(assets: Partial<SpotAssetRecord>): SpotConfigure;
    image(): Readonly<SpotAssetRecord>;
    labelFont(): Font;
    labelFont(font: Font): SpotConfigure;
    liveClass(): (new () => Live);
    liveClass(liveClass: (new () => Live)): SpotConfigure;
    location(location: CommonOffset): SpotConfigure;
    location(): Readonly<CommonOffset>;
    name(): string;
    name(name: string): SpotConfigure;
    vars(): unknown;
    vars(vars: unknown): SpotConfigure;
}

Index

Methods

image labelFont liveClass location name vars

Methods

image

image(assets): SpotConfigure
描画に使用する画像アセットを設定します.
Parameters
- assets: Partial<SpotAssetRecord>
  状態ごとに使用する画像アセット
Returns SpotConfigure
- Defined in builder/spotConfigure.ts:14
image(): Readonly<SpotAssetRecord>
描画に使用される画像アセットをすべての状態について取得します.

Returns Readonly<SpotAssetRecord>
- Defined in builder/spotConfigure.ts:19

labelFont

labelFont(): Font
名称の描画に用いるフォントを取得します.

Returns Font
- Defined in builder/spotConfigure.ts:36
labelFont(font): SpotConfigure
名称の描画に用いるフォントを設定します.
Parameters
- font: Font
  名称描画用のフォント
Returns SpotConfigure
- Defined in builder/spotConfigure.ts:43

liveClass

liveClass(): (new () => Live)
作成する Spot に到達すると開始する生放送を取得します.

Returns (new () => Live)
- - new (): Live
  - Returns Live
- Defined in builder/spotConfigure.ts:60
liveClass(liveClass): SpotConfigure
作成する Spot に到達すると開始する生放送を設定します.
Parameters
- liveClass: (new () => Live)
  開始する生放送クラス名. インスタンスでない点にご留意ください.
  - - new (): Live
    - Returns Live
Returns SpotConfigure
- Defined in builder/spotConfigure.ts:67

location

location(location): SpotConfigure
作成する Spot を配置する座標を設定します.
Parameters
- location: CommonOffset
  Spot を配置する座標
Returns SpotConfigure
- Defined in builder/spotConfigure.ts:50
location(): Readonly<CommonOffset>
作成する Spot を配置する座標を取得します.

Returns Readonly<CommonOffset>
- Defined in builder/spotConfigure.ts:55

name

name(): string
マップに表示される名称を取得します.

Returns string
- Defined in builder/spotConfigure.ts:24
name(name): SpotConfigure
マップに表示される名称を設定します.
Parameters
- name: string
  名称
Returns SpotConfigure
- Defined in builder/spotConfigure.ts:31

vars

vars(): unknown
作成する Spot のライブラリ利用者が自由に使えるフィールドを取得します.

Returns unknown
- Defined in builder/spotConfigure.ts:72
vars(vars): SpotConfigure
作成する Spot のライブラリ利用者が自由に使えるフィールドを設定します.
Parameters
- vars: unknown
  ライブラリ利用者が自由に使えるフィールド
Returns SpotConfigure
- Defined in builder/spotConfigure.ts:79