The Client class is used for access to the Client connected to a Sansar.Simulation.AgentPrivate.
Syntax[get: Sansar.Script.Interface] public AgentInfo { get; }
Value
The for this instance
Clears any scripted tutorial hint being shown to the player
Syntax[Sansar.Script.Interface] public ClearTutorialHint ()
Clears any scripted tutorial hint being shown to the player
SyntaxParameters
handler
Handler to be called when the event completes.
Enables / Disables automatic (non-scripted) tutorial hints.
Syntax[Sansar.Script.Interface] public EnableAutomaticTutorialHints ( enabled)
Parameters
enabled
Enabled state of automatic hints.
Enables / Disables automatic (non-scripted) tutorial hints.
SyntaxParameters
enabled
Enabled state of automatic hints.
handler
Opens the quest dialog for a character.
Syntax[Sansar.Script.Interface] public OpenQuestCharacterDialog ( character)
Parameters
character
The character to open the quest dialog for.
Opens the product's Store page.
Syntax[Sansar.Script.Interface] public OpenStoreListing ( productId)
Parameters
productId
A product ID from a Sansar store listing.
Sends a message to the $className$.
Syntax[Sansar.Script.Interface] [System.Obsolete("Deprecated. Use AgentPrivate.SendChat or AgentPublic.SendChat", false)] public SendChat ( message)
Parameters
message
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Show a tutorial hint to the player
Syntax[Sansar.Script.Interface] public ShowTutorialHint ( hint)
Parameters
hint
The hint to show.
Show a tutorial hint to the player
SyntaxParameters
hint
The hint to show.
handler
Handler to be called when the event completes.
Subscribes to Command Events.
SyntaxSee Also
Parameters
Command
The command which occurred.
Subscribes to Command Events.
SyntaxSee Also
Parameters
Command
The command which occurred.
Teleports to the position facing the specified direction
SyntaxParameters
position
The teleport destination position.
forward
Teleports the personaHandle to the locationHandle.
Syntax[Sansar.Script.Interface] public TeleportToLocation ( avatarId, locationHandle)
Parameters
avatarId
Teleports to the specified URI
Syntax[Sansar.Script.Interface] public TeleportToUri ( sansarUri)
Parameters
sansarUri
The URI to teleport to.
A string representation of this object.
Syntax[Sansar.Script.Interface] public override ToString ()
Returns
A string representation of this object.
Syntax[get: Sansar.Script.Interface] public UI { get; }
Value
The for this instance
Pulses the vibration haptic motor for a control point.
SyntaxParameters
type
See
intensity
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Exceptions
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Callback which is executed when the event completes.
canceled
Callback which is executed when the subscription is canceled.
persistent
Optional, set to false to unsubscribe after one event.
Returns
An Sansar.Script.IEventSubscription that can be used to cancel the subscription.
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
The action which occurred.
callback
Callback which is executed when the event completes.
canceled
Callback which is executed when the subscription is canceled.
persistent
Optional, set to false to unsubscribe after one event.
Returns
An Sansar.Script.IEventSubscription that can be used to cancel the subscription.
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
locationHandle
The SceneInfo.LocationHandle of the destination.
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
duration
Duration of the pulse in milliseconds. Will be clamped to the range [0, 1000].
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
If the user is no longer online.
If the throttle rate is exceeded.