Files
Grinch-AP/worlds/dlcquest/Options.py
Aaron Wagener 7193182294 Core: move option results to the World class instead of MultiWorld (#993)
🤞 

* map option objects to a `World.options` dict

* convert RoR2 to options dict system for testing

* add temp behavior for lttp with notes

* copy/paste bad

* convert `set_default_common_options` to a namespace property

* reorganize test call order

* have fill_restrictive use the new options system

* update world api

* update soe tests

* fix world api

* core: auto initialize a dataclass on the World class with the option results

* core: auto initialize a dataclass on the World class with the option results: small tying improvement

* add `as_dict` method to the options dataclass

* fix namespace issues with tests

* have current option updates use `.value` instead of changing the option

* update ror2 to use the new options system again

* revert the junk pool dict since it's cased differently

* fix begin_with_loop typo

* write new and old options to spoiler

* change factorio option behavior back

* fix comparisons

* move common and per_game_common options to new system

* core: automatically create missing options_dataclass from legacy option_definitions

* remove spoiler special casing and add back the Factorio option changing but in new system

* give ArchipIDLE the default options_dataclass so its options get generated and spoilered properly

* reimplement `inspect.get_annotations`

* move option info generation for webhost to new system

* need to include Common and PerGame common since __annotations__ doesn't include super

* use get_type_hints for the options dictionary

* typing.get_type_hints returns the bases too.

* forgot to sweep through generate

* sweep through all the tests

* swap to a metaclass property

* move remaining usages from get_type_hints to metaclass property

* move remaining usages from __annotations__ to metaclass property

* move remaining usages from legacy dictionaries to metaclass property

* remove legacy dictionaries

* cache the metaclass property

* clarify inheritance in world api

* move the messenger to new options system

* add an assert for my dumb

* update the doc

* rename o to options

* missed a spot

* update new messenger options

* comment spacing

Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com>

* fix tests

* fix missing import

* make the documentation definition more accurate

* use options system for loc creation

* type cast MessengerWorld

* fix typo and use quotes for cast

* LTTP: set random seed in tests

* ArchipIdle: remove change here as it's default on AutoWorld

* Stardew: Need to set state because `set_default_common_options` used to

* The Messenger: update shop rando and helpers to new system; optimize imports

* Add a kwarg to `as_dict` to do the casing for you

* RoR2: use new kwarg for less code

* RoR2: revert some accidental reverts

* The Messenger: remove an unnecessary variable

* remove TypeVar that isn't used

* CommonOptions not abstract

* Docs: fix mistake in options api.md

Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com>

* create options for item link worlds

* revert accidental doc removals

* Item Links: set default options on group

* change Zillion to new options dataclass

* remove unused parameter to function

* use TypeGuard for Literal narrowing

* move dlc quest to new api

* move overcooked 2 to new api

* fixed some missed code in oc2

* - Tried to be compliant with 993 (WIP?)

* - I think it all works now

* - Removed last trace of me touching core

* typo

* It now passes all tests!

* Improve options, fix all issues I hope

* - Fixed init options

* dlcquest: fix bad imports

* missed a file

* - Reduce code duplication

* add as_dict documentation

* - Use .items(), get option name more directly, fix slot data content

* - Remove generic options from the slot data

* improve slot data documentation

* remove `CommonOptions.get_value` (#21)

* better slot data description

Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>

---------

Co-authored-by: el-u <109771707+el-u@users.noreply.github.com>
Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com>
Co-authored-by: Doug Hoskisson <beauxq@yahoo.com>
Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>
Co-authored-by: Alex Gilbert <alexgilbert@yahoo.com>
2023-10-10 22:30:20 +02:00

91 lines
2.6 KiB
Python

from dataclasses import dataclass
from Options import Choice, DeathLink, PerGameCommonOptions, SpecialRange
class DoubleJumpGlitch(Choice):
"""Whether to include the double jump glitches in logic. Separated between the simple ones and the very difficult ones"""
internal_name = "double_jump_glitch"
display_name = "Double Jump glitch"
option_none = 0
option_simple = 1
option_all = 2
default = 0
class TimeIsMoney(Choice):
"""Whether the Time is Money pack is considered required to complete the grindstone.
If optional, you may be expected to grind 10 000 times by hand"""
internal_name = "time_is_money"
display_name = "Time Is Money"
option_required = 0
option_optional = 1
default = 0
class CoinSanity(Choice):
"""Whether collecting coins are checks
If none, you will collect your own coins"""
internal_name = "coinsanity"
display_name = "CoinSanity"
option_none = 0
option_coin = 1
default = 0
class CoinSanityRange(SpecialRange):
"""This is the amount of coins in a coin bundle
You need to collect that number of coins to get a location check, and when receiving coin items, you will get bundles of this size
It is highly recommended to not set this value below 10, as it generates a very large number of boring locations and items.
In the worst case, it is 1500+ checks for a single coin"""
internal_name = "coinbundlequantity"
display_name = "Coin Bundle Quantity"
range_start = 1
range_end = 100
default = 20
special_range_names = {
"low": 5,
"normal": 20,
"high": 50,
}
class EndingChoice(Choice):
"""Which ending is considered completion for the DLC Quest campaign, either any ending or the true ending"""
internal_name = "ending_choice"
display_name = "Ending Choice"
option_any = 0
option_true = 1
default = 1
class Campaign(Choice):
"""Which campaign you want to play"""
internal_name = "campaign"
display_name = "Campaign"
option_basic = 0
option_live_freemium_or_die = 1
option_both = 2
default = 0
class ItemShuffle(Choice):
"""Should Inventory Items be separate from their DLCs and shuffled in the item pool"""
internal_name = "item_shuffle"
display_name = "Item Shuffle"
option_disabled = 0
option_shuffled = 1
default = 0
@dataclass
class DLCQuestOptions(PerGameCommonOptions):
double_jump_glitch: DoubleJumpGlitch
coinsanity: CoinSanity
coinbundlequantity: CoinSanityRange
time_is_money: TimeIsMoney
ending_choice: EndingChoice
campaign: Campaign
item_shuffle: ItemShuffle
death_link: DeathLink