AgentInfo

Sansar.Simulation.AgentInfo

AgentInfo Class

The AgentInfo class has basic information and IDs for an agent.

Syntax

[Sansar.Script.Interface]
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

AAgents 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

Members

See Also: Inherited members from Sansar.Script.InstanceInterface.

Public Properties

[read-only]
 
AvatarUuid Guid . Returns the persona ID 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]
 
PersonaId Guid . Obsolete, see AgentInfo.AvatarUuid
[read-only]
 
SessionId Sansar.Script.SessionId . Returns the Id of the AgentInfo.

Public Methods

override
ToString () : string
A string representation of this object.

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 AgentInfo

Remarks

Agent persona IDs 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 AgentInfo

Remarks

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 AgentInfo

Remarks

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

PersonaId Property

Obsolete, see AgentInfo.AvatarUuid

Syntax

[System.Obsolete("Deprecated. See AvatarUuid.", false)]
[get: Sansar.Script.Interface]
public Guid PersonaId { get; }

Value

Documentation for this section has not yet been entered.

Remarks

 

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 AgentInfo

Remarks

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

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


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.