FBaseCharData Struct Reference

FBaseCharData Read-only data struct containing all the universal information fields for a character. More...

#include <BaseCharData.h>

Inheritance diagram for FBaseCharData:

Public Member Functions
const FGuid &	GetId () const
FStringView	GetName () const
virtual FStringView GetThumbnailUrl() const PURE_VIRTUAL(FBaseCharData	FBaseCharData (FGuid id, FStringView name)
	Derived classes should override this to provide character-specific thumbnails.
	FBaseCharData ()=default
	Default constructor.
virtual	~FBaseCharData ()=default

Protected Attributes
FGuid	m_id = FGuid()
	Character ID assigned by VoxtaServer.
FString	m_name = EMPTY_STRING
	Name of the character.
FString	m_idAsString = EMPTY_STRING
	Character ID as formatted string.

Detailed Description

FBaseCharData Read-only data struct containing all the universal information fields for a character.

Used as a base for both AI and user characters. Not directly exposed via public API, but referenced in events and chat messages.

Constructor & Destructor Documentation

FBaseCharData() [1/2]

virtual FStringView GetThumbnailUrl() const PURE_VIRTUAL(FBaseCharData FBaseCharData::FBaseCharData ( FGuid id, FStringView name )

inlineexplicitvirtual

Derived classes should override this to provide character-specific thumbnails.

Returns

URL to the thumbnail image for this character. Empty by default. Create an instance of the data container for the CharData.

Parameters

id	The GUID that the VoxtaServer has assigned to this character.
name	The name of this character, as reported by VoxtaServer

FBaseCharData() [2/2]

FBaseCharData::FBaseCharData ( )

default

Default constructor.

~FBaseCharData()

virtual FBaseCharData::~FBaseCharData ( )

virtualdefault

Member Function Documentation

GetId()

const FGuid & FBaseCharData::GetId ( ) const

inline

Returns

Immutable reference to the VoxtaServer assigned id of this character.

GetName()

FStringView FBaseCharData::GetName ( ) const

inline

Returns

Immutable reference to the name of this character.

Member Data Documentation

m_id

FGuid FBaseCharData::m_id = FGuid()

protected

Character ID assigned by VoxtaServer.

m_idAsString

FString FBaseCharData::m_idAsString = EMPTY_STRING

protected

Character ID as formatted string.

m_name

FString FBaseCharData::m_name = EMPTY_STRING

protected

Name of the character.

---

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

• BaseCharData.h