/
GameHandlerSet.ts
81 lines (70 loc) · 2.53 KB
/
GameHandlerSet.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
import type * as pl from "@akashic/playlog";
import type { EventFilter } from "./EventFilter";
import type { LocalTickModeString } from "./LocalTickModeString";
import type { TickGenerationModeString } from "./TickGenerationModeString";
export interface SceneMode {
local: LocalTickModeString;
tickGenerationMode: TickGenerationModeString;
}
/**
* エンジンから呼び出される実装依存処理
*/
export interface GameHandlerSet {
/**
* ティックを発生させる。
* @param events そのティックで追加で発生させるイベント
*/
raiseTick(events?: pl.Event[]): void;
/**
* イベントを発生させる。
*
* @param event 発生させるイベント
*/
raiseEvent(event: pl.Event): void;
/**
* イベントフィルタを追加する。
*
* @param func イベントフィルタ
* @param handleEmpty イベントが存在しない場合でも定期的にフィルタを呼び出すか否か。省略された場合、偽。
*/
addEventFilter(func: EventFilter, handleEmpty?: boolean): void;
/**
* イベントフィルタを削除する
* @param func イベントフィルタ
*/
removeEventFilter(func: EventFilter): void;
/**
* 全てのイベントフィルタを削除する
*/
removeAllEventFilters(): void;
/**
* g.Scene のモード変更を通知する
* @param mode
*/
changeSceneMode(mode: SceneMode): void;
/**
* このインスタンスにおいてスナップショットの保存を行うべきかを返す。
*/
shouldSaveSnapshot(): boolean;
/**
* スナップショットを保存する。
*
* @param frame スナップショットのフレーム。
* @param snapshot 保存するスナップショット。JSONとして妥当な値でなければならない。
* @param randGenSer 乱数生成器のシリアリゼーション。
* @param nextEntityId 次のエンティティID
* @param timestamp 保存時の時刻。 `g.TimestampEvent` を利用するゲームの場合、それらと同じ基準の時間情報を与えなければならない。
*/
saveSnapshot(frame: number, snapshot: any, randGenSer: any, nextEntityId: number, timestamp?: number): void;
/**
* このインスタンスの種別を取得する
*/
getInstanceType(): "active" | "passive";
/**
* 現在時刻を取得する。
*
* 値は1970-01-01T00:00:00Zからのミリ秒での経過時刻である。
* `Date.now()` と異なり、この値は消化されたティックの数から算出される擬似的な時刻である。
*/
getCurrentTime(): number;
}