persona_component class

Base class for authoring logic and data in the SceneGraph. Using components you can author re-usable building blocks of logic and data which can then be added to entities in the scene.

Components are a very low level building block which can be used in many ways. For example:

• Exposing engine level concepts like mesh or sound
• Adding gameplay capabilities like damage or interaction
• Storing an inventory for a character in the game

As components are generic there is no specific way that they must be used. It is up to the needs of your experience if you use one big game component or if you break up logic into many small components.

Classes deriving from component must also specify <final_super> to be added to entities. This ensures the class will always derive directly from component. Further subclassing of the initial derived component is allowed and does not require specifying <final_super> on the derived classes.

Only one instance of a component from each subclass group can be added to an entity at a time. For example, given this group of components, only one light_component can exist on a single entity. To create multiple lights you should use multiple entities.

light_component := class(component){} capsule_light_component := class(light_component){} directional_light_component := class(light_component){} spot_light_component := class(light_component){} sphere_light_component := class(light_component){} rect_light_component := class(light_component){}

============================================================================== Component Lifetime

Components move through a series of lifetime functions as they are added to entities, added to the scene, and begin running in the simulation. Components should override these methods to perform setup and run their simulation.

As a component shuts down it will then move through shutdown version of these functions, giving users the opportunity to clean up any retained state on the component before it is disposed . Lifetime Methods: OnAddedToScene OnBeginSimulation -> OnSimulate OnEndSimulation OnRemovingFromScene ==============================================================================

Listenable which is signaled when the spoken message is finalized (after moderation). Contains the actual message delivered — either the original or the canned replacement. 1/ The agent (if involved) that prompted the response. 2/ The final message that was said.

The parent entity of this component.

• Components must have a parent entity pointer provided when being constructed.
• Components cannot be moved between parents.

How the persona will handle overlapping prompts.

What the persona knows

The personality of the persona

Listenable which is signaled when the persona was requested to talk, either by a player or prompt and failed. Callback receives: 1) The persona which had the failure 2) The error

The session which will process all this persona's prompts When the persona is in a voice channel, every session in that channel will automatically propagate conversation history entries to all sessions found in the channel. All and only conversation directly to or from a persona will be automatically recorded.

Listenable which is signaled when the player starts prompting the persona.

Listenable which is signaled when the persona begins speaking (before moderation resolves). 1/ The agent (if involved) that prompted the response. 2/ Cancelable to stop the persona from talking.

Listenable which is signaled when the player finishes prompting the persona.

Listenable which is signaled when the target stops talking. 1/ logic that is true when interrupted

Set callbacks to TickEvents.PrePhysics and TickEvents.PostPhysics to receive per-frame updates before and after physics is updated on your object.

The voice assigned to this persona.

Succeeds if the component is currently in the scene.

• After OnAddedToScene is called this call succeeds.
• After OnRemovingFromScene is called this call fails.

Succeeds if the component is currently simulating.

• After OnBeginSimulation is called this call succeeds.
• After OnEndSimulation is called this call fails.

Called when the component is added to the scene by parenting it under the simulation entity or another entity already in the scene.

• Querying for components in the scene is valid after this phase completes.

Called when the component begins simulating within the scene.

• Use this to set up TickEvent callbacks or other setup that must be guaranteed to complete immediately.
• OnAddedToScene is guaranteed to run before OnBeginSimulation.

Called when the component ends simulation within the scene.

• Simulation ends on a component when the experience resets, the parent entity is removed from the scene.
• Cached TickEvents cancelables should be canceled in OnEndSimulation.
• OnSimulate task will be canceled before OnEndSimulation is called.
• OnEndSimulation is only called on components that have already had OnBeginSimulation called.

Respond to a scene event. Return true to consume the event and halt propagation to the next entity.

Called when the component is about to be removed from the scene.

• Components are removed from a scene when the parent entity is removed from the scene.
• OnRemovingFromScene is only called on components that have already had OnAddedToScene called.

Called when the component begins simulating within the scene.

• Use this to add asynchronous/suspends update logic for a component.
• OnBeginSimulation is guaranteed to run before OnSimulate.
• OnSimulate will be cancelled before OnEndSimulation

Removes the component from the entity.

• Removed components are removed from the scene and can only be added back to the same entity.
• Flows through OnEndSimulation-> OnRemovingFromScene.

Requests the Persona to talk on the topic provided, requires the persona to be on a channel

Send a scene event to this component, invoking OnReceive. Returns true if any participant consumed the event.

Registers a callback for when the persona receives structured data in the format of response_type. Required forces this be filled out every time the persona is prompted. The returned cancelable unregisters this callback and stops the llm from attempting to send this kind of structured data. The result type must be a struct which can contain.

• numeric types, message, bools and enums, as well as structs or arrays which only contain those types, anything else results in an error. Use the names of the fields and name of the type of the struct to direct the prompt or facts on how to fill out the data structure.