field_reference Struct Reference

Structure representing a field reference. More...

#include <tags.h>

Collaboration diagram for field_reference:

Public Member Functions
bool	IsValid (BlamTagFieldType expected_type)
bool	GetBoolean ()
int8_t	GetInt8 ()
int16_t	GetInt16 ()
int32_t	GetInt32 ()
int64_t	GetInt64 ()
int8_t	GetEnum8 ()
int16_t	GetEnum16 ()
int32_t	GetEnum32 ()
bitfield8	GetBitfield8 ()
bitfield16	GetBitfield16 ()
bitfield32	GetBitfield32 ()
real	GetReal ()
color	GetColor ()
vector2	GetVector2 ()
vector3	GetVector3 ()
vector4	GetVector4 ()

Public Attributes
char	identifier [4] = { 'f','r','f','d' }
BlamTagFieldType	referenced_field_type = BlamTagFieldType::Unspecified
void *	field_address = nullptr
uint32_t	file_offset = 0

Detailed Description

Structure representing a field reference.

Field references allow for tags to self-reference other fields within a tag.

Member Function Documentation

GetBitfield16()

bitfield16 field_reference::GetBitfield16

(

)

GetBitfield32()

bitfield32 field_reference::GetBitfield32

(

)

GetBitfield8()

bitfield8 field_reference::GetBitfield8

(

)

GetBoolean()

bool field_reference::GetBoolean

(

)

GetColor()

color field_reference::GetColor

(

)

GetEnum16()

int16_t field_reference::GetEnum16

(

)

GetEnum32()

int32_t field_reference::GetEnum32

(

)

GetEnum8()

int8_t field_reference::GetEnum8

(

)

GetInt16()

int16_t field_reference::GetInt16

(

)

GetInt32()

int32_t field_reference::GetInt32

(

)

GetInt64()

int64_t field_reference::GetInt64

(

)

GetInt8()

int8_t field_reference::GetInt8

(

)

GetReal()

real field_reference::GetReal

(

)

GetVector2()

vector2 field_reference::GetVector2

(

)

GetVector3()

vector3 field_reference::GetVector3

(

)

GetVector4()

vector4 field_reference::GetVector4

(

)

IsValid()

bool field_reference::IsValid

(

BlamTagFieldType

expected_type

)

Member Data Documentation

field_address

void* field_reference::field_address = nullptr

file_offset

uint32_t field_reference::file_offset = 0

identifier

char field_reference::identifier[4] = { 'f','r','f','d' }

referenced_field_type

BlamTagFieldType field_reference::referenced_field_type = BlamTagFieldType::Unspecified

---

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

• blam/api/v1/types/tags.h
• blam/api/v1/types/field_reference.cpp