#!/usr/bin/env python3
#
# _alch.py
"""
ALCH record type.
"""
#
# Copyright © 2024 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
# OR OTHER DEALINGS IN THE SOFTWARE.
#
# stdlib
from io import BytesIO
from typing import Iterator, Tuple
# 3rd party
import attrs
# this package
from esp_parser.subrecords import CTDA, EDID, OBND, Destruction, Effect, Model
from esp_parser.types import (
CStringRecord,
Float32Record,
FormIDRecord,
Int32Record,
Record,
RecordType,
StructRecord
)
__all__ = ["ALCH"]
[docs]class ALCH(Record):
"""
Ingestible.
"""
[docs] class FULL(CStringRecord):
"""
Name.
"""
[docs] class ICON(CStringRecord):
"""
Large Icon Filename.
"""
[docs] class MICO(CStringRecord):
"""
Small Icon FIlename.
"""
[docs] class SCRI(FormIDRecord):
"""
Script.
Form ID of a :class:`~.SCPT` record.
"""
[docs] class YNAM(FormIDRecord):
"""
Sound - Pick Up.
Form ID of a :class:`~.SOUN` record.
"""
[docs] class ZNAM(FormIDRecord):
"""
Sound - Drop.
Form ID of a :class:`~.SOUN` record.
"""
[docs] class ETYP(Int32Record):
"""
Equipment Type.
See https://tes5edit.github.io/fopdoc/Fallout3/Records/Subrecords/ETYP.html for enum values.
"""
[docs] class DATA(Float32Record):
"""
Weight.
"""
[docs] @attrs.define
class ENIT(StructRecord):
"""
Effect Data.
"""
value: int
flags: int # See https://tes5edit.github.io/fopdoc/Fallout3/Records/ALCH.html
unused: bytes
#: Form ID of a :class:`~.SPEL` record, or null.
withdrawal_effect: bytes
addiction_chance: float
#: Form ID of a :class:`~.SOUN` record, or null.
sound_consume: bytes
[docs] @staticmethod
def get_struct_and_size() -> Tuple[str, int]:
"""
Returns the pack/unpack struct string and the corresponding size.
"""
return "<iB3s4sf4s", 20
[docs] @staticmethod
def get_field_names() -> Tuple[str, ...]:
"""
Returns a list of attributes on this class in the order they should be packed.
"""
return ("value", "flags", "unused", "withdrawal_effect", "addiction_chance", "sound_consume")
[docs] @classmethod
def parse_subrecords(cls, raw_bytes: BytesIO) -> Iterator[RecordType]:
"""
Parse this record's subrecords.
:param raw_bytes: Raw bytes for this record's subrecords
"""
while True:
record_type = raw_bytes.read(4)
if not record_type:
break
if record_type == b"EDID":
yield EDID.parse(raw_bytes)
elif record_type == b"OBND":
yield OBND.parse(raw_bytes)
elif record_type == b"CTDA":
yield CTDA.parse(raw_bytes)
elif record_type in {b"DATA", b"ENIT", b"ETYP", b"FULL", b"ICON", b"MICO", b"SCRI", b"YNAM", b"ZNAM"}:
yield getattr(cls, record_type.decode()).parse(raw_bytes)
elif record_type in Model.members:
yield Model.parse_member(record_type, raw_bytes)
elif record_type in Destruction.members:
yield Destruction.parse_member(record_type, raw_bytes)
elif record_type in Effect.members:
yield Effect.parse_member(record_type, raw_bytes)
else:
raise NotImplementedError(record_type)