mirror of
https://github.com/LmeSzinc/StarRailCopilot.git
synced 2024-11-16 14:31:16 +00:00
110 lines
3.3 KiB
Python
110 lines
3.3 KiB
Python
from dataclasses import dataclass
|
|
from functools import cached_property
|
|
from typing import ClassVar
|
|
|
|
from module.exception import ScriptError
|
|
from module.ocr.keyword import Keyword
|
|
|
|
|
|
@dataclass(repr=False)
|
|
class MapPlane(Keyword):
|
|
instances: ClassVar = {}
|
|
|
|
# Map floors, 'F1' by default
|
|
# Example: ['B1', 'F1', 'F2']
|
|
floors = ['F1']
|
|
|
|
# Page on bigmap sidebar
|
|
# 'top' or 'bottom'
|
|
page = 'top'
|
|
|
|
@cached_property
|
|
def world(self) -> str:
|
|
"""
|
|
Returns:
|
|
str: World name. Note that "Parlor Car" is considered as a plane of Herta.
|
|
"Herta" for Herta Space Station
|
|
"Jarilo" for Jarilo-VI
|
|
"Luofu" for The Xianzhou Luofu
|
|
"" for unknown
|
|
"""
|
|
for world in ['Herta', 'Jarilo', 'Luofu']:
|
|
if self.name.startswith(world):
|
|
return world
|
|
|
|
return ''
|
|
|
|
@cached_property
|
|
def is_HertaSpaceStation(self):
|
|
return self.world == 'Herta'
|
|
|
|
@cached_property
|
|
def is_JariloVI(self):
|
|
return self.world == 'Jarilo'
|
|
|
|
@cached_property
|
|
def is_Luofu(self):
|
|
return self.world == 'Luofu'
|
|
|
|
@cached_property
|
|
def has_multiple_floors(self):
|
|
return self.floors and self.floors != ['F1']
|
|
|
|
def convert_to_floor_index(self, floor: str | int) -> int:
|
|
"""
|
|
Args:
|
|
floor: int for floor index counted from bottom, such as 1, 2, 3
|
|
str for floor names in game, such as "B1", "F1", "F2"
|
|
|
|
Returns:
|
|
int: 1 to 3 counted from bottom.
|
|
|
|
Raises:
|
|
ScriptError: If floor doesn't exist
|
|
"""
|
|
if isinstance(floor, int):
|
|
# Check exist
|
|
try:
|
|
_ = self.floors[floor - 1]
|
|
return floor
|
|
except IndexError:
|
|
raise ScriptError(f'Plane {self} does not have floor index {floor}')
|
|
elif isinstance(floor, str):
|
|
# Convert to floor index
|
|
floor = floor.upper()
|
|
try:
|
|
return self.floors.index(floor) + 1
|
|
except IndexError:
|
|
raise ScriptError(f'Plane {self} does not have floor name {floor}')
|
|
else:
|
|
raise ScriptError(f'Plane {self} does not have floor {floor}')
|
|
|
|
def convert_to_floor_name(self, floor: str | int) -> str:
|
|
"""
|
|
Args:
|
|
floor: int for floor index counted from bottom, such as 1, 2, 3
|
|
str for floor names in game, such as "B1", "F1", "F2"
|
|
|
|
Returns:
|
|
str: Floor names in game, such as "B1", "F1", "F2"
|
|
|
|
Raises:
|
|
ScriptError: If floor doesn't exist
|
|
"""
|
|
if isinstance(floor, int):
|
|
# Convert to floor index
|
|
try:
|
|
return self.floors[floor - 1]
|
|
except IndexError:
|
|
raise ScriptError(f'Plane {self} does not have floor index {floor}')
|
|
elif isinstance(floor, str):
|
|
# Check exist
|
|
floor = floor.upper()
|
|
try:
|
|
_ = self.floors.index(floor) + 1
|
|
return floor
|
|
except IndexError:
|
|
raise ScriptError(f'Plane {self} does not have floor name {floor}')
|
|
else:
|
|
raise ScriptError(f'Plane {self} does not have floor {floor}')
|