Client

Client Class

The Client class is used for access to the Client connected to a Sansar.Simulation.AgentPrivate.

Syntax

Member Details

AgentInfo Property

Syntax

[get: Sansar.Script.Interface] public AgentInfo AgentInfo { get; }

Value

The Sansar.Simulation.AgentInfo for this instance

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

ClearTutorialHint Method

Clears any scripted tutorial hint being shown to the player

Syntax

[Sansar.Script.Interface] public void ClearTutorialHint ()

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

ClearTutorialHint Method

Clears any scripted tutorial hint being shown to the player

Syntax

Parameters

handler

Handler to be called when the event completes.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

EnableAutomaticTutorialHints Method

Enables / Disables automatic (non-scripted) tutorial hints.

Syntax

[Sansar.Script.Interface] public void EnableAutomaticTutorialHints (bool enabled)

Parameters

enabled

Enabled state of automatic hints.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

EnableAutomaticTutorialHints Method

Enables / Disables automatic (non-scripted) tutorial hints.

Syntax

Parameters

enabled

Enabled state of automatic hints.

handler

Handler to be called when the event completes.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

OpenQuestCharacterDialog Method

Opens the quest dialog for a character.

Syntax

[Sansar.Script.Interface] public void OpenQuestCharacterDialog (QuestCharacter character)

Parameters

character

The character to open the quest dialog for.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

OpenStoreListing Method

Opens the product's Store page.

Syntax

[Sansar.Script.Interface] public void OpenStoreListing (Guid productId)

Parameters

productId

A product ID from a Sansar store listing.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

SendChat Method

Sends a string message to the $className$.

Syntax

[Sansar.Script.Interface] [System.Obsolete("Deprecated. Use AgentPrivate.SendChat or AgentPublic.SendChat", false)] public void SendChat (string message)

Parameters

message

The message to send.

Exceptions

Type	Reason
NullReferenceException	If the user is no longer online.
Sansar.Script.ThrottleException	If the throttle rate is exceeded.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

ShowTutorialHint Method

Show a tutorial hint to the player

Syntax

[Sansar.Script.Interface] public void ShowTutorialHint (TutorialHint hint)

Parameters

hint

The hint to show.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

ShowTutorialHint Method

Show a tutorial hint to the player

Syntax

Parameters

hint

The hint to show.

handler

Handler to be called when the event completes.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

SubscribeToCommand Method

Subscribes to Command Events.

Syntax

See Also

Parameters

Command

The command 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.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

SubscribeToCommand Method

Subscribes to Command Events.

Syntax

See Also

Parameters

Command

The command which occurred.

Action

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.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

TeleportTo Method

Teleports to the position facing the specified direction

Syntax

Parameters

position

The teleport destination position.

forward

The teleport destination forward direction.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

TeleportToLocation Method

Teleports the personaHandle to the locationHandle.

Syntax

[Sansar.Script.Interface] public void TeleportToLocation (string avatarId, string locationHandle)

Parameters

avatarId

The SceneInfo.AvatarId of the destination creator.

locationHandle

The SceneInfo.LocationHandle of the destination.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

TeleportToUri Method

Teleports to the specified URI

Syntax

[Sansar.Script.Interface] public void TeleportToUri (string sansarUri)

Parameters

sansarUri

The URI to teleport to.

Remarks

Requirements

Namespace: 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

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

UI Property

Syntax

[get: Sansar.Script.Interface] public UI UI { get; }

Value

The Sansar.Simulation.UI for this instance

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

VibrationPulse Method

Pulses the vibration haptic motor for a control point.

Syntax

Parameters

type

See Sansar.Simulation.ControlPointType

intensity

Intensity of vibration. Intensity will be clamped to the range [0, 1].

duration

Duration of the pulse in milliseconds. Will be clamped to the range [0, 1000].

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0

---

---