Interface CommentSupplier

画面上に表示されるコメントを生成します.

CommentSupplierBuilder を使ってインスタンスを作成してください.

interface CommentSupplier {
    comments: readonly CommentSchema[];
    deployers: readonly CommentDeployer[];
    interval: number;
    onSupply: Trigger<string>;
    status: CommentSupplierStatus;
    vars?: unknown;
    addDeployer(deployer: CommentDeployer): void;
    fetch(context: CommentContext): string[];
    start(contextSupplier: CommentContextSupplier): void;
}

Properties

comments deployers interval onSupply status vars?

Methods

addDeployer fetch start

Properties

Readonlycomments

comments: readonly CommentSchema[]

登録された全コメント.

Readonlydeployers

deployers: readonly CommentDeployer[]

生成されたコメントを画面上に配置する CommentDeployer 一覧

interval

interval: number

コメントの生成間隔 (ミリ秒).

ReadonlyonSupply

onSupply: Trigger<string>

コメントが生成された際に発火するトリガ

Readonlystatus

status: CommentSupplierStatus

現在の状態

Optionalvars

vars?: unknown

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

Methods

addDeployer

  • addDeployer(deployer): void

  • 生成されたコメントを画面上に配置する CommentDeployer を登録します.

    Parameters

    • deployer: CommentDeployer

      生成されたコメントを画面上に配置する CommentDeployer

    Returns void

fetch

  • fetch(context): string[]
  • Internal

    現在の tick におけるコメントを生成します. ライブラリ利用者は本メソッドを呼び出す必要はありません. 自動的に呼び出されます.

    Parameters

    • context: CommentContext

      コメント生成条件の判定に使用する環境情報

    Returns string[]

start

Settings

Member Visibility

On This Page

Properties
Methods