User Class
The User class handles interactions user logins and logoffs.
Syntax
[Sansar.Script.Interface]
public class User : Sansar.Script.InstanceInterface
public class User : Sansar.Script.InstanceInterface
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Members
See Also: Inherited members from Sansar.Script.InstanceInterface.
Public Fields
|
static readonly
|
AddUser | string . For subscribing to events for users entering the scene |
|
static readonly
|
RemoveUser | string . For subscribing to events for users leaving the scene |
Public Properties
| [read-only]
|
IsValid | bool . Whether or not this interface is valid. (Inherited from Sansar.Script.InstanceInterface.) |
Public Methods
|
|
Subscribe (string, User.SubscriptionHandler, bool)
Subscribes to User Events. |
|
|
|
Subscribe (string, Action<UserData>, bool) : Sansar.Script.IEventSubscription
Subscribes to User Events. |
|
|
|
Subscribe (string, Sansar.Script.SessionId, User.SubscriptionHandler, bool)
Subscribes to User Events. |
|
|
|
Subscribe (string, Sansar.Script.SessionId, Action<UserData>, bool) : Sansar.Script.IEventSubscription
Subscribes to User Events. |
|
Member Details
AddUser Field
For subscribing to events for users entering the sceneSyntax
public static readonly string AddUserRemarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
RemoveUser Field
For subscribing to events for users leaving the sceneSyntax
public static readonly string RemoveUserRemarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Subscribe Method
Subscribes to User Events.Syntax
[Sansar.Script.Interface]
[System.Obsolete("Use subscription callbacks of type Action<Sansar.Simulation.UserData>", false)]
public void Subscribe (string Action, User.SubscriptionHandler callback, bool persistent)Parameters
- Action
- string action of the event: AddUser, RemoveUser
- 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 User Events.Syntax
[Sansar.Script.Interface]
public Sansar.Script.IEventSubscription Subscribe (string Action, Action<UserData> callback, bool persistent)See Also
Parameters
- Action
- string action of the event: AddUser, RemoveUser
- 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
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Subscribe Method
Subscribes to User Events.Syntax
[Sansar.Script.Interface]
[System.Obsolete("Use subscription callbacks of type Action<Sansar.Simulation.UserData>", false)]
public void Subscribe (string Action, Sansar.Script.SessionId User, User.SubscriptionHandler callback, bool persistent)Parameters
- Action
- string action of the event: AddUser, RemoveUser
- User
- Sansar.Script.SessionId for the user.
- 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 User Events.Syntax
[Sansar.Script.Interface]
public Sansar.Script.IEventSubscription Subscribe (string Action, Sansar.Script.SessionId User, Action<UserData> callback, bool persistent)See Also
Parameters
- Action
- string action of the event: AddUser, RemoveUser
- User
- Sansar.Script.SessionId for the user.
- 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
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
0 Comments