BOOK Record – Book

BOOK record type.

Classes:

BOOK(flags, id[, revision, version, ...])

Book.

class BOOK(flags, id, revision=0, version=15, unknown=b'\x00\x00', data=[])

Bases: Record

Book.

Parameters

• flags (int)

• id (bytes)

• revision (int) – Default 0.

• version (int) – Default 15.

• unknown (bytes) – Default b'\x00\x00'.

• data (List[RecordType]) – Default [].

Classes:

DESC([cstring])	Description.
FULL([cstring])	Name.
ICON([cstring])	Large icon filename.
MICO([cstring])	Small icon filename.
SCRI([cstring])	Script.
YNAM([cstring])	Sound - Pick Up.
ZNAM([cstring])	Sound - Drop.

Attributes:

data	Subrecords of this record.
flags	Record flags
id	4-byte form ID
revision	Used for revision control by the Creation Kit, if enabled.
unknown
version	Form version

Methods:

parse_subrecords(raw_bytes)

Parse this record's subrecords.

class DESC(cstring: Union[str, bytes] = b'')

Bases: CStringRecord

Description.

class FULL(cstring: Union[str, bytes] = b'')

Bases: CStringRecord

Name.

class ICON(cstring: Union[str, bytes] = b'')

Bases: CStringRecord

Large icon filename.

class MICO(cstring: Union[str, bytes] = b'')

Bases: CStringRecord

Small icon filename.

class SCRI(cstring: Union[str, bytes] = b'')

Bases: FormIDRecord

Script.

Form ID of a SCPT record.

class YNAM(cstring: Union[str, bytes] = b'')

Bases: FormIDRecord

Sound - Pick Up.

Form ID of a SOUN record.

class ZNAM(cstring: Union[str, bytes] = b'')

Bases: FormIDRecord

Sound - Drop.

Form ID of a SOUN record.

data

Type:    List[RecordType]

flags

Type:    int

id

Type:    bytes

classmethod parse_subrecords(raw_bytes)

Parse this record’s subrecords.

Parameters

raw_bytes (BytesIO) – Raw bytes for this record’s subrecords

Return type

Iterator[RecordType]

revision

Type:    int

unknown

Type:    bytes

version

Type:    int