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

api.md: add set Location.event in location skeleton

This commit is contained in:
black-sliver 2021-10-10 14:03:33 +02:00
parent 818e99b39d
commit 2f04b93fdb
1 changed files with 5 additions and 4 deletions
docs
api.md

9
docs/api.md
View File

@ -202,13 +202,14 @@ from BasClasses import Location
class MyGameLocation(Location): class MyGameLocation(Location):
game: str = "My Game" game: str = "My Game"
# override constructor to automatically mark event locations as such
def __init__(self, player: int, name = '', code = None, parent = None):
super(MyGameLocation, self).__init__(player, name, code, parent)
self.event = code is None
``` ```
in your `__init__.py` or your `Locations.py`. in your `__init__.py` or your `Locations.py`.
**FIXME**: Is setting Location.event actually required? Minecraft and OoT
do that. Factorio does not. What's the goal of doing that? When factorio places
a locked item this will do Location.event = item.advancement.
### Options ### Options
By convention options are defined in `Options.py` and will be used when parsing By convention options are defined in `Options.py` and will be used when parsing