Hylics 2: Update option docstrings (#3359)

* Update Options.py

* "pool" -> "item pool"
This commit is contained in:
Trevor L 2024-05-21 15:53:00 -06:00 committed by GitHub
parent 5c66681233
commit 9441cc31b7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 30 additions and 8 deletions

View File

@ -1,25 +1,38 @@
from dataclasses import dataclass from dataclasses import dataclass
from Options import Choice, Removed, Toggle, DefaultOnToggle, DeathLink, PerGameCommonOptions from Options import Choice, Removed, Toggle, DefaultOnToggle, DeathLink, PerGameCommonOptions
class PartyShuffle(Toggle): class PartyShuffle(Toggle):
"""Shuffles party members into the pool. """
Note that enabling this can potentially increase both the difficulty and length of a run.""" Shuffles party members into the item pool.
Note that enabling this can significantly increase both the difficulty and length of a run.
"""
display_name = "Shuffle Party Members" display_name = "Shuffle Party Members"
class GestureShuffle(Choice): class GestureShuffle(Choice):
"""Choose where gestures will appear in the item pool.""" """
Choose where gestures will appear in the item pool.
"""
display_name = "Shuffle Gestures" display_name = "Shuffle Gestures"
option_anywhere = 0 option_anywhere = 0
option_tvs_only = 1 option_tvs_only = 1
option_default_locations = 2 option_default_locations = 2
default = 0 default = 0
class MedallionShuffle(Toggle): class MedallionShuffle(Toggle):
"""Shuffles red medallions into the pool.""" """
Shuffles red medallions into the item pool.
"""
display_name = "Shuffle Red Medallions" display_name = "Shuffle Red Medallions"
class StartLocation(Choice): class StartLocation(Choice):
"""Select the starting location from 1 of 4 positions.""" """
Select the starting location from 1 of 4 positions.
"""
display_name = "Start Location" display_name = "Start Location"
option_waynehouse = 0 option_waynehouse = 0
option_viewaxs_edifice = 1 option_viewaxs_edifice = 1
@ -35,14 +48,23 @@ class StartLocation(Choice):
return "TV Island" return "TV Island"
return super().get_option_name(value) return super().get_option_name(value)
class ExtraLogic(DefaultOnToggle): class ExtraLogic(DefaultOnToggle):
"""Include some extra items in logic (CHARGE UP, 1x PAPER CUP) to prevent the game from becoming too difficult.""" """
Include some extra items in logic (CHARGE UP, 1x PAPER CUP) to prevent the game from becoming too difficult.
"""
display_name = "Extra Items in Logic" display_name = "Extra Items in Logic"
class Hylics2DeathLink(DeathLink): class Hylics2DeathLink(DeathLink):
"""When you die, everyone dies. The reverse is also true. """
When you die, everyone dies. The reverse is also true.
Note that this also includes death by using the PERISH gesture. Note that this also includes death by using the PERISH gesture.
Can be toggled via in-game console command "/deathlink"."""
Can be toggled via in-game console command "/deathlink".
"""
@dataclass @dataclass
class Hylics2Options(PerGameCommonOptions): class Hylics2Options(PerGameCommonOptions):