WRLD Record – Worldspace

WRLD record type.

Classes:

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

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

Bases: Record

Worldspace.

Parameters

  • flags (int)

  • id (bytes)

  • revision (int) – Default 0.

  • version (int) – Default 15.

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

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

Classes:

CNAM([cstring])

Climate.

DATA(*args, **kwargs)

Flags.

DNAM(default_land_height, default_water_height)

Land Data.

FULL([cstring])

Name.

ICON([cstring])

Large icon filename.

INAM([cstring])

Image space.

MICO([cstring])

Small icon filename.

MNAM(useable_x_size, useable_y_size, ...)

Map Data.

NAM0(x, y)

Min Object Bounds.

NAM2([cstring])

Water.

NAM3([cstring])

LOD water type.

NAM4(*args, **kwargs)

LOD water height.

NAM9(x, y)

Max Object Bounds.

NNAM([cstring])

Canopy Shadow.

ONAM(world_map_scale, cell_x_offset, ...)

World Map Offset Data.

PNAM(flags, unknown)

Parent worldspace flags.

WNAM([cstring])

Parent worldspace.

XEZN([cstring])

Encounter Zone.

XNAM([cstring])

Water Noise Texture.

ZNAM([cstring])

Music.

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

Bases: FormIDRecord

Climate.

Form ID of a CLMT record.

class DATA(*args, **kwargs)[source]

Bases: Uint8Record

Flags.

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

namedtuple DNAM(default_land_height, default_water_height)[source]

Bases: NamedTuple

Land Data.

Fields

  1.  default_land_height (float) – Alias for field number 0

  2.  default_water_height (float) – Alias for field number 1

classmethod parse(raw_bytes)[source]

Parse this subrecord.

Parameters

raw_bytes (BytesIO) – Raw bytes for this record

Return type

Self

unparse()[source]

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

Return type

bytes

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

Bases: CStringRecord

Name.

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

Bases: CStringRecord

Large icon filename.

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

Bases: FormIDRecord

Image space.

Form ID of an IMGS record.

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

Bases: CStringRecord

Small icon filename.

namedtuple MNAM(useable_x_size, useable_y_size, nw_x_coord, nw_y_coord, se_x_coord, se_y_coord)[source]

Bases: NamedTuple

Map Data.

Fields

  1.  useable_x_size (int) – Alias for field number 0

  2.  useable_y_size (int) – Alias for field number 1

  3.  nw_x_coord (int) – Alias for field number 2

  4.  nw_y_coord (int) – Alias for field number 3

  5.  se_x_coord (int) – Alias for field number 4

  6.  se_y_coord (int) – Alias for field number 5

classmethod parse(raw_bytes)[source]

Parse this subrecord.

Parameters

raw_bytes (BytesIO) – Raw bytes for this record

Return type

Self

unparse()[source]

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

Return type

bytes

namedtuple NAM0(x, y)[source]

Bases: NamedTuple

Min Object Bounds.

Fields

  1.  x (float) – Alias for field number 0

  2.  y (float) – Alias for field number 1

classmethod parse(raw_bytes)[source]

Parse this subrecord.

Parameters

raw_bytes (BytesIO) – Raw bytes for this record

Return type

Self

unparse()[source]

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

Return type

bytes

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

Bases: FormIDRecord

Water.

Form ID of a WATR record.

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

Bases: FormIDRecord

LOD water type.

Form ID of a WATR record.

class NAM4(*args, **kwargs)[source]

Bases: Float32Record

LOD water height.

namedtuple NAM9(x, y)[source]

Bases: NAM0

Max Object Bounds.

Fields

  1.  x (float) – Alias for field number 0

  2.  y (float) – Alias for field number 1

unparse()[source]

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

Return type

bytes

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

Bases: CStringRecord

Canopy Shadow.

namedtuple ONAM(world_map_scale, cell_x_offset, cell_y_offset)[source]

Bases: NamedTuple

World Map Offset Data.

Fields

  1.  world_map_scale (float) – Alias for field number 0

  2.  cell_x_offset (float) – Alias for field number 1

  3.  cell_y_offset (float) – Alias for field number 2

classmethod parse(raw_bytes)[source]

Parse this subrecord.

Parameters

raw_bytes (BytesIO) – Raw bytes for this record

Return type

Self

unparse()[source]

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

Return type

bytes

namedtuple PNAM(flags, unknown)[source]

Bases: NamedTuple

Parent worldspace flags.

Fields

  1.  flags (int) – Alias for field number 0

  2.  unknown (bytes) – Alias for field number 1

classmethod parse(raw_bytes)[source]

Parse this subrecord.

Parameters

raw_bytes (BytesIO) – Raw bytes for this record

Return type

Self

unparse()[source]

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

Return type

bytes

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

Bases: FormIDRecord

Parent worldspace.

Form ID of a WRLD record.

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

Bases: FormIDRecord

Encounter Zone.

Form ID of an ECZN record.

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

Bases: CStringRecord

Water Noise Texture.

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

Bases: FormIDRecord

Music.

Form ID of a MUSC record.

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

version

Type:    int