Scene

Scene info, Object Script, Private, CreatClusterData, CreateClusterHandler docs.

SceneInfo Class

Information about a Scene.

Syntax

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

Requirements

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

---

ApiVersion Field

Api version the scene is running.

Syntax

public static readonly Version ApiVersion

Remarks

Requirements

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

---

ApiVersionString Field

Api version the scene is running.

Syntax

public static readonly string ApiVersionString

Remarks

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

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

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

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

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

Requirements

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

---

EventId Property

The event id of this scene if it is part of an event.

Syntax

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

Value

The Guid for this event as a string.

Remarks

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

Requirements

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

---

ExperienceName Property

Scene's experience name.

Syntax

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

Value

Experience name string

Remarks

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

---

InstanceRole Property

The role of this scene.

Syntax

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

Value

The role of this instance: "Unset", "Broadcaster", or "Clone".

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

Requirements

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

---

MaxUsers Property

Maximum number of users allowed per instance of this scene.

Syntax

[get: Sansar.Script.Interface] public int MaxUsers { get; }

Value

Maximum number of users allowed in the scene.

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

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

Requirements

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

---

---

SceneObjectScript Class

Extend SceneObjectScript to create a script that can be used on content that is natively in the scene. This is the primary script type in Sansar.

Syntax

Member Details

SceneObjectScript Constructor

This constructor is called before any properties have been set. Override Sansar.Script.ScriptBase.Init() to initialize the script after properties have been set.

Syntax

[Sansar.Script.Interface] protected SceneObjectScript ()

Remarks

Requirements

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

---

AllowedContexts Property

Internal use only.

Syntax

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

---

ObjectPrivate Property

The ObjectPrivate this script is attached to if it is attached to an object.

Syntax

[Sansar.Script.NonReflective] [get: Sansar.Script.Interface] public ObjectPrivate ObjectPrivate { protected get; set; }

Value

The scene object this script is attached to if it is attached to an object, null otherwise.

Remarks

Requirements

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

---

ScenePrivate Property

The Scene API for the Scene this script is a part of if the script is attached to scene content.

Syntax

[Sansar.Script.NonReflective] [get: Sansar.Script.Interface] public ScenePrivate ScenePrivate { protected get; set; }

Value

The Scene API for this scene if this script was attached to scene content, null otherwise.

Remarks

Requirements

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

---

---

AgentCount Property

The number of agents in the Scene.

Syntax

[get: Sansar.Script.Interface] public uint AgentCount { get; }

Value

Unsigned integer count of the number of agents in the Scene.

Remarks

Requirements

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

---

CastBox Method

Casts a box from start to end and returns an array of collisions along the path.

Syntax

Parameters

halfExtents

The x,y,z distance from the center of the box to the corresponding face.

start

The initial point of the query.

end

The end point of the query.

Returns

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

---

CastBox Method

Casts a box from start to end and returns an array of collisions along the path.

Syntax

Parameters

halfExtents

The x,y,z distance from the center of the box to the corresponding face.

orientation

The orientation of the query shape.

start

The initial point of the query.

end

The end point of the query.

Returns

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

---

CastBox Method

Casts a box from start to end and returns an array of collisions along the path.

Syntax

Parameters

halfExtents

The x,y,z distance from the center of the box to the corresponding face.

start

The initial point of the query.

end

The end point of the query.

maxHits

Limit the number of results returned.

Returns

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

---

CastBox Method

Casts a box from start to end and returns an array of collisions along the path.

Syntax

Parameters

halfExtents

The x,y,z distance from the center of the box to the corresponding face.

orientation

The orientation of the query shape.

start

The initial point of the query.

end

The end point of the query.

maxHits

Limit the number of results returned.

Returns

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

---

CastCapsule Method

Casts a capsule from start to end and returns an array of collisions along the path.

Syntax

Parameters

capsuleStart

The base point of the capsule.

capsuleEnd

The end point of the capsule.

capsuleRadius

The radius of the capsule to query.

start

The initial point of the query.

end

The end point of the query.

Returns

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

---

CastCapsule Method

Casts a capsule from start to end and returns an array of collisions along the path.

Syntax

Parameters

capsuleStart

The base point of the capsule.

capsuleEnd

The end point of the capsule.

capsuleRadius

The radius of the capsule to query.

orientation

The orientation of the query shape.

start

The initial point of the query.

end

The end point of the query.

Returns

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

---

CastCapsule Method

