REFR Record – Placed Object

REFR record type.

Classes:

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

Placed Object.

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

Bases: Record

Placed Object.

Parameters

• flags (int)

• id (bytes)

• revision (int) – Default 0.

• version (int) – Default 15.

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

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

Classes:

BNAM([cstring])	Unknown.
CNAM([cstring])	Audio location (New Vegas only).
FNAM(*args, **kwargs)	Map Marker Flags.
FULL([cstring])	Map Marker Name.
INAM([cstring])	Patrol data - Idle.
MMRK(*args, **kwargs)	Audio marker (New Vegas only).
MNAM(*args, **kwargs)	Unknown.
NAME([cstring])	The placed object.
NNAM(*args, **kwargs)	Unknown.
TNAM(type, unused)	Map Marker Data.
WMI1([cstring])	Map Marker Reputation.
XACT(*args, **kwargs)	Action Flag.
XAMC(*args, **kwargs)	Ammo Count.
XAMT([cstring])	Ammo Type.
XAPD(*args, **kwargs)	Activate parents flags.
XATO([cstring])	Activation Prompt.
XCHG(*args, **kwargs)	Charge.
XCNT(*args, **kwargs)	Count.
XEMI([cstring])	Emittance.
XEZN([cstring])	Encounter Zone.
XHLP(*args, **kwargs)	Health.
XLCM(*args, **kwargs)	Level Modifier.
XLKR([cstring])	Linked Reference.
XLOC(level, unused, key, flags, unknown)	Lock Data.
XLRM([cstring])	Linked Room.
XLTW([cstring])	Lit Water.
XMBO(x, y, z)	Bound Half Extents.
XMBR([cstring])	MultiBound Reference.
XMRK(*args, **kwargs)	Map Marker Marker.
XNDP(navmesh, unknown)	Navigation Door Link.
XOWN([cstring])	Owner.
XPRD(*args, **kwargs)	Patrol data - idle time.
XPRM(x_bound, y_bound, z_bound, red, green, ...)	Primitive.
XRAD(*args, **kwargs)	Radiation.
XRDO(range_radius, broadcast_range_type[, ...])	Radio Data.
XRDS(*args, **kwargs)	Radius.
XRGB([cstring])	Ragdoll Biped Data.
XRGD([cstring])	Ragdoll Data.
XRNK(*args, **kwargs)	Faction Rank.
XSCL(*args, **kwargs)	Scale.
XSED(*args, **kwargs)	SpeedTree Seed.
XTEL(door, xp, yp, zp, xr, yr, zr, flags)	Teleport Destination.
XTRG([cstring])	Target.
XTRI(*args, **kwargs)	Collision Layer.

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 BNAM(cstring: Union[str, bytes] = b'')

Bases: RawBytesRecord

Unknown.

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

Bases: FormIDRecord

Audio location (New Vegas only).

Form ID of a ALOC record.

class FNAM(*args, **kwargs)

Bases: Uint8Record

Map Marker Flags.

See https://tes5edit.github.io/fopdoc/FalloutNV/Records/REFR.html

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

Bases: CStringRecord

Map Marker Name.

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

Bases: FormIDRecord

Patrol data - Idle.

Form ID of an IDLE record, or null.

class MMRK(*args, **kwargs)

Bases: MarkerRecord

Audio marker (New Vegas only).

class MNAM(*args, **kwargs)

Bases: Float32Record

Unknown.

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

Bases: FormIDRecord

The placed object.

Form ID of a TREE, SOUN, ACTI, DOOR, STAT, FURN, CONT, ARMO, AMMO, LVLN, LVLC, MISC, WEAP, BOOK, KEYM, ALCH, LIGH, GRAS, ASPC, IDLM, ARMA, MSTT, NOTE, PWAT, SCOL, TACT, TERM, TXST, CCRD, IMOD or CMNY record.

class NNAM(*args, **kwargs)

Bases: Float32Record

Unknown.

class TNAM(type, unused)

Bases: StructRecord

Map Marker Data.

Parameters

• type (int)

• unused (bytes)

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:

type
unused

static get_field_names()

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

Return type

Tuple[str, …]

static get_struct_and_size()

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

Return type

Tuple[str, int]

type

Type:    int

unused

Type:    bytes

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

Bases: FormIDRecord

Map Marker Reputation.

Form ID of a REPU record.

class XACT(*args, **kwargs)

Bases: Uint32Record

Action Flag.

See below for values.

class XAMC(*args, **kwargs)

Bases: Int32Record

Ammo Count.

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

Bases: FormIDRecord

Ammo Type.

Form ID of an AMMO record, or null.

class XAPD(*args, **kwargs)

Bases: Uint8Record

Activate parents flags.

https://tes5edit.github.io/fopdoc/Fallout3/Records/Subrecords/XAPD.html

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

Bases: CStringRecord

Activation Prompt.

class XCHG(*args, **kwargs)

Bases: Float32Record

Charge.

class XCNT(*args, **kwargs)

Bases: Int32Record

Count.

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

Bases: FormIDRecord

Emittance.

Form ID of a LIGH or REGN record.

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

Bases: FormIDRecord

Encounter Zone.

Form ID of an ECZN record.

class XHLP(*args, **kwargs)

Bases: Float32Record

