# Chat

### Chat Class

The Chat class handles chat subscriptions and sending messages to users and other scripts.

### Syntax

### Member Details

#### AllChannels Field

> #### Syntax
>
> \[Sansar.Script.Interface]\
> \[System.Obsolete("All channel subscription no longer allowed", false)]\
> public static readonly [int](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32) **AllChannels**
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### DefaultChannel Field

> #### Syntax
>
> public static readonly [int](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32) **DefaultChannel**
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### MessageAllUsers Method

> Send a chat message to every user in the Experience.
>
> #### Syntax
>
> \[Sansar.Script.Interface]\
> public [void](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void) **MessageAllUsers** ([string](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String) message)
>
> **Parameters**
>
> > *message*
> >
> > The message to send.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### MessageAllUsers Method

> Send a chat message to every user in the Experience.
>
> #### Syntax
>
> **Parameters**
>
> > *message*
> >
> > The message to send.
> >
> > *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
>
> ***

#### MessageScript Method

> Send a string message to a specific script.
>
> #### Syntax
>
> **Parameters**
>
> > *message*
> >
> > The message to send.
> >
> > *scriptId*
> >
> > The id of the script to send the message to.
> >
> > *channel*
> >
> > The channel to send the message on.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### Script Field

> Indicates that the chat message originated from a script.
>
> #### Syntax
>
> public static readonly [string](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String) **Script**
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### Server Field