Casts a capsule from start to end and returns an array of collisions along the path.

Syntax

Parameters

capsuleStart

The base point of the capsule.

capsuleEnd

The end point of the capsule.

capsuleRadius

The radius of the capsule to query.

start

The initial point of the query.

end

The end point of the query.

maxHits

Limit the number of results returned.

Returns

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

---

CastCapsule Method

Casts a capsule from start to end and returns an array of collisions along the path.

Syntax

Parameters

capsuleStart

The base point of the capsule.

capsuleEnd

The end point of the capsule.

capsuleRadius

The radius of the capsule to query.

orientation

The orientation of the query shape.

start

The initial point of the query.

end

The end point of the query.

maxHits

Limit the number of results returned.

Returns

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

---

CastRay Method

Casts a ray from start to end and returns an array of collisions along the path.

Syntax

Parameters

start

The initial point of the query.

end

The end point of the query.

Returns

An array of hit results, ordered from nearest to furthest. If the cast did not hit anything the array will be empty.

Remarks

Requirements

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

---

CastRay Method

Casts a ray from start to end and returns an array of collisions along the path.

Syntax

Parameters

start

The initial point of the query.

end

The end point of the query.

maxHits

Limit the number of results returned.

Returns

An array of hit results, ordered from nearest to furthest. If the cast did not hit anything the array will be empty.

Remarks

Requirements

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

---

CastSphere Method

Casts a sphere from start to end and returns an array of collisions along the path.

Syntax

Parameters

radius

The radius of the sphere.

start

The initial point of the query.

end

The end point of the query.

Returns

An array of hit results, ordered from nearest to furthest. If the cast did not hit anything the array will be empty.

Remarks

Requirements

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

---

CastSphere Method

Casts a sphere from start to end and returns an array of collisions along the path.

Syntax

Parameters

radius

The radius of the sphere.

start

The initial point of the query.

end

The end point of the query.

maxHits

Limit the number of results returned.

Returns

An array of hit results, ordered from nearest to furthest. If the cast did not hit anything the array will be empty.

Remarks

Requirements

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

---

Chat Property

Gets the Chat interface for this Scene

Syntax

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

Value

The Chat Api

Remarks

Requirements

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

---

CreateCluster Method

Creates a new cluster and adds it to the Scene.

Syntax

Parameters

asset

Asset identifier to create.

position

Mono.Simd.Vector4f for the initial position.

rotation

Mono.Simd.Vector4f for the initial rotation.

initialVelocity

Mono.Simd.Vector4f for the initial velocity.

Returns

The internal event id for the completion event.

Remarks

Requirements

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

---

CreateCluster Method

Creates a new cluster and adds it to the Scene.

Syntax

Parameters

asset

Asset identifier to create.

position

Mono.Simd.Vector4f for the initial position.

rotation

Mono.Simd.Vector4f for the initial rotation.

initialVelocity

Mono.Simd.Vector4f for the initial velocity.

handler

Handler to be called when the event completes.

Returns

The internal event id for the completion event.

Remarks

The new object may start simulating before the event is triggered.

Requirements

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

---

CreateCluster Method

Creates a new cluster and adds it to the Scene.

Syntax

Parameters

asset

Asset identifier to create.

position

Mono.Simd.Vector4f for the initial position.

rotation

Mono.Simd.Vector4f for the initial rotation.

initialVelocity

Mono.Simd.Vector4f for the initial velocity.

handler

Handler to be called when the event completes.

Returns

The internal event id for the completion event.

Remarks

Requirements

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

---

DefaultGravity Property

The default gravity magnitude in the scene in m/s^2, which is equal to 9.81 or 1 G.

Syntax

[get: Sansar.Script.Interface] public float DefaultGravity { get; }

Value

The default scene gravity magnitude.

Remarks

Example

C# Example

float sansarGravity = ScenePrivate.DefaultGravity; // Get default gravity in m/s^2

Requirements

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

---

FindAgent Method

Looks up an Agent associated with the given object id.

Syntax

Parameters

objectId

The object to find.

Returns

The agent, or null if an agent cannot be found with that id.

Remarks

Requirements

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

---

FindAgent Method

Looks up an Agent associated with the given session id if they are in the scene.

Syntax

Parameters

sessionId

The session id of the agent to find.

Returns

The agent, or null if an agent cannot be found with that id in the scene.

Remarks

Requirements

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

---

FindAgent Method

Looks up an Agent associated with the given persona id, if they are in the scene.

