morgan/Grinch-AP
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doc, SoE: Logic mixin: no underscore for public members (#1049)

Browse Source 
* Doc: logic mixin, drop underscore, clarify

conventionally, we added a leading underscore to logic mixins' function
names. This is noisy in the warning section of IDEs. Leading underscores
should only be used for private/protected functions.

In addition, the use of self.world and/or requirement to (no) pass in stuff
was not made clear earlier.

* SoE: fix _ warnings for logic mixin
This commit is contained in:
black-sliver
2022-09-25 18:00:22 +02:00
committed by GitHub
parent 813ee5ee3b
commit b21b5cceb8
3 changed files with 12 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
worlds/soe/Logic.py
View File

@@ -35,7 +35,7 @@ class SecretOfEvermoreLogic(LogicMixin):
if pvd[1] == progress and pvd[0] > 0:
has = True
for req in rule.requires:
if not self._soe_has(req[1], world, player, req[0]):
if not self.soe_has(req[1], world, player, req[0]):
has = False
break
if has:
@@ -44,7 +44,7 @@ class SecretOfEvermoreLogic(LogicMixin):
return n
return n
def _soe_has(self, progress: int, world: MultiWorld, player: int, count: int = 1) -> bool:
def soe_has(self, progress: int, world: MultiWorld, player: int, count: int = 1) -> bool:
"""
Returns True if count of one of evermizer's progress steps is reached based on collected items. i.e. 2 * P_DE
"""

4
worlds/soe/__init__.py
View File

@@ -283,7 +283,7 @@ class SoEWorld(World):
self.world.completion_condition[self.player] = lambda state: state.has('Victory', self.player)
# set Done from goal option once we have multiple goals
set_rule(self.world.get_location('Done', self.player),
lambda state: state._soe_has(pyevermizer.P_FINAL_BOSS, self.world, self.player))
lambda state: state.soe_has(pyevermizer.P_FINAL_BOSS, self.world, self.player))
set_rule(self.world.get_entrance('New Game', self.player), lambda state: True)
for loc in _locations:
location = self.world.get_location(loc.name, self.player)
@@ -292,7 +292,7 @@ class SoEWorld(World):
def make_rule(self, requires: typing.List[typing.Tuple[int]]) -> typing.Callable[[typing.Any], bool]:
def rule(state) -> bool:
for count, progress in requires:
if not state._soe_has(progress, self.world, self.player, count):
if not state.soe_has(progress, self.world, self.player, count):
return False
return True