CELL Record – Cell

CELL record type.

Classes:

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

Cell.

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

Bases: Record

Cell.

Parameters
  • flags (int)

  • id (bytes)

  • revision (int) – Default 0.

  • version (int) – Default 15.

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

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

Classes:

DATA(*args, **kwargs)

Flags.

FULL([cstring])

The cell name.

LNAM(*args, **kwargs)

Lighting template flags.

LTMP([cstring])

Light template giving the Form ID of an LGTM record.

XCAS([cstring])

Acoustic space.

XCCM([cstring])

Climate.

XCIM([cstring])

Image Space.

XCLC([x, y, force_hide_land])

Grid reference of the cell.

XCLL(ambient_color, directional_color, ...)

Lighting.

XCLR([iterable])

Regions.

XCLW(*args, **kwargs)

Water height.

XCMO([cstring])

Music type.

XCWT([cstring])

Water.

XEZN([cstring])

Encounter Zone.

XNAM([cstring])

Water noise texture name.

XOWN([cstring])

Owner.

XRNK(*args, **kwargs)

Faction rank.

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 DATA(*args, **kwargs)[source]

Bases: Uint8Record

Flags.

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

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

Bases: CStringRecord

The cell name.

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

Bases: Uint32Record

Lighting template flags.

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

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

Bases: FormIDRecord

Light template giving the Form ID of an LGTM record. May be 0.

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

Bases: FormIDRecord

Acoustic space.

Form ID of an ASPC record.

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

Bases: FormIDRecord

Climate.

Form ID of a CLMT record.

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

Bases: FormIDRecord

Image Space.

Form ID of an IMGS record.

class XCLC(x=0, y=0, force_hide_land=0)[source]

Bases: StructRecord

Grid reference of the cell.

Parameters
  • x (int) – Default 0.

  • y (int) – Default 0.

  • force_hide_land (int) – Default 0.

Attributes:

force_hide_land

x

y

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.

force_hide_land

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]

x

Type:    int

y

Type:    int

class XCLL(ambient_color, directional_color, fog_color, fog_near, fog_far, directional_rotation_xy, directional_rotation_z, directional_fade, fog_clip_distance, fog_power)[source]

Bases: StructRecord

Lighting.

Parameters

Attributes:

ambient_color

directional_color

directional_fade

directional_rotation_xy

directional_rotation_z

fog_clip_distance

fog_color

fog_far

fog_near

fog_power

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.

ambient_color

Type:    bytes

directional_color

Type:    bytes

directional_fade

Type:    float

directional_rotation_xy

Type:    int

directional_rotation_z

Type:    int

fog_clip_distance

Type:    float

fog_color

Type:    bytes

fog_far

Type:    float

fog_near

Type:    float

fog_power

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]

class XCLR(iterable=(), /)[source]

Bases: List, RecordType

Regions.

Sequence of form IDs (as bytes) for REGN records.

Methods:

parse(raw_bytes)

Parse this subrecord.

unparse()

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

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 XCLW(*args, **kwargs)[source]

Bases: Float32Record

Water height.

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

Bases: FormIDRecord

Music type.

Form ID of a MUSC record.

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

Bases: FormIDRecord

Water.

Form ID of a WATR 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 name.

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

Bases: FormIDRecord

Owner.

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

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

Bases: Int32Record

Faction rank.

Ownership data

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