mirror/Archipelago
1
0
Fork 1
mirror of https://github.com/ArchipelagoMW/Archipelago.git synced 2026-03-22 07:35:37 -07:00
Code Issues Packages Projects Releases Wiki Activity

Docstrings

Browse Source
This commit is contained in:
NewSoupVi
2024-09-12 15:12:14 +02:00
committed by GitHub
parent ca2306f54f
commit 69245cb501
1 changed files with 15 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
BaseClasses.py
View File

@@ -1204,16 +1204,21 @@ class Location:
class ItemClassification(IntFlag):
filler = 0b0000 # aka trash, as in filler items like ammo, currency etc,
progression = 0b0001 # Item that is logically relevant
# Protects this item from being placed on excluded or unreachable locations.
useful = 0b0010 # Item that is especially useful.
# Protects this item from being placed on excluded or unreachable locations.
# When combined with another flag like "progression", it means "an especially useful progression item".
trap = 0b0100 # detrimental item
skip_balancing = 0b1000 # should technically never occur on its own
# Item that is logically relevant, but progression balancing should not touch.
# Typically currency or other counted items.
filler = 0b0000
""" aka trash, as in filler items like ammo, currency etc """
progression = 0b0001
""" Item that is logically relevant.
Protects this item from being placed on excluded or unreachable locations. """
useful = 0b0010
""" Item that is especially useful.
Protects this item from being placed on excluded or unreachable locations.
When combined with another flag like "progression", it means "an especially useful progression item". """
trap = 0b0100
""" detrimental item """
skip_balancing = 0b1000
""" should technically never occur on its own
Item that is logically relevant, but progression balancing should not touch.
Typically currency or other counted items. """
progression_skip_balancing = 0b1001 # only progression gets balanced
def as_flag(self) -> int: