Sansar Docs
  • 🚀Welcome to Sansar
  • 📚GLOSSARY
  • 🎏Patch Notes
  • 😇Work in Progress
  • ⚠️Creative Commons License
  • Support
    • General Troubleshooting
      • General FAQ
      • The Sansar Cache
      • The Sansar Log
    • Contact Support
  • Sansar Basics
    • Installation And Compatibility
      • Installing Sansar
      • System Requirements
      • Sansar Compatibility FAQ
      • Sansar on Mac
      • Body Tracking Vive
      • Configuring Firewalls
    • Account Management
      • Account Set Up
      • Avatar Name and ID
      • Adding Payment Method
      • Discord FAQ
      • Steam Integration
      • Subscription FAQ
    • Controls
      • Avatar Hand Gestures in VR
      • FreeCam and CineCam
      • Game Controller Buttons
      • HTC VIVE controls
      • Keyboard Shortcuts for Editing a Scene
      • Keyboard Shortcuts for Styling Your Avatar
      • Keyboard Shortcuts for Visiting an Experience
      • Mouselook Mode
      • Oculus Rift Controls
      • Vive Index Controls
    • Settings
      • General Settings
    • VR Settings
      • VR Settings Menu
      • Calibrating Height in VR
  • Exploring in Sansar
    • Navigate and Explore
      • The Codex
      • Instances
      • Interactive objects
      • The Main Menu
      • The Nexus
      • Portals
      • Quests
      • Quick Start: Exploring in Sansar
    • Socialize And Connect
      • Chat Panel
      • Experience Points, Levels, and Titles.
      • Finding People in Sansar
      • Identifying Interacting With Avatars
      • The People panel
      • User profiles
    • Attending events
      • Deploying Unpublished Event to Event World
      • Adding Events to Your Calendar
      • Attending Events in Sansar
      • Avatar Broadcasting FAQ
      • Creating Your Own Events
      • Redemption Codes
      • Tipping
    • Share Content
      • Streaming Sansar
      • Taking a photo
  • Avatar Creation
    • Avatar Basics
      • Avatar 2.0 FAQ
      • Customizing Your Avatar
      • Avatar Emotes
      • The Avatar Editor
    • Dressing The Avatar
      • Fitting Designer Clothing to your Avatar
      • Setting Custom Emotes
      • Wearing Accessories
      • Wearing Rigged Clothing
    • Managing Avatar Items
      • Importing Avatar-Related Items
      • Editing an inventory item's name
      • Editing an inventory item's image
      • Deleting avatar looks from your inventory
      • Importing a custom emote animation
      • Managing your avatar looks inventory items
    • Avatar Resources
      • Avatar Reference Files
      • Blender - Avatar files
      • Blender - Using Decimate Tool
      • Exporting Custom Avatars From Blender
      • Sansar Skeleton Skinning Details
      • Using Animation Skeleton
  • Creating In Sansar
    • Importing Things to Sansar
      • Supported file types
      • AABB Bounding Box and Item Restrictions
      • Importing Audio
      • Importing a Custom Avatar
      • Importing World Items
      • Importing Collision Volumes
      • Importing Accessories
      • Importing Clothing
      • Importing Emotes
      • Importing Hair
      • Importing Custom Scripts
      • Importing a Skybox
      • Troubleshooting Import Errors
    • Shaders and Materials
      • Shaders Information
      • Materials Information
      • VAT Shader Guides
        • VAT Shader Basics
        • VAT Technical Info
      • Displacement Guides
        • Simple Displacement
        • Advanced Displacement
    • Marvelous Designer Info
      • Marvelous Designer Integration
      • Marvelous Designer Creator Resources
      • Marvelous Import and Export
      • MD Limitations
    • Shader Scripting
    • Materials editing and shaders
    • Creator Tools
      • Creating a World
      • Creating Quests
      • Diagnostics Toolbar
      • Importing Items to Sansar
      • My Worlds Panel
    • Managing Worlds
      • Quick start: Creating experiences in Sansar
      • Deleting an experience or scene
      • Deploying a new scene to an existing experience
      • Editing a scene
      • Experience memos
      • Linking A Scene To A World
      • Managing your scenes and worlds
      • Moderation Tools for World Owners
      • Publishing Options for Your Experiences
      • Renaming a scene
      • Saving and Building A Scene
      • Sharing Your Experiences
      • Visiting your own experience
    • Part Of The World Editor
      • Object Stats Toolbar
      • Object Components
      • Parenting objects
      • Scene Item Inventory
      • Scene Objects Panel
      • Collision Volumes
      • Scene Settings
      • System objects
      • Object Motion Types
    • Working With Scripts
      • Working With Scripts
      • Working With Trigger Volume
      • Referencing Scene Components
      • Intro to Scripting in Sansar
      • Using the Script Console
      • Setting Script Parameters
      • Adding Scripts to an Object
      • Configuring Teleport Scripts
      • Simple Script User Guide
    • Working With Audio and Video
      • Working With Audio
      • Creating Media surface
      • Streaming Web Audio
      • Audio Emitter
      • Sansar Audio FAQ
      • Using Media Streams
      • Ambisonic Sounds
      • High Quality Spacial Audio
      • Audio Resource - Room Tones
      • Previewing Audio and Video in a Scene
      • Using Audio Materials
    • Working With Lights
      • Working With Lights
      • Light Types
      • Global Illumination
  • Sansar Store
    • Using the Sansar Store
      • The Sansar Store
      • Buying Items From The Store
      • Redelivering Lost Purchases
    • Buying and Selling Sansar Dollars
      • Gifting Sansar Dollars
      • Buying Sansar Dollars
      • Converting Sansar Dollars
      • Processing US Dollar Credit
    • Selling Your Content
      • Hidden Store Listings
      • Selling Items in Sansar Store
      • Selling Items in an Experience
      • Allowing Resale Of Items
      • Buyers Permissions
  • Guidelines and Moderation
    • Guidelines and Policies
      • Terms of service
      • Sansar's Discord Server Rules
      • Community Standards
      • Content Guidelines
      • World Publishing Guidelines
      • Store Listing Guidelines
      • Store Banner Guidelines
      • Event Guidelines
      • Privacy Policy
      • Sansar Freeware License Agreement
      • Intellectual Property Infringement Notification
      • Cookie Policy
    • Moderation and Reporting
      • Abuse and Griefing
      • Blocking Avatars
      • Muting Avatars
      • Reporting abuse
      • Reporting issues and bugs
      • Security issues
  • Script API Docs
    • General Information
      • External Script Repository's
      • Sansar Script API
      • Script API Updates
      • Restricted API's
    • Example Scripts
      • Example Scripts in Sansar
      • Cannonball
      • Follow The Path
      • Random Movement
      • Reflective Detector
      • Simple Script
      • Sound Randomizer
      • Stats Example
      • Teleport Hotkeys
      • Visitor Tracker
      • Mover Examples
    • Sansar Namespace
      • Namespace
      • Color
      • Mathf
      • Quarterion
      • Vector
      • Vector Extensions
    • Sansar.Script Namespace
      • AddEntryAttribute
      • CancelData
      • ComponentID
      • CoroutineException
      • Default Attributes
      • Editor Visible Attribute
      • Entries Attribute
      • Event Data
      • ICoroutine
      • IEvent Subscription
      • Instance Interface
      • Locked Attribute
      • Log
      • MaxEntriesAttribute
      • Memory
      • MinEntriesAttribute
      • NonReflectiveAttribute
      • ObjectID
      • OperationCompleteEvent
      • RangeAttribute
      • Reflective
      • Script.Base
      • Script Event Data
      • Script Handle
      • ScriptID
      • SessionID
      • Simple Script Event Data
      • ThrottleException
      • Timer
      • Tooltip Attribute
    • MetaData Namespace
      • Assembly MetaData
      • Script MetaData
    • Sansar Script Testing Namespace
      • Assertion Failure Exception
      • Assertions
    • Sansar Utility Namespace
      • GenericEnumerable <T>
      • GenericEnumerable<T>.GetItem
      • JSON Serialization Data
      • JSON Serialization Data 1
      • JSON Serializer
      • JSON Serializer Options
    • Sansar Simulation Namespace
      • Agent Info
      • Animation
      • Audio Component
      • Camera Control Mode
      • Character Tracker
      • Chat
      • Client
      • Cluster
      • Command Action and Data
      • Component Type
      • Control Point Type
      • Held Object
      • HTTP
      • Interaction
      • Light
      • Media Action
      • Mesh Component
      • Modal Dialogue
      • Move Mode and Mover
      • Objective
      • PlayHandle
      • PlaySettings
      • PlayStatus
      • Quest
      • RayCastHit
      • Rigid Body
      • Scene
      • Scene Public
      • Simple Script
      • Sit Event Type
      • Sit Object Data
      • Sound Resource
      • Stream Channel
      • Tutorial Hint
      • UI
      • User Data
