`PACK` Record – Package

PACK record type.

Classes:

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

Package.

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

Bases: Record

Package.

Parameters

flags (int)
id (bytes)
revision (int) – Default 0.
version (int) – Default 15.
unknown (bytes) – Four extra bytes at end not shown in fopdoc . Default b'\x00\x00'.
data (List[RecordType]) – Default [].

Classes:

`CNAM`([cstring])	Combat Style.
`IDLF`(args, *kwargs)	Idle Animation Flags.
`IDLT`(args, *kwargs)	Idle Timer Setting.
`INAM`([cstring])	OnBegin Idle / OnEnd Idle / OnChange Idle.
`PKDD`(fov, topic, flags, unused, dialog_type, ...)	Dialog Data.
`PKDT`(general_flags, type, unused, ...)	General.
`PKE2`(args, *kwargs)	Escort Distance.
`PKFD`(args, *kwargs)	Follow - Start Location - Trigger Radius.
`PKPT`(args, *kwargs)	Patrol Flags.
`PLD2`(type, location, radius)	Location Subrecord - Location 2.
`PLDT`(type, location, radius)	Location Subrecord - Location 1.
`POBA`(args, *kwargs)	OnBegin Marker / OnEnd Marker / OnChange Marker.
`POCA`([cstring])	Unknown.
`POEA`([cstring])	Unknown.
`PSDT`(month, day_of_week, date, time, duration)	Schedule.
`PTDT`(type, target, count_or_distance, unknown)	Target 1.
`TNAM`([cstring])	OnBegin Topic / OnEnd Topic / OnChange Topic.

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`	Four extra bytes at end not shown in fopdoc
`version`	Form version

Methods:

parse_subrecords(raw_bytes)

Parse this record's subrecords.

class CNAM(cstring: Union[str, bytes] = b'')[source]

Bases: FormIDRecord

Combat Style.

Form ID of a CSTY record.

class IDLF(*args, **kwargs)[source]

Bases: Uint8Record

Idle Animation Flags.

See below for values.

class IDLT(*args, **kwargs)[source]

Bases: Float32Record

Idle Timer Setting.

class INAM(cstring: Union[str, bytes] = b'')[source]

Bases: FormIDRecord

OnBegin Idle / OnEnd Idle / OnChange Idle.

Form ID of an IDLE record, or null.

class PKDD(fov, topic, flags, unused, dialog_type, unknown)[source]

Bases: StructRecord

Dialog Data.

Parameters

fov (float)
topic (bytes) – Form ID of a DIAL record, or null.
flags (int)
unused (bytes)
dialog_type (int)
unknown (bytes) – Four extra bytes at end not shown in fopdoc

Attributes:

`dialog_type`
`flags`
`fov`
`topic`	Form ID of a `DIAL` record, or null.
`unknown`	Four extra bytes at end not shown in fopdoc
`unused`

Methods:

`get_field_names`()	Returns a list of attributes on this class in the order they should be packed.
`get_struct_and_size`()	Returns the pack/unpack struct string and the corresponding size.

dialog_type: Type: int

flags: Type: int

fov: Type: float

static get_field_names()[source]

Returns a list of attributes on this class in the order they should be packed.

Return type: Tuple[str, …]

static get_struct_and_size()[source]

Returns the pack/unpack struct string and the corresponding size.

Return type: Tuple[str, int]

topic

Type: bytes

Form ID of a DIAL record, or null.

unknown

Type: bytes

Four extra bytes at end not shown in fopdoc

unused: Type: bytes

class PKDT(general_flags, type, unused, fallout_behaviour_flags, type_specific_flags, unused_)[source]

Bases: StructRecord

General.

Parameters

general_flags (int)
type (int)
unused (bytes)
fallout_behaviour_flags (int)
type_specific_flags (int)
unused

Attributes:

`fallout_behaviour_flags`
`general_flags`
`type`
`type_specific_flags`
`unused`
`unused_`

Methods:

`get_field_names`()	Returns a list of attributes on this class in the order they should be packed.
`get_struct_and_size`()	Returns the pack/unpack struct string and the corresponding size.

fallout_behaviour_flags: Type: int

general_flags: Type: int

static get_field_names()[source]

Returns a list of attributes on this class in the order they should be packed.

Return type: Tuple[str, …]

static get_struct_and_size()[source]

Returns the pack/unpack struct string and the corresponding size.

Return type: Tuple[str, int]

type: Type: int

type_specific_flags: Type: int

unused: Type: bytes

unused_: Type: bytes

class PKE2(*args, **kwargs)[source]

Bases: Uint32Record

Escort Distance.

class PKFD(*args, **kwargs)[source]

Bases: Float32Record

Follow - Start Location - Trigger Radius.

class PKPT(*args, **kwargs)[source]

Bases: Uint16Record

Patrol Flags.

class PLD2(type, location, radius)[source]

Bases: PLDT

Location Subrecord - Location 2.

Parameters

type (int)
location (bytes) – Form ID or uint32 (as bytes) or uint8[] (as bytes) See https://tes5edit.github.io/fopdoc/Fallout3/Records/PACK.html
radius (int)

Attributes:

`location`	Form ID or uint32 (as bytes) or uint8[] (as bytes)
`radius`
`type`

location

Type: bytes

Form ID or uint32 (as bytes) or uint8[] (as bytes)See https://tes5edit.github.io/fopdoc/Fallout3/Records/PACK.html

radius: Type: int

type: Type: int

class PLDT(type, location, radius)[source]

Bases: StructRecord

Location Subrecord - Location 1.

Parameters

type (int)
location (bytes) – Form ID or uint32 (as bytes) or uint8[] (as bytes) See https://tes5edit.github.io/fopdoc/Fallout3/Records/PACK.html
radius (int)

Methods:

`get_field_names`()	Returns a list of attributes on this class in the order they should be packed.
`get_struct_and_size`()	Returns the pack/unpack struct string and the corresponding size.

Attributes:

`location`	Form ID or uint32 (as bytes) or uint8[] (as bytes)
`radius`
`type`

static get_field_names()[source]

Returns a list of attributes on this class in the order they should be packed.

Return type: Tuple[str, …]

static get_struct_and_size()[source]

Returns the pack/unpack struct string and the corresponding size.

Return type: Tuple[str, int]

location

Type: bytes

Form ID or uint32 (as bytes) or uint8[] (as bytes)

See https://tes5edit.github.io/fopdoc/Fallout3/Records/PACK.html

radius: Type: int

type: Type: int

class POBA(*args, **kwargs)[source]

Bases: MarkerRecord

OnBegin Marker / OnEnd Marker / OnChange Marker.

class POCA(cstring: Union[str, bytes] = b'')[source]

Bases: RawBytesRecord

Unknown.

Not shown in fopdoc.

class POEA(cstring: Union[str, bytes] = b'')[source]

Bases: RawBytesRecord

Unknown.

Not shown in fopdoc.

class PSDT(month, day_of_week, date, time, duration)[source]

Bases: StructRecord

Schedule.

Parameters

month (int)
day_of_week (int)
date (int)
time (int)
duration (int)

Attributes:

`date`
`day_of_week`
`duration`
`month`
`time`

Methods:

`get_field_names`()	Returns a list of attributes on this class in the order they should be packed.
`get_struct_and_size`()	Returns the pack/unpack struct string and the corresponding size.

date: Type: int

day_of_week: Type: int

duration: Type: int

static get_field_names()[source]

Returns a list of attributes on this class in the order they should be packed.

Return type: Tuple[str, …]

static get_struct_and_size()[source]

Returns the pack/unpack struct string and the corresponding size.

Return type: Tuple[str, int]

month: Type: int

time: Type: int

class PTDT(type, target, count_or_distance, unknown)[source]

Bases: StructRecord

Target 1.

Parameters

type (int)
target (bytes) – Form ID or uint32 (as bytes) or uint8[] (as bytes)
count_or_distance (int)
unknown (float) – Four extra bytes at end not shown in fopdoc

Attributes:

`count_or_distance`
`target`	Form ID or uint32 (as bytes) or uint8[] (as bytes)
`type`
`unknown`	Four extra bytes at end not shown in fopdoc

Methods:

`get_field_names`()	Returns a list of attributes on this class in the order they should be packed.
`get_struct_and_size`()	Returns the pack/unpack struct string and the corresponding size.

count_or_distance: Type: int

static get_field_names()[source]

Returns a list of attributes on this class in the order they should be packed.

Return type: Tuple[str, …]

static get_struct_and_size()[source]

Returns the pack/unpack struct string and the corresponding size.

Return type: Tuple[str, int]

target

Type: bytes

Form ID or uint32 (as bytes) or uint8[] (as bytes)

type: Type: int

unknown

Type: float

Four extra bytes at end not shown in fopdoc

class TNAM(cstring: Union[str, bytes] = b'')[source]

Bases: FormIDRecord

OnBegin Topic / OnEnd Topic / OnChange Topic.

Form ID of a DIAL record, or null.

data: Type: List[RecordType]

flags: Type: int

id: Type: bytes

classmethod parse_subrecords(raw_bytes)[source]

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

Four extra bytes at end not shown in fopdoc

version: Type: int

PACK Record – Package

`PACK` Record – Package