class MAGES::Experimental::EmbodimentJARIA::EmbodimentJARIAModule¶

Overview¶

The root module for embodied AI. More…

class EmbodimentJARIAModule: public MAGES::HubModule
{
public:
    // properties

    GameObject UserSubsComponent;
    TextMeshProUGUI UserSubsText;
    int RemainingOrganizationTokens;
    DateTime TokenRefreshDate;

    // methods

    override void Startup();
    override void Shutdown();
    AgentConfiguration InitializeAgent(int index);
    AgentConfiguration InitializeAgent(string agentID);
    AgentConfiguration GetAgentFromID(string agentID);
    AgentConfiguration GetAgentFromIndex(int agentIndex);
    async void ClearHistory(IAuthenticationAPI authAPI);
    void RefreshOrganizationTokenUsage();
    void SwitchAgentConfiguration(GameObject agentGameObject, int index);
};

Inherited Members¶

public:
    // properties

    int Version;

    // methods

    void Startup();
    void Shutdown();
    virtual void UpdateModule(UpdatePhase updatePhase);

Detailed Documentation¶

The root module for embodied AI.

Properties¶

GameObject UserSubsComponent

Gets the Subs component.

TextMeshProUGUI UserSubsText

Gets the reference to user subs Text.

int RemainingOrganizationTokens

Gets the remaining organization tokens.

DateTime TokenRefreshDate

Gets the token refresh date.

Methods¶

AgentConfiguration InitializeAgent(int index)

Call to initialize an agent by its index.

Parameters:

Returns:

Returns the agent configuration.

AgentConfiguration InitializeAgent(string agentID)

Call to initialize an agent by its ID.

///

Parameters:

Returns:

Returns the agent configuration.

AgentConfiguration GetAgentFromID(string agentID)

Call to get an agent by its ID.

///

Parameters:

Returns:

Returns the agent configuration.

AgentConfiguration GetAgentFromIndex(int agentIndex)

Call to get an agent by its idex.

///

Parameters:

Returns:

Returns the agent configuration.

async void ClearHistory(IAuthenticationAPI authAPI)

Clears the agent’s history request.

Parameters:

void RefreshOrganizationTokenUsage()

Refreshes the organization token usage display.

void SwitchAgentConfiguration(GameObject agentGameObject, int index)

Switches the Agent Configuration for a specific Agent GameObject.

Parameters: