tag_reference Struct Reference

Structure representing a tag reference. More...

#include <tags.h>

Public Member Functions
bool	ResolveReference ()
	Attempts to resolve a tag reference. More...
std::string	GetTagPath ()
	Retrieves the path of the tag that this tagref refers to. More...
bool	HasReference ()
	Checks if a tag reference has a tag specified or not. More...
void *	GetTagData ()
	Retrieves the tag data. More...

Public Attributes
char	identifier [4] = {'t','r','f','d'}
	The tag reference identifier. Will always be trfd. More...
char	padding0 [4]
	Empty padding. More...
char	class_name [4] = {'\0','\0','\0','\0'}
	The tag class identifier. Will be the short class name. More...
char	padding1 [4]
	Empty padding. More...
void *	tagref_address = nullptr
	The address of the tagref data. More...
bool	data_is_tag = false
	Whether or not tagref_address points to tag data, or the tag's path. More...
char	padding2 [3]
	Empty padding. Should always be NULL. More...
int	data_size = 0
	The size of tagref_address. More...

Detailed Description

Structure representing a tag reference.

Tag references allow for tags to reference other tags that are associated with them. For instance, a render_model tag might reference a shader, and shaders might reference bitmaps.

Member Function Documentation

GetTagData()

void * tag_reference::GetTagData

(

)

Retrieves the tag data.

If the tag has not yet been resolved, attempts to resolve the tag reference.

Returns

The resolved tag data address, or nullptr if the tag could not be resolved.

Here is the call graph for this function:

GetTagPath()

std::string tag_reference::GetTagPath

(

)

Retrieves the path of the tag that this tagref refers to.

Returns

The tag path, or an empty string if the tag could not be identified.

Here is the call graph for this function:

Here is the caller graph for this function:

HasReference()

bool tag_reference::HasReference

(

)

Checks if a tag reference has a tag specified or not.

If a tag reference is empty, then reference resolving is not required.

Returns

true if the tagref references a tag, otherwise returns false.

Here is the call graph for this function:

Here is the caller graph for this function:

ResolveReference()

bool tag_reference::ResolveReference

(

)

Attempts to resolve a tag reference.

This only needs to be performed once per tag reference.

Returns

true if the tagref was resolved successfully, otherwise returns false. If this returns false, then either the tag could not be found, or the tag class was invalid.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

class_name

char tag_reference::class_name[4] = {'\0','\0','\0','\0'}

The tag class identifier. Will be the short class name.

data_is_tag

bool tag_reference::data_is_tag = false

Whether or not tagref_address points to tag data, or the tag's path.

data_size

int tag_reference::data_size = 0

The size of tagref_address.

identifier

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

The tag reference identifier. Will always be trfd.

padding0

char tag_reference::padding0[4]

Empty padding.

padding1

char tag_reference::padding1[4]

Empty padding.

padding2

char tag_reference::padding2[3]

Empty padding. Should always be NULL.

tagref_address

void* tag_reference::tagref_address = nullptr

The address of the tagref data.

---

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

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