Interface OperationPlugin

操作プラグインの実装すべきインターフェース。 Static methodについては OperationPluginStatic を参照。

interface OperationPlugin {
    operationTrigger: Trigger<
        (string | number)[]
        | OperationPluginOperation,
    >;
    decode(op: (string | number)[]): any;
    start(): void;
    stop(): void;
}

Properties

operationTrigger

Methods

decode? start stop

Properties

operationTrigger

operationTrigger: Trigger<(string | number)[] | OperationPluginOperation>

このプラグインが生成した操作を通知する Trigger 。

Methods

Optionaldecode

  • decode(op: (string | number)[]): any

  • operationTrigger で通知した操作のデコードを行う。

    通常、operationTrigger で通知した操作の情報は、 g.OperationEvent#data に保持されてゲームスクリプトに渡される。 このメソッドが存在する場合、 通知した操作をこのメソッドに渡して呼び出したその戻り値が g.OperationEvent#data に与えられるようになる。

    Parameters

    • op: (string | number)[]

    Returns any

start

  • start(): void

  • このプラグインを開始する。 このメソッドの呼び出し以降、 this.operationTrigger がfireされる可能性がある。

    Returns void

stop

  • stop(): void

  • このプラグインを停止する。 このメソッドの呼び出し以降、 this.operationTrigger がfireされることはない。

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods