Class representing a tag's data. More...

#include <tags.h>

Public Member Functions
bool	SetTagPath (std::string new_path)
	Updates the tag path. More...

Public Attributes
void *	address
	The address pointing to the start of the tag's data. More...

int	size
	The size of the tag's data in memory. More...

char	path [256]
	The tag's path. More...

std::string	tag_class
	The tag's short class name. More...

TagOrigin	origin
	The origin of the tag. More...

Detailed Description

Class representing a tag's data.

Member Function Documentation

bool tag_memory_data::SetTagPath ( std::string new_path )

inline

Updates the tag path.

Parameters

new_path - The new tag path to use. Maximum length is 256 characters.

Returns: true if the tag path was updated successfully, or false if the provided path was too long.

void* tag_memory_data::address

The address pointing to the start of the tag's data.

TagOrigin tag_memory_data::origin

The origin of the tag.

char tag_memory_data::path[256]

The tag's path.

This does not always represent a file on disk, but the relative path of the tag's file from the tag data root. For instance, a tag located at:

./tags/levels/solo/040_voi/040_voi.scenario

would have a path of:

/levels/solo/040_voi/040_voi.scenario

Tag paths can be up to 255 characters long, exclduing null-terminator.

int tag_memory_data::size

The size of the tag's data in memory.

std::string tag_memory_data::tag_class

The tag's short class name.

The documentation for this class was generated from the following file: