Skip to content

Commit

Permalink
Add docs for load_elemental_type
Browse files Browse the repository at this point in the history
  • Loading branch information
ExcaliburZero committed Nov 12, 2023
1 parent c1cf770 commit 91f98e3
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions cbpickaxe/hoylake.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,14 @@ def load_root(self, name: str, new_root: str | os.PathLike) -> None:
self.__load_translation_tables(new_root)

def load_elemental_type(self, path: str) -> Tuple[RootName, ElementalType]:
"""
Loads in the elemental type at the given res:// filepath.
Must have loaded at least one root before running.
If there is no elemental type file at that location in any of the loaded root directories,
then a ValueError will be raised.
"""
self.__check_if_root_loaded()

relative_path = Hoylake.__parse_res_path(path)
Expand Down

0 comments on commit 91f98e3

Please sign in to comment.