docs: Improve documentation at Klondike Tutorial Step 5 #3078
Conversation
|
I am still working there. Please feel free to discuss about this PR |
nickf2k
force-pushed
the
docs-improve-klondike-step-5
branch
from
2e47588 to
bf1592a
Compare
doc/tutorials/klondike/step5.md
Outdated
| @@ -413,6 +413,141 @@ FlameGame. The new world contains (almost) everything we need to play the game a | |||
| re-created during each of the above actions. | |||
|
|
|||
|
|
|||
| ### KlondikeWorld class | |||
|
|
|||
| In Flame, a ```World``` is a type of ```Component``` that can contain other ```Components```, | |||
There was a problem hiding this comment.
These should only have a single back-tick, tripple back-ticks are for multi-line code
|
@nickf2k any update on this? |
|
@nickf2k are you planning to continue working on this PR? |
|
@spydon |
|
@spydon To avoid forgetting, I set a deadline for myself to complete this PR for you to review by next Tuesday. Thank you |
|
|
||
| You can learn more about `World` in game programming here: | ||
|
|
||
| - An introduction to `World` in game programming: [Ecampus](https://ecampusontario.pressbooks.pub/gamedesigndevelopmenttextbook/chapter/what-is-a-game-world/) |
There was a problem hiding this comment.
We shouldn't have links to external resourced in here, you can link to the world section in the docs instead.
| Ohhh, so what happened to the `onLoad()` method? Well, previously, `KlondikeGame` handled everything in the `onLoad()` method, managing all the game components like `Piles` and `Cards`. But now, to make things cleaner and more organized, we’ve moved that responsibility over to `KlondikeWorld`. | ||
|
|
||
| Everything that used to be inside the `onLoad()` method of `KlondikeGame` is now in `KlondikeWorld`'s `onLoad()` method. This keeps the code more modular, meaning it's easier to maintain and update. Instead of `KlondikeGame` getting messy with too many tasks, we let `KlondikeWorld` handle the game setup and logic. | ||
|
|
||
| And what’s this `seed` thing? Ah, good question! So, the `seed` attribute is like a magic key. It lets you replay the same game configuration by selecting `Action.sameDeal`. This is super useful when you want to give players the option to retry the exact same game setup. The `seed` ensures that the randomness in the game (like card shuffling) can be repeated exactly the same way. Think of it as a way to recreate the same starting point in a game. | ||
|
|
||
| So, with the `seed` safely stored in `KlondikeGame`, the `KlondikeWorld` can use it to keep everything consistent between rounds. If you choose `Action.sameDeal`, it will load the same shuffled deck and game state, letting you replay that round with the same starting conditions. Pretty cool, right? |
There was a problem hiding this comment.
Formatting (max 100 line length)
|
@nickf2k any updates planned for this PR? :) |
Description
This PR for solving the issue #3076
1. What would I do to improve this tutorial:
2. Contents I will add or modify:
I believe these sections are satisfactory, so I won't make any edits to them. I will begin editing from the section: A New World.
Immediately after the
Start and restart actionssection, I will provide an explanation of the "KlondikeWorld" class. Consequently, the adjustment of the "KlondikeGame" class is merely a necessary step when migrating the onLoad() function to KlondikeWorld, rendering the "A stripped-down KlondikeGame class" section redundant.The section
Using a Random Number Generator seedappears reasonable. However, I intend to supplement more references to this definition of "seed." If you have any documents or suggestions on this topic, please provide further information. Otherwise, I will utilize the following link: Link to Reddit.The section
Introducing the new KlondikeWorld classwas previously covered, hence it will be omitted here. Please note that I will enrich the previous instruction with additional details.Button: I will retain and expand upon this section as it lacks significant information.Anchors and coordinates: This section may be considered supplementary information within the Button section. Therefore, I will incorporate and merge it into the Button section.The deal() method: I will maintain this section in its current position, perhaps making minor sentence edits or none at all.More animations of moves: Similar to the section "The deal() method."A graphics glitch: As above.Winning the game: I find this section quite comprehensive; hence, I may not make any alterations.Ending a game and restarting it: This section lacks crucial details and is rather confusing. I will rewrite it to clarify.Have fun button: This section is well-structured; therefore, I may retain it with minor adjustments if necessary.Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?
Related Issues
This PR solve the issue #3076