Class AIChatbotSpaceComponent

Inheritance Relationships

Base Types

Class Documentation

class AIChatbotSpaceComponent : public csp::multiplayer::ComponentBase, public csp::multiplayer::IPositionComponent

Public Functions

AIChatbotSpaceComponent(csp::common::LogSystem *LogSystem, SpaceEntity *Parent)
const csp::common::String &GetVoice() const

Gets the voice name of the TTS model associated with this AI chatbot.

Returns

The name of the TTS voice associated with this AI chatbot.

void SetVoice(const csp::common::String &Value)

Sets the voice name of the TTS model associated with this AI chatbot.

Parameters

Value – The name of the TTS voice associated with this AI chatbot.

const csp::common::String &GetGuardrailAssetCollectionId() const

Gets the ID of the guardrail asset associated with this AI chatbot.

Returns

The ID of the guardrail asset collection associated with this AI chatbot.

void SetGuardrailAssetCollectionId(const csp::common::String &Value)

Sets the ID of the guardrail asset associated with this AI chatbot.

Parameters

Value – The ID of the guardrail asset collection associated with this AI chatbot.

AIChatbotVisualState GetVisualState() const

Retrieves the visual state of the AI chatbot for this component.

Returns

The visual state of the AI chatbot.

void SetVisualState(AIChatbotVisualState Value)

Sets the visual state of the AI chatbot for this component.

Parameters

Value – The visual state of the AI chatbot.

Public Static Functions

static const ComponentSchema &GetSchema()
static std::unique_ptr<AIChatbotSpaceComponent> TryMake(const ComponentSchema &InSchema, csp::common::LogSystem *LogSystem, SpaceEntity *Parent)

Creates an AI chatbot space component using the provided schema if it is compatible with the built-in schema.

See also

csp::multiplayer::IsCompatible

Parameters

  • InSchema – The schema to use. Must be compatible with the built-in schema.

  • LogSystem – The log system.

  • Parent – The space entity that owns this component.

Returns

A new AIChatbotSpaceComponent if the schema is compatible, nullptr otherwise.