Syntax

[Sansar.Script.Interface] public AgentPrivate FindAgent (Guid personaId)

Parameters

personaId

The object to find.

Returns

The agent, or null if an agent cannot be found with that id in the scene.

Remarks

Requirements

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

---

FindObject Method

Looks up a Object associated with the given object id.

Syntax

Parameters

objectId

The object to find.

Returns

The ObjectPrivate, or null if a Object cannot be found with that id.

Remarks

Requirements

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

---

FindReflective Generic Method

Looks up Reflective objects in the scene that match the interface type by class name.

Syntax

[Sansar.Script.Interface] [Sansar.Script.NonReflective] [System.Runtime.CompilerServices.IteratorStateMachine(typeof(Sansar.Simulation.ScenePrivate/d__116`1))] public IEnumerable FindReflective (string name) where TInterface : class

Type Parameters

TInterface

The interface type to find.

Parameters

name

The type name of the object's class to find.

Returns

An IEnumerable which contains all objects of the given type name that match the given interface.

Remarks

Requirements

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

---

FindScript Method

Looks up the script object associated with the given scriptId

Syntax

Parameters

scriptId

The scriptId of the object to find.

Returns

The script object, or null if an script cannot be found with that id in the scene.

Remarks

Requirements

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

---

GetAgent Method

Syntax

[Sansar.Script.Interface] public AgentPrivate GetAgent (uint index)

Parameters

index

The index of the agent to get.

Returns

Returns null if the index is larger than the number of agents in the Scene, or if the agent is not fully loaded.

Remarks

Requirements

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

---

GetAgents Method

Returns the current list of Agents in the Scene.

Syntax

Returns

The current list of agents in the Scene

Remarks

Requirements

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

---

GetBoxClosestPoints Method

Extends a box with the given half extents the maximum distance and returns any hits.

Syntax

Parameters

halfExtents

The x,y,z distance from the center of the box to the corresponding face.

origin

The center of the query.

maximumDistance

the maximum distance from the origin to check.

Returns

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

---

GetBoxClosestPoints Method

Extends a box with the given half extents the maximum distance and returns any hits.

Syntax

Parameters

halfExtents

The x,y,z distance from the center of the box to the corresponding face.

origin

The center of the query.

orientation

The orientation of the query shape.

maximumDistance

the maximum distance from the origin to check.

Returns

An array of hit results, ordered from nearest to furthest. If the cast did not hit anything the array will be empty.

Remarks

Requirements

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

---

GetBoxClosestPoints Method

Extends a box with the given half extents the maximum distance and returns any hits.

Syntax

Parameters

halfExtents

The x,y,z distance from the center of the box to the corresponding face.

origin

The center of the query.

maximumDistance

the maximum distance from the origin to check.

maxHits

Limit the number of results returned.

Returns

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

---

GetBoxClosestPoints Method

Extends a box with the given half extents the maximum distance and returns any hits.

Syntax

Parameters

halfExtents

The x,y,z distance from the center of the box to the corresponding face.

origin

The center of the query.

orientation

The orientation of the query shape.

maximumDistance

the maximum distance from the origin to check.

maxHits

Limit the number of results returned.

Returns

An array of hit results, ordered from nearest to furthest. If the cast did not hit anything the array will be empty.

Remarks

Requirements

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

---

GetCapsuleClosestPoints Method

Extends a capsule with the given parameters the maximum distance and returns any hits.

Syntax

Parameters

capsuleStart

The base point of the capsule.

capsuleEnd

The end point of the capsule.

capsuleRadius

The radius of the capsule to query.

origin

The base of the capsule.

maximumDistance

the maximum distance from the origin to check.

Returns

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

---

GetCapsuleClosestPoints Method

Extends a capsule with the given parameters the maximum distance and returns any hits.

Syntax

Parameters

capsuleStart

The base point of the capsule.

capsuleEnd

The end point of the capsule.

capsuleRadius

The radius of the capsule to query.

origin

The base of the capsule.

orientation

The orientation of the query shape.

maximumDistance

the maximum distance from the origin to check.

Returns

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

---

GetCapsuleClosestPoints Method

Extends a capsule with the given parameters the maximum distance and returns any hits.

Syntax

Parameters

capsuleStart

The base point of the capsule.

capsuleEnd

The end point of the capsule.

capsuleRadius

The radius of the capsule to query.

origin

The base of the capsule.

maximumDistance

the maximum distance from the origin to check.

maxHits

Limit the number of results returned.

Returns

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

---

GetCapsuleClosestPoints Method

Extends a capsule with the given parameters the maximum distance and returns any hits.

Syntax

Parameters

capsuleStart

The base point of the capsule.

capsuleEnd

The end point of the capsule.

capsuleRadius

The radius of the capsule to query.

origin

The base of the capsule.

orientation

The orientation of the query shape.

maximumDistance

the maximum distance from the origin to check.

maxHits

Limit the number of results returned.

Returns

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

---

GetGravity Method

Gets the scene's current acceleration of gravity in m/s^2.

Syntax

[Sansar.Script.Interface] public float GetGravity ()

Returns

Number indicating the magnitude of gravity in the scene.

Remarks

Example

C# Example

float currentGravity = ScenePrivate.GetGravity(); // Get the current scene gravity in m/s^2

Requirements

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

---

GetPortalCreatorName Method

The name of the user who created the specified portal.

Syntax

Parameters

objectId

Documentation for this section has not yet been entered.

Returns

String

Remarks

Requirements

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

---

GetPortalDescription Method

Description for the specified portal.

Syntax

Parameters

objectId

Documentation for this section has not yet been entered.

Returns

String

Remarks

Requirements

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

---

GetPortalUri Method

URI destination for the specified portal.

Syntax

Parameters

objectId

Documentation for this section has not yet been entered.

Returns

String

Remarks

Requirements

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

---

GetSphereClosestPoints Method

Extends a sphere with the given radius the maximum distance and returns any hits.

Syntax

Parameters

radius

The radius of the sphere to query.

origin

The center of the query.

maximumDistance

the maximum distance from the origin to check.

Returns

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

---

GetSphereClosestPoints Method

Extends a sphere with the given radius the maximum distance and returns any hits.

Syntax

Parameters

radius

The radius of the sphere to query.

origin

The center of the query.

maximumDistance

the maximum distance from the origin to check.

maxHits

Limit the number of results returned.

Returns

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

---

GravityMaximum Field

The maximum gravity magnitude in m/s^2, which is equal to 49.05 or 5 G's.

Syntax

public static readonly float GravityMaximum

Remarks

Requirements

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

---

GravityMinimum Field

The minimum allowed gravity magnitude in m/s^2, which is equal to zero.

Syntax

public static readonly float GravityMinimum

Remarks

Requirements

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

---

HttpClient Property

Gets the HttpClient for this Scene

Syntax

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

Value

The HttpClient Api

Remarks

Requirements

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

---

MaximumCastRayResults Field

The maximum number of results returned from a ., . or . call. Anything over this will be truncated.

Syntax

public static readonly int MaximumCastRayResults

Remarks

Requirements

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

---

MinimumCastRadius Field

The minimum radius for a . call or minimum half extents for .. Any value smaller than this will use . instead.

Syntax

public static readonly float MinimumCastRadius

Remarks

Requirements

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

---

OverrideAudioStream Method

Overrides source of web audio streams.

Syntax

[Sansar.Script.Interface] public void OverrideAudioStream (string url)

Parameters

url

URL to use.

Remarks

Requirements

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

---

OverrideAudioStream Method

Overrides source of web audio streams.

Syntax

Parameters

url

URL to use.

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

---

OverrideMediaSource Method

Sets stream channel source.

Syntax

[Sansar.Script.Interface] public void OverrideMediaSource (string url)

Parameters

url

URL to use.

Remarks

Requirements

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

---

OverrideMediaSource Method

Overrides source of media surfaces.

Syntax

[Sansar.Script.Interface] public void OverrideMediaSource (string url, int mediaWidth, int mediaHeight)

Parameters

url

URL to use.

mediaWidth

(cMediaChannel only) source width.

mediaHeight

(cMediaChannel only) source height.

Remarks

Requirements

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

---

OverrideMediaSource Method

Overrides source of media surfaces.

Syntax

Parameters

url

URL to use.

mediaWidth

(cMediaChannel only) source width.

mediaHeight

(cMediaChannel only) source height.

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

---

PerformMediaAction Method

Performs a specific action on the current media surface.

Syntax

[Sansar.Script.Interface] public void PerformMediaAction (MediaAction action)

Parameters

action

The action to perform.

Remarks

Requirements

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

---

PerformMediaAction Method

Performs a specific action on the current media surface.

Syntax

Parameters

action

The action to perform.

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

---

PlaySound Method

Play sound to direct output.

Syntax

Parameters

soundResource

The sound resource to play.

playSettings

The play parameters.

Returns

The play handle for controlling playback.

Remarks

Requirements

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

---

PlaySoundAtPosition Method

Play sound at specified position.

Syntax

Parameters

soundResource

The sound resource to play.

position

The absolute position.

playSettings

The play parameters.

Returns

The play handle for controlling playback.

Remarks

Requirements

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

---

PlayStream Method

Play web audio stream to direct output.

Syntax

Parameters

streamChannel

Channel of the audio stream to play.

loudness

Relative loudness in dB.

Returns

The play handle for controlling playback.

Remarks

Requirements

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

---

PlayStreamAtPosition Method

Play web audio stream at specified position.

Syntax

Parameters

streamChannel

Channel of the audio stream to play.

position

The absolute position.

loudness

Relative loudness in dB.

Returns

The play handle for controlling playback.

Remarks

Requirements

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

---

ResetScene Method

Restarts the Scene.

Syntax

[Sansar.Script.Interface(Restricted=true)] public void ResetScene ()

Remarks

Requirements

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

---

SceneInfo Property

Gets the SceneInfo for this Scene

Syntax

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

Value

The full SceneInfo Api

Remarks

Requirements

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

---

SetGravity Method

Sets the scene's current gravity acceleration in m/s^2.

Syntax

[Sansar.Script.Interface] public void SetGravity (float scale)

Parameters

scale

The gravity magnitude.

Returns

The return value is an internal event id which can be passed to Sansar.Script.ScriptBase.WaitFor from a coroutine for synchronous behavior.

Remarks

Example

C# Example

ScenePrivate.SetGravity(1.622f); // Set the scene to moon gravity

Requirements

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

---

SetGravity Method

Sets the scene's current gravity acceleration in m/s^2.

Syntax

Parameters

scale

The gravity magnitude.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id which can be passed to Sansar.Script.ScriptBase.WaitFor from a coroutine for synchronous behavior.

Remarks

Example

C# Example

ScenePrivate.SetGravity(1.622f); // Set the scene to moon gravity

Requirements

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

---

SetGravity Method

Sets the scene's current gravity acceleration in m/s^2.

Syntax

Parameters

scale

The gravity magnitude.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id which can be passed to Sansar.Script.ScriptBase.WaitFor from a coroutine for synchronous behavior.

Remarks

Example

C# Example

ScenePrivate.SetGravity(1.622f); // Set the scene to moon gravity

Requirements

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

---

SetMegaphone Method

Sets the megaphone status of the user.

Syntax

[Sansar.Script.Interface] public void SetMegaphone (AgentPrivate agent, bool enable)

Parameters

agent

Agent to broadcast.

enable

If true, user's voice will be heard by everyone in the scene. If false, user's voice will be spatialized normally.

Remarks

Requirements

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

---

SetMegaphone Method

Sets the megaphone status of the user.

Syntax

Parameters

agent

Agent to broadcast.

enable

If true, user's voice will be heard by everyone in the scene. If false, user's voice will be spatialized normally.

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

---

ToString Method

A string representation of this object.

Syntax

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

---

User Property

Gets the User interface for this Scene

Syntax

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

Value

The User Api

Remarks

Requirements

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

---

VoiceBroadcastStart Method

Start broadcasting agent's voice to the voice broadcast channel.

Syntax

[Sansar.Script.Interface] [System.Obsolete("Deprecated. use ScenePrivate.SetMegaphone(agent, true) instead", false)] public void VoiceBroadcastStart (AgentPrivate agent)

Parameters

agent

Agent to broadcast.

Remarks

Requirements

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

---

VoiceBroadcastStop Method

Stop broadcasting agent's voice to voice broadcast channel.

Syntax

[Sansar.Script.Interface] [System.Obsolete("Deprecated. use ScenePrivate.SetMegaphone(agent, false) instead", false)] public void VoiceBroadcastStop (AgentPrivate agent)

Parameters

agent

Agent to stop broadcasting.

Remarks

Requirements

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

---

VoiceBroadcastStopAll Method

Stop broadcasting all voices to voice broadcast channel.

Syntax

[Sansar.Script.Interface] [System.Obsolete("Deprecated. use AgentPrivate.SetMegaphone(false) instead", false)] public void VoiceBroadcastStopAll ()

Remarks

Requirements

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

---