FAiCharData Struct Reference

FAiCharData Read-only data struct containing all the relevant information for an AI character. More...

#include <AiCharData.h>

Inheritance diagram for FAiCharData:

Public Member Functions
virtual FStringView	GetThumbnailUrl () const override
	FAiCharData (const FGuid &id, FStringView name, FStringView creatorNotes, bool isExplicitContent, bool isFavorite, FStringView thumbnailUrl, const FGuid &packageId, FStringView packageName)
	Create an instance of the datacontainer for a specific AI character.
	FAiCharData ()=default
	Default constructor.
virtual	~FAiCharData () override=default
bool	GetAllowedExplicitContent () const
	Get whether this character allows explicit content.
bool	GetIsFavorite () const
	Get whether this character is marked as a favorite by the user.
FStringView	GetCreatorNotes () const
	Get the creator's notes about this character.
const FGuid &	GetPackageId () const
	Get the ID of the package this character belongs to.
FStringView	GetPackageName () const
	Get the name of the package this character belongs to.
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

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

FAiCharData Read-only data struct containing all the relevant information for an AI character.

Used by the VoxtaClient to represent AI characters in the chat system.

Resides in the UVoxtaClient directly. Cannot be retrieved or fetched through any public API, but will be referenced via the VoxtaClientCharMessageAddedEvent when the user has contributed a message to the chat.

Constructor & Destructor Documentation

FAiCharData() [1/2]

FAiCharData::FAiCharData ( const FGuid & id, FStringView name, FStringView creatorNotes, bool isExplicitContent, bool isFavorite, FStringView thumbnailUrl, const FGuid & packageId, FStringView packageName )

inlineexplicit

Create an instance of the datacontainer for a specific AI character.

Parameters

id	The id (guid in string version) that the VoxtaServer has assigned to this character.
name	The name of this character, as reported by VoxtaServer
creatorNotes	The custom creator notes for this character, as reported by VoxtaServer
isExplicitContent	If VoxtaServer has this character marked for explicit content or not.
isFavorite	If the user has favorited this specific character in Voxta.
thumbnailUrl	The URL for the character's thumbnail image.
packageId	The package ID this character belongs to.
packageName	The name of the package this character belongs to.

FAiCharData() [2/2]

FAiCharData::FAiCharData ( )

default

Default constructor.

~FAiCharData()

virtual FAiCharData::~FAiCharData ( )

overridevirtualdefault

Member Function Documentation

GetAllowedExplicitContent()

bool FAiCharData::GetAllowedExplicitContent ( ) const

inline

Get whether this character allows explicit content.

Returns

True if explicit content is allowed for this character.

GetCreatorNotes()

FStringView FAiCharData::GetCreatorNotes ( ) const

inline

Get the creator's notes about this character.

Returns

The creator notes string.

GetIsFavorite()

bool FAiCharData::GetIsFavorite ( ) const

inline

Get whether this character is marked as a favorite by the user.

Returns

True if this character is favorited.

GetPackageId()

const FGuid & FAiCharData::GetPackageId ( ) const

inline

Get the ID of the package this character belongs to.

Returns

The package GUID.

GetPackageName()

FStringView FAiCharData::GetPackageName ( ) const

inline

Get the name of the package this character belongs to.

Returns

The package name.

GetThumbnailUrl()

virtual FStringView FAiCharData::GetThumbnailUrl ( ) const

inlineoverridevirtual

Returns

Immutable reference of the URL that points to where the image for this character can be retrieved from.

---

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

• AiCharData.h