A field in the GFF4 struct. More...

Collaboration diagram for Aurora::GFF4Struct::Field:

[legend]

Public Member Functions
	Field ()

	Field (uint32 l, uint16 t, uint16 f, uint32 o, bool g=false)

	~Field ()

Public Attributes
uint32	label
	A numerical label of the field. More...

FieldType	type
	Type of the field. More...

uint32	offset
	Offset into the GFF4 data. More...

bool	isList
	Is this field a singular item or a list? More...

bool	isReference
	Is this field a reference (pointer) to another field? More...

bool	isGeneric
	Is this field found in a generic? More...

uint16	structIndex
	Index of the field's struct type (if kFieldTypeStruct). More...

GFF4List	structs
	List of GFF4Struct (if kFieldTypeStruct). More...

Detailed Description

A field in the GFF4 struct.

Definition at line 353 of file gff4file.h.

Constructor & Destructor Documentation

◆ Field() [1/2]

Aurora::GFF4Struct::Field::Field ( )

Definition at line 328 of file gff4file.cpp.

◆ Field() [2/2]

Aurora::GFF4Struct::Field::Field	(	uint32	l,
		uint16	t,
		uint16	f,
		uint32	o,
		bool	g = `false`
	)

Definition at line 333 of file gff4file.cpp.

References isList, isReference, Aurora::GFF4Struct::kFieldTypeASCIIString, Aurora::GFF4Struct::kFieldTypeGeneric, Aurora::GFF4Struct::kFieldTypeString, Aurora::GFF4Struct::kFieldTypeStruct, Aurora::GFF4Struct::kFieldTypeTlkString, structIndex, and type.

◆ ~Field()

Aurora::GFF4Struct::Field::~Field ( )

Definition at line 370 of file gff4file.cpp.

Member Data Documentation

◆ isGeneric

bool Aurora::GFF4Struct::Field::isGeneric

Is this field found in a generic?

Definition at line 360 of file gff4file.h.

Referenced by Aurora::GFF4Struct::getString().

◆ isList

bool Aurora::GFF4Struct::Field::isList

Is this field a singular item or a list?

Definition at line 358 of file gff4file.h.

◆ isReference

bool Aurora::GFF4Struct::Field::isReference

Is this field a reference (pointer) to another field?

Definition at line 359 of file gff4file.h.

Referenced by Field(), Aurora::GFF4Struct::getDataOffset(), Aurora::GFF4Struct::load(), and Aurora::GFF4Struct::loadStructs().

◆ label

uint32 Aurora::GFF4Struct::Field::label

A numerical label of the field.

Definition at line 354 of file gff4file.h.

Referenced by Aurora::GFF4Struct::getFieldProperties().

◆ offset

uint32 Aurora::GFF4Struct::Field::offset

Offset into the GFF4 data.

Definition at line 356 of file gff4file.h.

Referenced by Aurora::GFF4Struct::getDataOffset(), Aurora::GFF4Struct::GFF4Struct(), Aurora::GFF4Struct::load(), Aurora::GFF4Struct::loadGeneric(), and Aurora::GFF4Struct::loadStructs().

◆ structIndex

uint16 Aurora::GFF4Struct::Field::structIndex

Index of the field's struct type (if kFieldTypeStruct).

Definition at line 362 of file gff4file.h.

Referenced by Field(), and Aurora::GFF4Struct::loadStructs().

◆ structs

GFF4List Aurora::GFF4Struct::Field::structs

List of GFF4Struct (if kFieldTypeStruct).

Definition at line 363 of file gff4file.h.

Referenced by Aurora::GFF4Struct::getGeneric(), Aurora::GFF4Struct::getList(), Aurora::GFF4Struct::getStruct(), Aurora::GFF4Struct::loadGeneric(), and Aurora::GFF4Struct::loadStructs().

◆ type

FieldType Aurora::GFF4Struct::Field::type

Type of the field.

Definition at line 355 of file gff4file.h.

The documentation for this struct was generated from the following files:

src/aurora/gff4file.h
src/aurora/gff4file.cpp

Public Member Functions

Public Attributes