diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/general-program-architecture.md | 4 | ||||
| -rw-r--r-- | docs/simulation/goods.md | 2 | ||||
| -rw-r--r-- | docs/simulation/ideologies.md | 4 | ||||
| -rw-r--r-- | docs/simulation/provinces.md | 16 | ||||
| -rw-r--r-- | docs/styleguide-cpp.md | 6 |
5 files changed, 16 insertions, 16 deletions
diff --git a/docs/general-program-architecture.md b/docs/general-program-architecture.md index 533a8fa..c37d390 100644 --- a/docs/general-program-architecture.md +++ b/docs/general-program-architecture.md @@ -19,14 +19,14 @@ 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 savegame<br>(If necessary) -Dataloader -->> Simulation: +Dataloader -->> Simulation: 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 +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 diff --git a/docs/simulation/goods.md b/docs/simulation/goods.md index 15b4864..f8204b0 100644 --- a/docs/simulation/goods.md +++ b/docs/simulation/goods.md @@ -28,7 +28,7 @@ classDiagram Good o-- GoodCategory ``` -## Data +## Data ### Vanilla diff --git a/docs/simulation/ideologies.md b/docs/simulation/ideologies.md index f56cda7..817bdb3 100644 --- a/docs/simulation/ideologies.md +++ b/docs/simulation/ideologies.md @@ -27,7 +27,7 @@ classDiagram ``` -## Data +## Data ### Vanilla @@ -41,7 +41,7 @@ classDiagram |communist|socialist|1865/01/01|False|#960A0A| |fascist|fascist|1905/01/01|False|#3C3C3C| -### John Cena +### John Cena |Identifier|Ideological Group|Earliest Date|Uncivilized Nations|Colour| |--|--|--|--|--| diff --git a/docs/simulation/provinces.md b/docs/simulation/provinces.md index 88eea50..642ff11 100644 --- a/docs/simulation/provinces.md +++ b/docs/simulation/provinces.md @@ -5,16 +5,16 @@ ```mermaid classDiagram class Province { - Int64 id - string provinceName - string tradeGood - Int64 lifeRating - bool hasLegalSlavery + Int64 id + string provinceName + string tradeGood + Int64 lifeRating + bool hasLegalSlavery - Int64 fortLevel - Int64 navalBaseLevel + Int64 fortLevel + Int64 navalBaseLevel Int64 railroadLevel - + string regionId string continentId } diff --git a/docs/styleguide-cpp.md b/docs/styleguide-cpp.md index 69471f5..6440314 100644 --- a/docs/styleguide-cpp.md +++ b/docs/styleguide-cpp.md @@ -1,4 +1,4 @@ -# OpenVic2 C++ Style Guidelines +# OpenVic2 C++ Style Guidelines ## Table of Contents 1. [Why Style?](styleguide-cpp.md#1-why-style) @@ -169,7 +169,7 @@ Source code files should adhere to the following: longArgumentNameOne, longArgumentNameTwo, longArgumentNameThree, longArgumentNameFour, longArgumentNameFive, longArgumentNameSix, longArgumentNameSeven, longArgumentNameEight); - + //Incorrect callingAFunctionWithAVeryLongNameAndManyArguments(longArgumentNameOne, longArgumentNameTwo, longArgumentNameThree, longArgumentNameFour, longArgumentNameFive, longArgumentNameSix, longArgumentNameSeven, longArgumentNameEight); ``` @@ -255,7 +255,7 @@ Source code files should adhere to the following: - For constant values that are computable at compile-time, use `constexpr` instead of the `const` keyword ```c++ //Correct - constexpr size_t UNIQUE_RGB_COLOURS = 256 * 256 * 256; + constexpr size_t UNIQUE_RGB_COLOURS = 256 * 256 * 256; //Incorrect const size_t UNIQUE_RGB_COLOURS = 256 * 256 * 256; |