FUserCharData Read-only data struct containing all the relevant information for the character representing the User (player). More...

#include <UserCharData.h>

Inheritance diagram for FUserCharData:

Public Member Functions
virtual FStringView	GetThumbnailUrl () const override

	FUserCharData (FGuid id, FStringView name)
	Create an instance of the datacontainer for the User.

	FUserCharData ()=default
	Default constructor.

virtual	~FUserCharData () override=default

Public Member Functions inherited from FBaseCharData
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

Public Attributes
FString	m_userThumbnailUrl

Additional Inherited Members
Protected Attributes inherited from FBaseCharData
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

FUserCharData Read-only data struct containing all the relevant information for the character representing the User (player).

Contains basic character data like ID and name, plus a special thumbnail URL format for user profiles.

Resides in the UVoxtaClient directly and is initialized during the Welcome response. Referenced in VoxtaClientCharMessageAddedEvent when the user contributes a message.

Constructor & Destructor Documentation

◆ FUserCharData() [1/2]

FUserCharData::FUserCharData	(	FGuid	id,
		FStringView	name )

inlineexplicit

Create an instance of the datacontainer for the User.

Parameters

id	The id that the VoxtaServer has assigned to the User.
name	The name of the User, as reported by VoxtaServer

◆ FUserCharData() [2/2]

FUserCharData::FUserCharData ( )

default

Default constructor.

◆ ~FUserCharData()

virtual FUserCharData::~FUserCharData ( )

overridevirtualdefault

Member Function Documentation

◆ GetThumbnailUrl()

virtual FStringView FUserCharData::GetThumbnailUrl ( ) const

inlineoverridevirtual

Member Data Documentation

◆ m_userThumbnailUrl

FString FUserCharData::m_userThumbnailUrl

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

UserCharData.h

Public Member Functions

Public Attributes

Additional Inherited Members