Line data Source code
1 : package components
2 :
3 : import (
4 : "fmt"
5 :
6 : "github.com/kijimaD/ruins/internal/consts"
7 : )
8 :
9 : // overworldStageName はオーバーワールド帯ステージの固定名。ダンジョン定義 DungeonOverworld.Name と
10 : // 一致させ、CurrentStage.Name から定義を引けるようにする。
11 : //
12 : // あえて非公開にする。公開する overworld の identity は型付きの NewOverworldStage() だけにし、
13 : // 素の名前を外へ出さない。名前を公開すると CurrentStage.Name == 名前 のような場所判定を誘発するが、
14 : // それは廃した反パターン。外部からは名前で比較できないよう型で塞ぐ。
15 : const overworldStageName = "Overworld"
16 :
17 : // StageKey はステージを一意に識別する serde 安全な identity。共存する各ステージのエンティティ同定に使う。
18 : // オーバーワールドは深度0、ダンジョン階は深度1以上。比較可能な値だけで構成する。
19 : //
20 : // あえて interface でなく比較可能な struct にする。StageBound・PortalConnection・Dungeon に埋め込まれる
21 : // 保存対象で、arkserde は interface を保存できず、共存機構は Key == key の等値比較に依存するため、
22 : // identity は素の値でなければならない。オーバーワールドとダンジョンの振る舞い・設定の多態は、Name で
23 : // 引く StageDefinition(OverworldDefinition/DungeonDefinition)が担う。ここは identity だけを持ち種別で分岐しない。
24 : // Name/Depth はステージ同定と導出、定義の引き当て・階数にのみ使い、場所判定には使わない。
25 : type StageKey struct {
26 : // Name はステージ定義名を保持する。オーバーワールドは NewOverworldStage() が付ける固定名、
27 : // ダンジョン階は進入先を区別する定義名。実ステージは必ず名前を持つ。ゼロ値のみ未設定として許す。
28 : //
29 : // Name で場所を判定しないこと。「今オーバーワールドにいるか」は保有データで判定する
30 : // query.IsOnOverworld を使う。Name は定義の引き当てとステージ同定にのみ用いる。
31 : Name string
32 : // Depth は階の深度を表す。オーバーワールドは 0、ダンジョン階は 1 以上
33 : Depth int
34 : }
35 :
36 : // NewOverworldStage はオーバーワールド帯のステージキーを返す。深度0。
37 : // オーバーワールドの identity を得る唯一の公開手段。場所判定でなくステージの同定・束縛に使う。
38 1 : func NewOverworldStage() StageKey { return StageKey{Name: overworldStageName} }
39 :
40 : // NewDungeonStage は定義 name・深度 depth のダンジョン階のステージキーを返す。
41 : // ダンジョン階は進入先を区別するため定義名を必ず持たせる。名前なしのダンジョン階は作らない。
42 : func NewDungeonStage(name string, depth int) StageKey {
43 1 : return StageKey{Name: name, Depth: depth}
44 1 : }
45 :
46 : // Validate はステージキーの整合を検査する。ロード直後など信頼できない入力に使う。
47 : // オーバーワールドは深度0、それ以外の実ステージは深度1以上、という不変条件を守らせる。
48 : func (k StageKey) Validate() error {
49 : // ゼロ値はどのステージにも属さない未設定として許容する。町にいるときの
50 : // CurrentStage などステージ未割り当ての状態が正当にありうる
51 1 : if k == (StageKey{}) {
52 1 : return nil
53 1 : }
54 1 : if k.Name == overworldStageName {
55 1 : if k.Depth != 0 {
56 1 : return fmt.Errorf("invalid overworld stage depth: %d", k.Depth)
57 1 : }
58 1 : return nil
59 : }
60 : // オーバーワールド以外の実ステージはダンジョン階。定義名を必ず持ち、深度は1以上とする。
61 : // 名前なしのダンジョン階は作らないため、ここへ来た空名は破損とみなして弾く
62 1 : if k.Name == "" {
63 1 : return fmt.Errorf("dungeon stage has no definition name: depth %d", k.Depth)
64 1 : }
65 1 : if k.Depth < 1 {
66 1 : return fmt.Errorf("invalid dungeon stage depth: %d", k.Depth)
67 1 : }
68 1 : return nil
69 : }
70 :
71 : // StageBound はエンティティがどのステージに束縛され、そのライフサイクルを共にするかを表す。
72 : // これを持つエンティティは、ステージが退避されれば Suspended になり、完全離脱で一括除去される。
73 : // 地形・敵・アイテムなどステージ固有で作り直せるものが対象。
74 : //
75 : // Player・共有シングルトンには付けない。これらはステージを渡り歩く訪問者で、
76 : // どのステージとも運命を共にしない。束縛しないことで suspend/purge/resume のどの操作からも
77 : // 自動で外れる。プレイヤーの現在地は Dungeon.CurrentStage が持つ。
78 : type StageBound struct {
79 : // Key は束縛先ステージを保持する
80 : Key StageKey
81 : }
82 :
83 : // PortalConnection はポータルの行き先を保持する。触れると Stage へ swapTo し Coord へ配置する。
84 : // 生成時に往復の両端を相互結線する。findPortalPosition の探索を置き換え、遺跡の複数入口でも
85 : // どのポータルがどこへ繋がるかが曖昧にならない。Stage・Coord とも比較可能で serde 対象。
86 : type PortalConnection struct {
87 : // Stage は行き先ステージ
88 : Stage StageKey
89 : // Coord は行き先ステージ内の着地座標
90 : Coord consts.Coord[consts.Tile]
91 : }
92 :
93 : // DungeonEntrance は遺跡入口プロップが、どの遺跡定義へ入るかを保持する。
94 : // 相互作用 InteractionDungeonEnter の発動時に DefinitionName を読んで進入先を決める。
95 : type DungeonEntrance struct {
96 : // DefinitionName は進入する遺跡の定義名
97 : DefinitionName string
98 : }
99 :
100 : // Suspended は現ステージ以外に属し、現在のフレームで稼働しないことを表すマーカー。
101 : // ステージ跨ぎのシステムは Without(Suspended) で現ステージだけを処理する。
102 : //
103 : // 稼働を既定にするための否定形マーカー。新しい湧きやプレイヤーは Suspended を
104 : // 持たず、何もせずとも既定で稼働する。肯定形 Active にすると、湧きや訪問者へ付け忘れた
105 : // ときに不可視という重い失敗になり、湧くたびに付与する責務も生じる。
106 : // 稼働を既定にするには非稼働側を印すのが正しい。
107 : type Suspended struct{}
|