> Indicates that the chat message originated from the server.
>
> #### Syntax
>
> public static readonly [string](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String) **Server**
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> **See Also**
>
> **Parameters**
>
> > *SourceScriptId*
> >
> > Sansar.Script.ScriptId id of the chat source. May be [Sansar.Script.ScriptId.Invalid](https://docs.sansar.com/latest/script-api-docs/sansar-simulation-namespace/pages/aGRf7YDf220Xo4vy13J3#F:Sansar.Script.ScriptId.Invalid) if the source is not a script.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> **Returns**
>
> > An [Sansar.Script.IEventSubscription](/latest/script-api-docs/sansar-script-namespace/ievent-subscription.md) 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
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> **See Also**
>
> **Parameters**
>
> > *SourceId*
> >
> > Sansar.Script.SessionId id of the chat source. May be [Sansar.Script.SessionId.Invalid](https://help.sansar.com/hc/en-us/articles/115003551808#F:Sansar.Script.SessionId.Invalid) if the source is not an agent.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> **Returns**
>
> > An [Sansar.Script.IEventSubscription](/latest/script-api-docs/sansar-script-namespace/ievent-subscription.md) 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
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> **See Also**
>
> **Parameters**
>
> > *Channel*
> >
> > int channel which the chat occurs on.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> **Returns**
>
> > An [Sansar.Script.IEventSubscription](/latest/script-api-docs/sansar-script-namespace/ievent-subscription.md) 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
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> **See Also**
>
> **Parameters**
>
> > *Source*
> >
> > string source of the chat: system, user or script.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> **Returns**
>
> > An [Sansar.Script.IEventSubscription](/latest/script-api-docs/sansar-script-namespace/ievent-subscription.md) 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
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> **See Also**
>
> **Parameters**
>
> > *Channel*
> >
> > int channel which the chat occurs on.
> >
> > *SourceScriptId*
> >
> > Sansar.Script.ScriptId id of the chat source. May be [Sansar.Script.ScriptId.Invalid](https://docs.sansar.com/latest/script-api-docs/sansar-simulation-namespace/pages/aGRf7YDf220Xo4vy13J3#F:Sansar.Script.ScriptId.Invalid) if the source is not a script.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> **Returns**
>
> > An [Sansar.Script.IEventSubscription](/latest/script-api-docs/sansar-script-namespace/ievent-subscription.md) 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
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> **See Also**
>
> **Parameters**
>
> > *Channel*
> >
> > int channel which the chat occurs on.
> >
> > *SourceId*
> >
> > Sansar.Script.SessionId id of the chat source. May be [Sansar.Script.SessionId.Invalid](https://help.sansar.com/hc/en-us/articles/115003551808#F:Sansar.Script.SessionId.Invalid) if the source is not an agent.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> **Returns**
>
> > An [Sansar.Script.IEventSubscription](/latest/script-api-docs/sansar-script-namespace/ievent-subscription.md) 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
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> \[Sansar.Script.Interface]\
> \[System.Obsolete("Use subscription callbacks of type Action\<Sansar.Simulation.ChatData>", false)]\
> public [void](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void) **Subscribe** ([int](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32) Channel, [string](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String) Source, [Chat.SubscriptionHandler](https://help.sansar.com/hc/en-us/articles/115003454606) callback, [bool](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean) persistent)
>
> **Parameters**
>
> > *Channel*
> >
> > int channel which the chat occurs on.
> >
> > *Source*
> >
> > string source of the chat: system, user or script.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> **See Also**
>
> **Parameters**
>
> > *Channel*
> >
> > int channel which the chat occurs on.
> >
> > *Source*
> >
> > string source of the chat: system, user or script.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> **Returns**
>
> > An [Sansar.Script.IEventSubscription](/latest/script-api-docs/sansar-script-namespace/ievent-subscription.md) 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
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> **See Also**
>
> **Parameters**
>
> > *Source*
> >
> > string source of the chat: system, user or script.
> >
> > *SourceScriptId*
> >
> > Sansar.Script.ScriptId id of the chat source. May be [Sansar.Script.ScriptId.Invalid](https://docs.sansar.com/latest/script-api-docs/sansar-simulation-namespace/pages/aGRf7YDf220Xo4vy13J3#F:Sansar.Script.ScriptId.Invalid) if the source is not a script.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> **Returns**
>
> > An [Sansar.Script.IEventSubscription](/latest/script-api-docs/sansar-script-namespace/ievent-subscription.md) 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
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> **See Also**
>
> **Parameters**
>
> > *Source*
> >
> > string source of the chat: system, user or script.
> >
> > *SourceId*
> >
> > Sansar.Script.SessionId id of the chat source. May be [Sansar.Script.SessionId.Invalid](https://help.sansar.com/hc/en-us/articles/115003551808#F:Sansar.Script.SessionId.Invalid) if the source is not an agent.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> **Returns**
>
> > An [Sansar.Script.IEventSubscription](/latest/script-api-docs/sansar-script-namespace/ievent-subscription.md) 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
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> \[Sansar.Script.Interface]\
> \[System.Obsolete("Use subscription callbacks of type Action\<Sansar.Simulation.ChatData>", false)]\
> public [void](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void) **Subscribe** ([int](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32) Channel, [string](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String) Source, [Sansar.Script.ScriptId](/latest/script-api-docs/sansar-script-namespace/scriptid.md) SourceScriptId, [Chat.SubscriptionHandler](https://help.sansar.com/hc/en-us/articles/115003454606) callback, [bool](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean) persistent)
>
> **Parameters**
>
> > *Channel*
> >
> > int channel which the chat occurs on.
> >
> > *Source*
> >
> > string source of the chat: system, user or script.
> >
> > *SourceScriptId*
> >
> > Sansar.Script.ScriptId id of the chat source. May be [Sansar.Script.ScriptId.Invalid](https://docs.sansar.com/latest/script-api-docs/sansar-simulation-namespace/pages/aGRf7YDf220Xo4vy13J3#F:Sansar.Script.ScriptId.Invalid) if the source is not a script.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> **See Also**
>
> **Parameters**
>
> > *Channel*
> >
> > int channel which the chat occurs on.
> >
> > *Source*
> >
> > string source of the chat: system, user or script.
> >
> > *SourceScriptId*
> >
> > Sansar.Script.ScriptId id of the chat source. May be [Sansar.Script.ScriptId.Invalid](https://docs.sansar.com/latest/script-api-docs/sansar-simulation-namespace/pages/aGRf7YDf220Xo4vy13J3#F:Sansar.Script.ScriptId.Invalid) if the source is not a script.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> **Returns**
>
> > An [Sansar.Script.IEventSubscription](/latest/script-api-docs/sansar-script-namespace/ievent-subscription.md) 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
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> \[Sansar.Script.Interface]\
> \[System.Obsolete("Use subscription callbacks of type Action\<Sansar.Simulation.ChatData>", false)]\
> public [void](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void) **Subscribe** ([int](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32) Channel, [string](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String) Source, [Sansar.Script.SessionId](https://help.sansar.com/hc/en-us/articles/115003551808) SourceId, [Chat.SubscriptionHandler](https://help.sansar.com/hc/en-us/articles/115003454606) callback, [bool](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean) persistent)
>
> **Parameters**
>
> > *Channel*
> >
> > int channel which the chat occurs on.
> >
> > *Source*
> >
> > string source of the chat: system, user or script.
> >
> > *SourceId*
> >
> > Sansar.Script.SessionId id of the chat source. May be [Sansar.Script.SessionId.Invalid](https://help.sansar.com/hc/en-us/articles/115003551808#F:Sansar.Script.SessionId.Invalid) if the source is not an agent.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> **See Also**
>
> **Parameters**
>
> > *Channel*
> >
> > int channel which the chat occurs on.
> >
> > *Source*
> >
> > string source of the chat: system, user or script.
> >
> > *SourceId*
> >
> > Sansar.Script.SessionId id of the chat source. May be [Sansar.Script.SessionId.Invalid](https://help.sansar.com/hc/en-us/articles/115003551808#F:Sansar.Script.SessionId.Invalid) if the source is not an agent.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> **Returns**
>
> > An [Sansar.Script.IEventSubscription](/latest/script-api-docs/sansar-script-namespace/ievent-subscription.md) 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
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> **Parameters**
>
> > *Channel*
> >
> > int channel which the chat occurs on.
> >
> > *Source*
> >
> > string source of the chat: system, user or script.
> >
> > *SourceId*
> >
> > Sansar.Script.SessionId id of the chat source. May be [Sansar.Script.SessionId.Invalid](https://help.sansar.com/hc/en-us/articles/115003551808#F:Sansar.Script.SessionId.Invalid) if the source is not an agent.
> >
> > *SourceScriptId*
> >
> > Sansar.Script.ScriptId id of the chat source. May be [Sansar.Script.ScriptId.Invalid](https://docs.sansar.com/latest/script-api-docs/sansar-simulation-namespace/pages/aGRf7YDf220Xo4vy13J3#F:Sansar.Script.ScriptId.Invalid) if the source is not a script.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### Subscribe Method

> Subscribes to Chat Events.
>
> #### Syntax
>
> **See Also**
>
> **Parameters**
>
> > *Channel*
> >
> > int channel which the chat occurs on.
> >
> > *Source*
> >
> > string source of the chat: system, user or script.
> >
> > *SourceId*
> >
> > Sansar.Script.SessionId id of the chat source. May be [Sansar.Script.SessionId.Invalid](https://help.sansar.com/hc/en-us/articles/115003551808#F:Sansar.Script.SessionId.Invalid) if the source is not an agent.
> >
> > *SourceScriptId*
> >
> > Sansar.Script.ScriptId id of the chat source. May be [Sansar.Script.ScriptId.Invalid](https://docs.sansar.com/latest/script-api-docs/sansar-simulation-namespace/pages/aGRf7YDf220Xo4vy13J3#F:Sansar.Script.ScriptId.Invalid) if the source is not a script.
> >
> > *callback*
> >
> > Callback which is executed when the event completes.
> >
> > *persistent*
> >
> > Optional, set to false to unsubscribe after one event.
>
> **Returns**
>
> > An [Sansar.Script.IEventSubscription](/latest/script-api-docs/sansar-script-namespace/ievent-subscription.md) 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
>
> ***

#### User Field

> Indicates that the chat message originated from a user.
>
> #### Syntax
>
> public static readonly [string](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String) **User**
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

***

### Chat.SubscriptionHandler Delegate

Subscribe to receive events on chat messages from the system, users or scripts.

**Parameters**

> *Channel*
>
> int channel which the chat occurs on.
>
> *Source*
>
> string source of the chat: system, user or script.
>
> *SourceId*
>
> Sansar.Script.SessionId id of the chat source. May be [Sansar.Script.SessionId.Invalid](https://help.sansar.com/hc/en-us/articles/115003551808#F:Sansar.Script.SessionId.Invalid) if the source is not an agent.
>
> *SourceScriptId*
>
> Sansar.Script.ScriptId id of the chat source. May be [Sansar.Script.ScriptId.Invalid](https://docs.sansar.com/latest/script-api-docs/sansar-simulation-namespace/pages/aGRf7YDf220Xo4vy13J3#F:Sansar.Script.ScriptId.Invalid) if the source is not a script.
>
> *Message*
>
> string message of the chat event.

### Remarks

### Requirements

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

***

### ChatData Class

Subscribe to receive events on chat messages from the system, users or scripts.

### Syntax

### Member Details

#### Channel Property

> int channel which the chat occurs on.
>
> #### Syntax
>
> \[get: Sansar.Script.Interface]\
> public [int](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Int32) **Channel** { get; }
>
> **Value**
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### Message Property

> string message of the chat event.
>
> #### Syntax
>
> \[get: Sansar.Script.Interface]\
> public [string](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String) **Message** { get; }
>
> **Value**
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### Source Property

> string source of the chat: system, user or script.
>
> #### Syntax
>
> \[get: Sansar.Script.Interface]\
> public [string](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String) **Source** { get; }
>
> **Value**
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### SourceId Property

> #### Syntax
>
> **Value**
>
> #### Remarks
>
> #### Requirements
>
> **Namespace:** Sansar.Simulation\
> **Assembly:** Sansar.Simulation (in Sansar.Simulation.dll)\
> **Assembly Versions:** 1.1.0.0
>
> ***

#### SourceScriptId Property

> #### Syntax
>
> **Value**
>
> #### 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](http://www.go-mono.com/docs/monodoc.ashx?link=T:System.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
>
> ***

***

#### Have more questions? Ask in our [Discord!](http://discord.gg/sansarofficial)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sansar.com/latest/script-api-docs/sansar-simulation-namespace/chat.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.