aboutsummaryrefslogtreecommitdiff
path: root/docs/general-program-architecture.md
blob: c340f8968a6880da2f97534843e06c5a32423a56 (plain) (blame)
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
# Player-Game Interaction
```mermaid
sequenceDiagram
actor Player
participant UI as Godot
participant Bridge as Godot-CPP Bridge
participant Simulation
participant Dataloader
autonumber

Player ->> UI: Program starts
UI ->> Bridge: Godot autoloaders fire
Bridge ->> Dataloader: Signal to load Simulation
Dataloader ->> Simulation: Read in data from file(s)
Simulation ->> Bridge:  Simulation finished loading data
Bridge ->> UI: Autoloaders finish
UI ->> Player: Display Main Menu
Player ->> UI: Press "New Game" or<br>"Load Game" button
UI ->> Bridge: Begin new Game Session
Bridge ->> Simulation: Start new Game Session
Simulation -->> Dataloader: Load previous save game<br>(If necessary)
Dataloader -->> Simulation: Save game loaded
Simulation ->> Bridge: Provide information necessary<br>for UI and visual elements
Bridge ->> UI: Signal that Game Session<br> is ready for interaction
UI ->> Player: Present to Player

loop Core Game Loop
Player ->> UI: Interact with game controls
UI ->> Bridge: Convey player intent<br>according to UI<br>handler functions
Bridge ->> Simulation: Relay changes to entities<br>controlled by the Player
Note over Simulation: When unpaused:
Simulation ->> Simulation: Advance to next in-game day<br>according to game speed<br>and update Simulation state
Simulation ->> Bridge: Inform of relevant<br>changes to game state
Bridge ->> UI: Update UI and map
UI ->> Player: Display new data
end

opt Save Game
Player ->> UI: Press "Save Game" button<br>in the Game Session Menu
UI ->> Bridge: Demand that the current<br>game state is saved
Bridge ->> Simulation: Begin save routines
Simulation ->> Dataloader: Write current state to disk
Simulation ->> Bridge: Save routines completed
Bridge ->> UI: Trigger "successful save"<br>message
UI ->> Player: Give visual confirmation<br>of successful save
end

Player ->> UI: Press "Exit Game" button
UI ->> Player: Give a "Confirm quit (Y/N)"<br>dialog window
Player ->> UI: Confirm intent to quit program
UI ->> Player: Program closes
```