SceneInfo

Sansar.Simulation.SceneInfo

SceneInfo Class

Information about a Scene.

Syntax

[Sansar.Script.Interface]
public class SceneInfo : Sansar.Script.InstanceInterface

Remarks

Provides read only access to Scene information.

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]
 
AccessGroup string . Access group of the scene.
[read-only]
 
AvatarId string . Persona handle for the owner of the scene.
[read-only]
 
AvatarUuid Guid . Persona ID for the owner of the scene.
[read-only]
 
BuildId string . Scene's build id for debugging.
[read-only]
 
CompatVersion string . Scene's asset compatibility version for debugging.
[read-only]
 
Configuration string . Scene's build configuration.
[read-only]
 
ExperienceId string . Scene's World Id.
[read-only]
 
ExperienceName string . Scene's experience id.
[read-only]
 
InstanceId string . Instance id for this specific instance of the scene.
[read-only]
 
IsValid bool . Whether or not this interface is valid. (Inherited from Sansar.Script.InstanceInterface.)
[read-only]
 
LocationHandle string . Location handle for the Experience.
[read-only]
 
PersonaHandle string . Obsolete, see SceneInfo.AvatarId
[read-only]
 
PersonaId Guid . Obsolete, see SceneInfo.AvatarUuid
[read-only]
 
ProtoVersion string . Scene's message protocol version for debugging.
[read-only]
 
SansarUri string . The full Sansar URI for this instance of the scene.
[read-only]
 
WorldId string . Obsolete, see SceneInfo.ExperienceId

Public Methods

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

Member Details

AccessGroup Property

Access group of the scene.

Syntax

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

Value

String name of the access group.

Remarks

For internal debugging

Requirements

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

AvatarId Property

Persona handle for the owner of the scene.

Syntax

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

Value

String

Remarks

This handle can be used with Client.TeleportToLocation(string, string).

Requirements

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

AvatarUuid Property

Persona ID for the owner of the scene.

Syntax

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

Value

System.Guid

Remarks

The persona ID can be used to verify an agent is the owner of the scene. To retrieve the agent's id use AgentInfo.PersonaId.

Requirements

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

BuildId Property

Scene's build id for debugging.

Syntax

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

Value

String build id of the region server.

Remarks

For internal debugging.

Requirements

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

CompatVersion Property

Scene's asset compatibility version for debugging.

Syntax

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

Value

String

Remarks

All assets must match this version to load.

Requirements

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

Configuration Property

Scene's build configuration.

Syntax

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

Value

Expected values are debug, release or production.

Remarks

For internal debugging

Requirements

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

ExperienceId Property

Scene's World Id.

Syntax

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

Value

World id string

Remarks

For internal debugging.

Requirements

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

ExperienceName Property

Scene's experience id.

Syntax

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

Value

Experience id string

Remarks

For internal debugging.

Requirements

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

InstanceId Property

Instance id for this specific instance of the scene.

Syntax

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

Value

String

Remarks

 

Requirements

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

LocationHandle Property

Location handle for the Experience.

Syntax

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

Value

String

Remarks

This handle can be used with Client.TeleportToLocation(string, string).

Requirements

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

PersonaHandle Property

Obsolete, see SceneInfo.AvatarId

Syntax

[System.Obsolete("Deprecated. See AvatarId.", false)]
[get: Sansar.Script.Interface]
public string PersonaHandle { 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

PersonaId Property

Obsolete, see SceneInfo.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

ProtoVersion Property

Scene's message protocol version for debugging.

Syntax

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

Value

String

Remarks

Can be used to verify the Experience's protocol version is the expected value.

Requirements

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

SansarUri Property

The full Sansar URI for this instance of the scene.

Syntax

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

Value

String

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

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

WorldId Property

Syntax

[System.Obsolete("Deprecated. See ExperienceId.", false)]
[get: Sansar.Script.Interface]
public string WorldId { 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


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

0 Comments

Article is closed for comments.