Health.

class XLCM(*args, **kwargs)

Bases: Int32Record

Level Modifier.

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

Bases: FormIDRecord

Linked Reference.

Form ID of a REFR, ACRE, ACHR, PGRE or PMIS record.

class XLOC(level, unused, key, flags, unknown)

Bases: StructRecord

Lock Data.

Parameters

• level (int)

• unused (bytes)

• key (bytes) – Form ID of a KEYM record, or null.

• flags (int)

• unknown (bytes)

Attributes:

flags
key	Form ID of a KEYM record, or null.
level
unknown
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.

flags

Type:    int

static get_field_names()

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

Return type

Tuple[str, …]

static get_struct_and_size()

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

Return type

Tuple[str, int]

key

Type:    bytes

Form ID of a KEYM record, or null.

level

Type:    int

unknown

Type:    bytes

unused

Type:    bytes

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

Bases: FormIDRecord

Linked Room.

Form ID of a REFR record.

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

Bases: FormIDRecord

Lit Water.

Form ID of a REFR record.

class XMBO(x, y, z)

Bases: StructRecord

Bound Half Extents.

Parameters

• x (float)

• y (float)

• z (float)

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:

x
y
z

static get_field_names()

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

Return type

Tuple[str, …]

static get_struct_and_size()

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

Return type

Tuple[str, int]

x

Type:    float

y

Type:    float

z

Type:    float

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

Bases: FormIDRecord

MultiBound Reference.

Form ID of a REFR record.

class XMRK(*args, **kwargs)

Bases: MarkerRecord

Map Marker Marker.

class XNDP(navmesh, unknown)

Bases: StructRecord

Navigation Door Link.

Parameters

• navmesh (bytes) – Form ID of a NAVM record.

• unknown (bytes)

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:

navmesh	Form ID of a NAVM record.
unknown

static get_field_names()

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

Return type

Tuple[str, …]

static get_struct_and_size()

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

Return type

Tuple[str, int]

navmesh

Type:    bytes

Form ID of a NAVM record.

unknown

Type:    bytes

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

Bases: FormIDRecord

Owner.

Ownership data. Form ID of a FACT, ACHR, CREA or NPC_ record.

class XPRD(*args, **kwargs)

Bases: Float32Record

Patrol data - idle time.

class XPRM(x_bound, y_bound, z_bound, red, green, blue, unknown, type)

Bases: StructRecord

Primitive.

Parameters

• x_bound (float)

• y_bound (float)

• z_bound (float)

• red (float)

• green (float)

• blue (float)

• unknown (bytes)

• type (int)

Attributes:

blue
green
red
type
unknown
x_bound
y_bound
z_bound

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.

blue

Type:    float

static get_field_names()

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

Return type

Tuple[str, …]

static get_struct_and_size()

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

Return type

Tuple[str, int]

green

Type:    float

red

Type:    float

type

Type:    int

unknown

Type:    bytes

x_bound

Type:    float

y_bound

Type:    float

z_bound

Type:    float

class XRAD(*args, **kwargs)

Bases: Float32Record

Radiation.

namedtuple XRDO(range_radius, broadcast_range_type, static_percentage=0.0, position_reference=b'\x00\x00\x00\x00')

Bases: NamedTuple

Radio Data.

Fields

0.  range_radius (float) – Alias for field number 0

1.  broadcast_range_type (int) – Alias for field number 1

2.  static_percentage (float) – Alias for field number 2

3.  position_reference (bytes) – Alias for field number 3

classmethod parse(raw_bytes)

Parse this subrecord.

Parameters

raw_bytes (BytesIO) – Raw bytes for this record

Return type

Self

unparse()

Turn this subrecord back into raw bytes for an ESP file.

Return type

bytes

class XRDS(*args, **kwargs)

Bases: Float32Record

Radius.

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

Bases: RawBytesRecord

Ragdoll Biped Data.

Unknown structure.

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

Bases: RawBytesRecord

Ragdoll Data.

Unknown structure.

class XRNK(*args, **kwargs)

Bases: Int32Record

Faction Rank.

Ownership data

class XSCL(*args, **kwargs)

Bases: Float32Record

Scale.

class XSED(*args, **kwargs)

Bases: Uint8Record

SpeedTree Seed.

class XTEL(door, xp, yp, zp, xr, yr, zr, flags)

Bases: StructRecord

Teleport Destination.

Parameters

• door (bytes) – Form ID of a REFR record.

• xp (float)

• yp (float)

• zp (float)

• xr (float)

• yr (float)

• zr (float)

• flags (int)

Attributes:

door	Form ID of a REFR record.
flags
xp
xr
yp
yr
zp
zr

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.

door

Type:    bytes

Form ID of a REFR record.

flags

Type:    int

static get_field_names()

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

Return type

Tuple[str, …]

static get_struct_and_size()

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

Return type

Tuple[str, int]

xp

Type:    float

xr

Type:    float

yp

Type:    float

yr

Type:    float

zp

Type:    float

zr

Type:    float

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

Bases: FormIDRecord

Target.

Form ID of a REFR, ACRE, ACHR, PGRE or PMIS record.

class XTRI(*args, **kwargs)

Bases: Uint32Record

Collision Layer.

Enum - see below for values.

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