Line data Source code
1 : package stage
2 :
3 : import (
4 : gc "github.com/kijimaD/ruins/internal/components"
5 : w "github.com/kijimaD/ruins/internal/world"
6 : "github.com/kijimaD/ruins/internal/world/lifecycle"
7 : "github.com/kijimaD/ruins/internal/world/query"
8 : "github.com/mlange-42/ark/ecs"
9 : )
10 :
11 : // BoundEntities は指定ステージに束縛されたエンティティを集める。
12 : // クエリ反復中は構造変更できないので、呼び出し側は集めてから付け外しする。
13 : // 途中 return するとワールドをロックしたまま残すため、クエリは最後まで反復する
14 : func BoundEntities(world w.World, key gc.StageKey) []ecs.Entity {
15 1 : var bound []ecs.Entity
16 1 : q := ecs.NewFilter1[gc.StageBound](world.ECS).Query()
17 1 : for q.Next() {
18 1 : if world.Components.StageBound.Get(q.Entity()).Key == key {
19 1 : bound = append(bound, q.Entity())
20 1 : }
21 : }
22 1 : return bound
23 : }
24 :
25 : // suspend は指定ステージのエンティティを退避する。
26 : // Suspended マーカーを付け、ステージ跨ぎのシステムの対象から外す。
27 : // 既に Suspended のエンティティへの二重付与は避ける
28 : func suspend(world w.World, key gc.StageKey) {
29 1 : for _, e := range BoundEntities(world, key) {
30 1 : if !world.Components.Suspended.Has(e) {
31 1 : world.Components.Suspended.Add(e, &gc.Suspended{})
32 1 : }
33 : }
34 : }
35 :
36 : // resume は指定ステージのエンティティを再稼働する。Suspended を外す。
37 : // 退避していないエンティティはそのまま
38 : func resume(world w.World, key gc.StageKey) {
39 1 : for _, e := range BoundEntities(world, key) {
40 1 : if world.Components.Suspended.Has(e) {
41 1 : world.Components.Suspended.Remove(e)
42 1 : }
43 : }
44 : }
45 :
46 : // exists は指定ステージに束縛されたエンティティが1つでも存在するかを返す。
47 : // 訪問済みかどうかの判定に使う。生成済みなら true
48 : func exists(world w.World, key gc.StageKey) bool {
49 1 : return len(BoundEntities(world, key)) > 0
50 1 : }
51 :
52 : // Purge は指定ステージのエンティティを world から完全に除去する。
53 : // 特定ステージだけの破棄に使う。遺跡からオーバーワールドへ戻る際など、
54 : // 一部ステージだけを捨て、残りを共存させたまま離脱するときに呼ぶ
55 : func Purge(world w.World, key gc.StageKey) {
56 1 : bound := BoundEntities(world, key)
57 1 : // 消える所有者の収納在庫も道連れにする。在庫は GridElement も StageBound も持たず
58 : // この走査に載らないため、所有者だけ消すと死んだ所有者を指す孤児になり serde で蓄積する
59 1 : lifecycle.RemoveOwnedEntities(world, bound)
60 1 : for _, e := range bound {
61 1 : if world.ECS.Alive(e) {
62 1 : world.ECS.RemoveEntity(e)
63 1 : }
64 : }
65 : }
66 :
67 : // ResetExploredTiles は現ステージの探索履歴を空にする。ステージへ入り直すたびにリセットする方針。
68 : // 探索履歴は StageField が持つため、現ステージの StageField の map を貼り替える
69 : func ResetExploredTiles(world w.World) {
70 1 : field := query.GetCurrentStageField(world)
71 1 : if field == nil {
72 1 : return
73 1 : }
74 1 : field.ExploredTiles = make(map[gc.GridElement]bool)
75 : }
76 :
77 : // Bind は StageBound を持たないフィールドエンティティに key を付ける。
78 : // ステージ生成の直後に呼び、生成物をそのステージへ束縛して識別できるようにする。
79 : // GridElement を持つが Player・既存 StageBound でないものが対象。
80 : // Player はステージをまたいで生きるので束縛しない。
81 : // 退避中エンティティは既に StageBound を持つので自然に除外される
82 : func Bind(world w.World, key gc.StageKey) {
83 1 : var targets []ecs.Entity
84 1 : q := ecs.NewFilter1[gc.GridElement](world.ECS).
85 1 : Without(ecs.C[gc.StageBound](), ecs.C[gc.Player]()).Query()
86 1 : for q.Next() {
87 1 : targets = append(targets, q.Entity())
88 1 : }
89 1 : for _, e := range targets {
90 1 : world.Components.StageBound.Add(e, &gc.StageBound{Key: key})
91 1 : }
92 : }
93 :
94 : // SwapTo は現ステージを退避し target へ切り替える正典操作。往復のすべてがこれに還元される。
95 : // target が訪問済みなら再稼働し、未訪問なら generate で決定的生成する。
96 : // target は現ステージと異なる前提。自己スワップは呼ばない。
97 : //
98 : // generate は生成物へ **必ず** StageBound{target} を付ける責務を負う。付け忘れると未分類の
99 : // フィールドエンティティが生じ、以降の退避で漏れる。生成側は末尾で Bind を呼び付与する。
100 : // 別の generate を実装するときも同様に付けること。
101 : //
102 : // プレイヤー配置など遷移ごとに違う再導出は、呼び出し側が続けて行う
103 : func SwapTo(world w.World, target gc.StageKey, generate func(world w.World, key gc.StageKey) error) error {
104 1 : d := query.GetDungeon(world)
105 1 : // プレイ中に湧いた未束縛のフィールドエンティティを現ステージへ回収する。
106 : // ドロップ・置いたアイテム・エフェクトが退避されず次ステージへ漏れるのを防ぐ
107 1 : Bind(world, d.CurrentStage)
108 1 : if exists(world, target) {
109 : // 訪問済み。現ステージを退避してから target を再稼働する
110 1 : if d.CurrentStage != target {
111 1 : suspend(world, d.CurrentStage)
112 1 : }
113 1 : resume(world, target)
114 : } else {
115 : // 未訪問。先に生成し、失敗したら現ステージを退避せず CurrentStage も動かさない。
116 : // 生成中は現ステージがまだ稼働しているが、生成物は新しい StageBound を持つので混ざらない
117 1 : if err := generate(world, target); err != nil {
118 1 : return err
119 1 : }
120 1 : if d.CurrentStage != target {
121 1 : suspend(world, d.CurrentStage)
122 1 : }
123 : }
124 1 : d.CurrentStage = target
125 1 : ResetExploredTiles(world)
126 1 : // 座標索引は現ステージのみで作り直す。swap で無効化し次アクセスで再構築させる
127 1 : query.InvalidateSpatialIndex(world)
128 1 : return nil
129 : }
|