monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: change displayname to display_name in api.md

This commit is contained in:
black-sliver 2022-02-02 23:33:26 +01:00 committed by Fabian Dill
parent dc4b064c73
commit 29ba1d4809
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api.md
View File

@ -217,7 +217,7 @@ By convention options are defined in `Options.py` and will be used when parsing
the players' yaml files. the players' yaml files.
Each option has its own class, inherits from a base option type, has a docstring Each option has its own class, inherits from a base option type, has a docstring
to describe it and a `displayname` property for display on the website and in to describe it and a `display_name` property for display on the website and in
spoiler logs. spoiler logs.
The actual name as used in the yaml is defined in a `dict[str, Option]`, that is The actual name as used in the yaml is defined in a `dict[str, Option]`, that is
@ -263,7 +263,7 @@ import typing
class Difficulty(Choice): class Difficulty(Choice):
"""Sets overall game difficulty.""" """Sets overall game difficulty."""
displayname = "Difficulty" display_name = "Difficulty"
option_easy = 0 option_easy = 0
option_normal = 1 option_normal = 1
option_hard = 2 option_hard = 2
@ -273,14 +273,14 @@ class Difficulty(Choice):
class FinalBossHP(Range): class FinalBossHP(Range):
"""Sets the HP of the final boss""" """Sets the HP of the final boss"""
displayname = "Final Boss HP" display_name = "Final Boss HP"
range_start = 100 range_start = 100
range_end = 10000 range_end = 10000
default = 2000 default = 2000
class FixXYZGlitch(Toggle): class FixXYZGlitch(Toggle):
"""Fixes ABC when you do XYZ""" """Fixes ABC when you do XYZ"""
displayname = "Fix XYZ Glitch" display_name = "Fix XYZ Glitch"
# By convention we call the options dict variable `<world>_options`. # By convention we call the options dict variable `<world>_options`.
mygame_options: typing.Dict[str, type(Option)] = { mygame_options: typing.Dict[str, type(Option)] = {