AgentInfo Class
The AgentInfo class has basic information and IDs for an agent.
Syntax
[Sansar.Script.Interface]
public class AgentInfo : Sansar.Script.InstanceInterface
public class AgentInfo : Sansar.Script.InstanceInterface
Exceptions
Type Reason NullReferenceException Thrown when using an AgentInfo for a user who is no longer in the region.
Remarks
Agents may leave at any time. Attempting to use an AgentInfo interface for an agent no longer in the scene will throw a NullReferenceException.
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 Properties
| [read-only] | AvatarUuid | Guid . Returns the persona ID of the AgentInfo. |
| [read-only] | Handle | string . Returns the handle of the AgentInfo. |
| [read-only] | IsValid | bool . Whether or not this interface is valid. (Inherited from Sansar.Script.InstanceInterface.) |
| [read-only] | Name | string . Returns the name of the AgentInfo. |
| [read-only] | ObjectId | Sansar.Script.ObjectId . Returns the ObjectId of the AgentInfo. |
| [read-only] | Scale | float . Returns the scale for the user. |
| [read-only] | SessionId | Sansar.Script.SessionId . Returns the Id of the AgentInfo. |
| [read-only] | Ticket | string . Returns the ticket for the user if they purchased one. |
Public Methods
Member Details
AvatarUuid Property
Returns the persona ID of the AgentInfo.Syntax
[get: Sansar.Script.Interface]
public Guid AvatarUuid { get; }Value
The persona ID of the AgentInfoRemarks
Agent persona IDs are uniqueRequirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Handle Property
Returns the handle of the AgentInfo.Syntax
[get: Sansar.Script.Interface]
public string Handle { get; }Value
The handle of the AgentInfoRemarks
Agent handles are unique.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Name Property
Returns the name of the AgentInfo.Syntax
[get: Sansar.Script.Interface]
public string Name { get; }Value
The name of the AgentInfoRemarks
Agent names may not be unique.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
ObjectId Property
Returns the ObjectId of the AgentInfo.Syntax
[get: Sansar.Script.Interface]
public Sansar.Script.ObjectId ObjectId { get; }Value
The object ID of the AgentInfoRemarks
The object id can be used to compare agents or look up the Sansar.Simulation.ObjectPrivate associated with the agent.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Scale Property
Returns the scale for the user.Syntax
[get: Sansar.Script.Interface]
public float Scale { get; }Value
The scale of the userRemarks
This is the scale setting from the character editor.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
SessionId Property
Returns the Id of the AgentInfo.Syntax
[get: Sansar.Script.Interface]
public Sansar.Script.SessionId SessionId { get; }Value
The id of the AgentInfoRemarks
The id can be used for quick comparison between Agents.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Ticket Property
Returns the ticket for the user if they purchased one.Syntax
[get: Sansar.Script.Interface]
public string Ticket { get; }Value
The ticket of the userRemarks
Will be an empty string if no ticket was used to enter the scene or event.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
The format of this string may change between releases.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
0 Comments