Interaction
Interaction Class
Syntax
Member Details
GetEnabled Method
Returns true if the interaction is enabled.
Syntax[Sansar.Script.Interface] public bool GetEnabled ()
Returns
true if the interaction is enabled.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
GetPrompt Method
Get the current Interaction prompt.
Syntax[Sansar.Script.Interface] public string GetPrompt ()
Returns
The current prompt string.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SetEnabled Method
Change an Interaction state to disabled or enabled.
Syntax[Sansar.Script.Interface] public void SetEnabled (bool value)
Parameters
value
true to enable the Interaction, false to disable it.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SetEnabled Method
Change an Interaction state to disabled or enabled.
SyntaxParameters
sessionId
The SessionId of the agent to disable or enable the interaction for..
value
true to enable the Interaction, false to disable it.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SetEnabled Method
Change an Interaction state to disabled or enabled.
SyntaxParameters
agent
The agent to disable or enable the interaction for.
value
true to enable the Interaction, false to disable it.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SetEnabled Method
Change an Interaction state to disabled or enabled.
SyntaxParameters
value
true to enable the Interaction, false to disable it.
handler
Handler to be called when the event completes.
Returns
A legacy eventId
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SetEnabled Method
Change an Interaction state to disabled or enabled.
SyntaxParameters
value
true to enable the Interaction, false to disable it.
handler
Handler to be called when the event completes.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SetEnabled Method
Change an Interaction state to disabled or enabled.
SyntaxParameters
sessionId
The SessionId of the agent to disable or enable the interaction for..
value
true to enable the Interaction, false to disable it.
handler
Handler to be called when the event completes.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SetEnabled Method
Change an Interaction state to disabled or enabled.
SyntaxParameters
agent
The agent to disable or enable the interaction for.
value
true to enable the Interaction, false to disable it.
handler
Handler to be called when the event completes.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SetPrompt Method
Set the Interaction prompt string.
Syntax[Sansar.Script.Interface] public void SetPrompt (string prompt)
Parameters
prompt
The string to set the prompt to.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SetPrompt Method
Set the Interaction prompt string.
SyntaxParameters
sessionId
The sessionId of the user to change the prompt for.
prompt
The string to set the prompt to.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SetPrompt Method
Set the Interaction prompt string.
SyntaxParameters
agent
The agent to change the prompt for.
prompt
The string to set the prompt to.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SetPrompt Method
Set the Interaction prompt string.
SyntaxParameters
prompt
The string to set the prompt to.
handler
Handler to be called when the event completes.
Returns
A legacy eventId
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SetPrompt Method
Set the Interaction prompt string.
SyntaxParameters
prompt
The string to set the prompt to.
handler
Handler to be called when the event completes.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SetPrompt Method
Set the Interaction prompt string.
SyntaxParameters
sessionId
The sessionId of the user to change the prompt for.
prompt
The string to set the prompt to.
handler
Handler to be called when the event completes.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SetPrompt Method
Set the Interaction prompt string.
SyntaxParameters
agent
The agent to change the prompt for.
prompt
The string to set the prompt to.
handler
Handler to be called when the event completes.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Subscribe Method
Subscribes to Interaction Events.
SyntaxSee Also
Parameters
callback
Callback which is executed when the event completes.
persistent
Optional, set to false to unsubscribe after one event.
Returns
An Sansar.Script.IEventSubscription that can be used to cancel the subscription.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
InteractionData Class
Handler for Interaction events.
Syntax
Member Details
AgentId Property
The SessionId of the agent who clicked the Interaction.
SyntaxValue
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
ControlPoint Property
The ControlPoint that triggered the Interaction.
Syntax[get: Sansar.Script.Interface] public ControlPointType ControlPoint { get; }
Value
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
HitNormal Property
The normal direction at the position of the Interaction.
Syntax[get: Sansar.Script.Interface] public Sansar.Vector HitNormal { get; }
Value
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
HitPosition Property
The position of the Interaction.
Syntax[get: Sansar.Script.Interface] public Sansar.Vector HitPosition { get; }
Value
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Origin Property
The position of the start of the ray that triggered the Interaction.
Syntax[get: Sansar.Script.Interface] public Sansar.Vector Origin { get; }
Value
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
ToString Method
A string representation of this object.
Syntax[Sansar.Script.Interface] public override string ToString ()
Returns
A string representation of this object.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Last updated