Powered by GitBook
On this page
  • SceneInfo Class
  • Syntax
  • Member Details
  • SceneObjectScript Class
  • Syntax
  • Member Details
  1. Script API Docs
  2. Sansar Simulation Namespace

Scene

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

PreviousRigid BodyNextScene Public

Last updated 1 year ago

SceneInfo Class

Information about a Scene.

Syntax

Member Details

AccessGroup Property

Access group of the scene.

Syntax

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Value

The default scene gravity magnitude.

Remarks

Example

C# Example

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

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

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

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

Returns

Number indicating the magnitude of gravity in the scene.

Remarks

Example

C# Example

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

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

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

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

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

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.

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

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

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

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

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

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

Parameters

scale

The gravity magnitude.

Returns

Remarks

Example

C# Example

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

Remarks

Example

C# Example

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

Remarks

Example

C# Example

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.

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

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

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

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

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

Remarks

Requirements

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


public static readonly ApiVersion

public static readonly ApiVersionString

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[Sansar.Script.Interface] public override ToString ()

This constructor is called before any properties have been set. Override to initialize the script after properties have been set.

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

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

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

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

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

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

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

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

[Sansar.Script.Interface] public GetGravity ()

public static readonly GravityMaximum

public static readonly GravityMinimum

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

public static readonly MaximumCastRayResults

public static readonly MinimumCastRadius

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

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

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

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

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

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

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

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

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

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

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

[Sansar.Script.Interface] public override ToString ()

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

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

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

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

float sansarGravity = ScenePrivate.DefaultGravity; // Get default gravity in m/s^2
float currentGravity = ScenePrivate.GetGravity(); // Get the current scene gravity in m/s^2
ScenePrivate.SetGravity(1.622f); // Set the scene to moon gravity
ScenePrivate.SetGravity(1.622f); // Set the scene to moon gravity
ScenePrivate.SetGravity(1.622f); // Set the scene to moon gravity
string
Version
string
string
Guid
string
string
string
string
string
string
string
string
string
int
string
string
string
Sansar.Script.ScriptBase.Init()
ObjectPrivate
ScenePrivate
uint
Chat
float
AgentPrivate
Guid
IEnumerable
string
AgentPrivate
uint
float
float
float
HttpClient
int
float
void
string
void
string
void
string
int
int
void
MediaAction
void
SceneInfo
void
float
Sansar.Script.ScriptBase.WaitFor
Sansar.Script.ScriptBase.WaitFor
Sansar.Script.ScriptBase.WaitFor
void
AgentPrivate
bool
string
User
void
AgentPrivate
void
AgentPrivate
void