Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: typo in test example

Browse source
This commit is contained in:
Blade Boles 2023-07-05 20:33:24 -06:00
parent 98ce816e39
commit 15b1a287d4
1 changed files with 261 additions and 263 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/source/Howtos/Beginner-Tutorial/Part3/Beginner-Tutorial-Rules.md
View file

@ -39,7 +39,6 @@ new character max HP to start.
- _Knave_ also have random tables, such as for starting equipment and to see if dying when - _Knave_ also have random tables, such as for starting equipment and to see if dying when
hitting 0. Death, if it happens, is permanent. hitting 0. Death, if it happens, is permanent.
## Making a rule module ## Making a rule module
> Create a new module mygame/evadventure/rules.py > Create a new module mygame/evadventure/rules.py
@ -48,6 +47,7 @@ hitting 0. Death, if it happens, is permanent.
A complete version of the rule module is found in A complete version of the rule module is found in
[evennia/contrib/tutorials/evadventure/rules.py](../../../api/evennia.contrib.tutorials.evadventure.rules.md). [evennia/contrib/tutorials/evadventure/rules.py](../../../api/evennia.contrib.tutorials.evadventure.rules.md).
``` ```
There are three broad sets of rules for most RPGS: There are three broad sets of rules for most RPGS:
- Character generation rules, often only used during character creation - Character generation rules, often only used during character creation
@ -57,7 +57,6 @@ There are three broad sets of rules for most RPGS:
We want our `rules` module to cover as many aspeects of what we'd otherwise would have to look up We want our `rules` module to cover as many aspeects of what we'd otherwise would have to look up
in a rulebook. in a rulebook.
## Rolling dice ## Rolling dice
We will start by making a dice roller. Let's group all of our dice rolling into a structure like this We will start by making a dice roller. Let's group all of our dice rolling into a structure like this
@ -94,6 +93,7 @@ class EvAdventureRollEngine:
dice = EvAdventureRollEngine() dice = EvAdventureRollEngine()
``` ```
```{sidebar} ```{sidebar}
This groups all dice-related code into one 'container' that is easy to import. But it's mostly a matter This groups all dice-related code into one 'container' that is easy to import. But it's mostly a matter
of taste. You _could_ also break up the class' methods into normal functions at the top-level of the of taste. You _could_ also break up the class' methods into normal functions at the top-level of the
@ -156,6 +156,7 @@ in a specific range. The line
```python ```python
sum(randint(1, diesize) for _ in range(number)) sum(randint(1, diesize) for _ in range(number))
``` ```
works like this: works like this:
- For a certain `number` of times ... - For a certain `number` of times ...
@ -223,6 +224,7 @@ have it figure things out:
```python ```python
result, quality = dice.saving_throw(character, Ability.STR) result, quality = dice.saving_throw(character, Ability.STR)
``` ```
The return will be a boolean `True/False` if they pass, as well as a `quality` that tells us if The return will be a boolean `True/False` if they pass, as well as a `quality` that tells us if
a perfect fail/success was rolled or not. a perfect fail/success was rolled or not.
@ -379,7 +381,6 @@ number of HPs
> Knowing what is available on the character and what rule rolls we need is a bit of a chicken-and-egg > Knowing what is available on the character and what rule rolls we need is a bit of a chicken-and-egg
> problem. We will make sure to implement the matching _Character_ class next lesson. > problem. We will make sure to implement the matching _Character_ class next lesson.
### Rolling on a table ### Rolling on a table
We occasionally need to roll on a 'table' - a selection of choices. There are two main table-types We occasionally need to roll on a 'table' - a selection of choices. There are two main table-types
@ -388,7 +389,7 @@ we need to support:
Simply one element per row of the table (same odds to get each result). Simply one element per row of the table (same odds to get each result).
| Result | | Result |
|:------:| | :----: |
| item1 | | item1 |
| item2 | | item2 |
| item3 | | item3 |
@ -403,7 +404,7 @@ This we will simply represent as a plain list
Ranges per item (varying odds per result): Ranges per item (varying odds per result):
| Range | Result | | Range | Result |
|:-----:|:------:| | :---: | :----: |
| 1-5 | item1 | | 1-5 | item1 |
| 6-15 | item2 | | 6-15 | item2 |
| 16-19 | item3 | | 16-19 | item3 |
@ -461,9 +462,11 @@ class EvAdventureRollEngine:
roll_result = max(1, min(len(table_choices), roll_result)) roll_result = max(1, min(len(table_choices), roll_result))
return table_choices[roll_result - 1] return table_choices[roll_result - 1]
``` ```
Check that you understand what this does. Check that you understand what this does.
This may be confusing: This may be confusing:
```python ```python
minval, *maxval = valrange.split("-", 1) minval, *maxval = valrange.split("-", 1)
minval = abs(int(minval)) minval = abs(int(minval))
@ -484,7 +487,6 @@ maxval = abs(int(maxval[0]) if maxval else minval)
we check if `maxval` actually has a value `("5",)` or if its empty `()`. The result is either we check if `maxval` actually has a value `("5",)` or if its empty `()`. The result is either
`"5"` or the value of `minval`. `"5"` or the value of `minval`.
### Roll for death ### Roll for death
While original Knave suggests hitting 0 HP means insta-death, we will grab the optional "death table" While original Knave suggests hitting 0 HP means insta-death, we will grab the optional "death table"
@ -492,8 +494,8 @@ from the "prettified" Knave's optional rules to make it a little less punishing.
result of `2` to 'dead' since we don't simulate 'dismemberment' in this tutorial: result of `2` to 'dead' since we don't simulate 'dismemberment' in this tutorial:
| Roll | Result | -1d4 Loss of Ability | | Roll | Result | -1d4 Loss of Ability |
|:---: |:--------:|:--------------------:| | :--: | :--------: | :------------------: |
| 1-2 | dead | - | 1-2 | dead | - |
| 3 | weakened | STR | | 3 | weakened | STR |
| 4 | unsteady | DEX | | 4 | unsteady | DEX |
| 5 | sickly | CON | | 5 | sickly | CON |
@ -584,7 +586,7 @@ class TestEvAdventureRuleEngine(BaseEvenniaTest):
@patch("evadventure.rules.randint") @patch("evadventure.rules.randint")
def test_roll(self, mock_randint): def test_roll(self, mock_randint):
mock_randint.return_value = 4 mock_randint.return_value = 4
self.assertEqual(self.roll_engine.roll("1d6", 4)) self.assertEqual(self.roll_engine.roll("1d6"), 4)
self.assertEqual(self.roll_engine.roll("2d6"), 2 * 4) self.assertEqual(self.roll_engine.roll("2d6"), 2 * 4)
# test of the other rule methods below ... # test of the other rule methods below ...
@ -600,6 +602,7 @@ As before, run the specific test with
In [evennia/contrib/tutorials/evadventure/tests/test_rules.py](../../../api/evennia.contrib.tutorials.evadventure.tests.test_rules.md) In [evennia/contrib/tutorials/evadventure/tests/test_rules.py](../../../api/evennia.contrib.tutorials.evadventure.tests.test_rules.md)
has a complete example of rule testing. has a complete example of rule testing.
``` ```
The `setUp` method is a special method of the testing class. It will be run before every The `setUp` method is a special method of the testing class. It will be run before every
test method. We use `super().setUp()` to make sure the parent class' version of this method test method. We use `super().setUp()` to make sure the parent class' version of this method
always fire. Then we create a fresh `EvAdventureRollEngine` we can test with. always fire. Then we create a fresh `EvAdventureRollEngine` we can test with.
@ -626,8 +629,3 @@ them for further help.
This concludes all the core rule mechanics of _Knave_ - the rules used during play. We noticed here This concludes all the core rule mechanics of _Knave_ - the rules used during play. We noticed here
that we are going to soon need to establish how our _Character_ actually stores data. So we will that we are going to soon need to establish how our _Character_ actually stores data. So we will
address that next. address that next.