class MAGES::Experimental::EmbodimentJARIA::AgentConfiguration¶

Overview¶

The Agent configuration. More…

class AgentConfiguration: public ScriptableObject
{
public:
    // properties

    string AgentID;
    SerializableDictionary AgentDetails;
    List<SerializableDictionary> SubAgentDetails;
    string AgentBehaviorType;
    GameObject EmbodimentCharacterPrefab;
    string EmbodimentCharacterScene;
    bool SceneCharacter;
    List SubAgentsIDs;
    GameObject EmbodimentCharacter;
    GameObject AgentInteractionComponent;
    GameObject AgentInteraction;
    Animator CharacterAnimator;
    AudioSource CharacterAudioSource;
    Button StartButton;
    Button MicButton;
    Button CancelButton;
    GameObject OccupiedText;
    GameObject AgentOutputComponent;
    GameObject AgentOutput;
    TextMeshProUGUI AgentOutputText;
    ITextToSpeechHandler TextHandler;
    ISpeechToTextHandler SpeechHandler;
    string TextSpeechHandlerRegion;
    string TextSpeechHandlersKey;
    string CustomEndpointID;
    string LanguageID;
    string VoiceID;
    UnityEvent OnInteract;
    UnityEvent OnCancel;
    UnityEvent OnStartTalking;
    UnityEvent OnEndTalking;

    // methods

    void InitializeAgent();
    void ChangeButtons(Button newStartButton, Button newCancelButton);
    void DestroyAgent();
    Agent GetInitializedAgent();
};

Detailed Documentation¶

The Agent configuration.

Properties¶

string AgentID

Gets or Sets the AgentID.

SerializableDictionary AgentDetails

Gets or Sets the Agent Details.

List<SerializableDictionary> SubAgentDetails

Gets or Sets the Agent Details.

string AgentBehaviorType

Gets the Agent Behavior.

GameObject EmbodimentCharacterPrefab

Gets or sets the embodiment character as a prefab.

string EmbodimentCharacterScene

Gets or sets the embodiment character in scene.

bool SceneCharacter

Gets or sets a value indicating whether the character is from scene or a prefab.

List SubAgentsIDs

Gets or sets a value indicating whether the character is from scene or a prefab.

GameObject EmbodimentCharacter

Gets the spawned embodiment character.

GameObject AgentInteractionComponent

Gets or sets the interaction component.

GameObject AgentInteraction

Gets or sets the interaction component reference.

Animator CharacterAnimator

Gets the startButton.

AudioSource CharacterAudioSource

Gets the audiosource.

Button StartButton

Gets the startButton.

Button MicButton

Gets the micButton.

Button CancelButton

Gets the startButton.

GameObject OccupiedText

Gets the occupiedText.

GameObject AgentOutputComponent

Gets or sets the agent output component.

GameObject AgentOutput

Gets the agent output component.

TextMeshProUGUI AgentOutputText

Gets the agent output text.

ITextToSpeechHandler TextHandler

Gets the text handler ref.

ISpeechToTextHandler SpeechHandler

Gets the speech handler ref.

string TextSpeechHandlerRegion

Gets or Sets the region for SpeechHandler.

string TextSpeechHandlersKey

Gets or Sets the key for TextHandler.

string CustomEndpointID

Gets or Sets the key for custom endpoint URL or key.

string LanguageID

Gets or Sets the language ID.

string VoiceID

Gets or Sets the voice ID for text handler configuration.

UnityEvent OnInteract

Gets or sets event for interact.

UnityEvent OnCancel

Gets or sets event for cancel.

UnityEvent OnStartTalking

Gets or sets event called when agent starts talking.

UnityEvent OnEndTalking

Gets or sets event called when agent stops talking.

Methods¶

void InitializeAgent()

Call to initialize the agent.

void ChangeButtons(Button newStartButton, Button newCancelButton)

Required to be called when changing buttons.

Parameters:

void DestroyAgent()

Destroys the initialized agent.

Agent GetInitializedAgent()

Gets the spawned agent.

Returns:

Reference to the initialized agent or null if it has not been initialized yet.