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
  • Objective Class
  • Syntax
  • Member Details
  • ObjectiveData Class
  • Syntax
  • Member Details
  • ObjectiveDefinition Class
  • Syntax
  • Member Details
  • ObjectiveState Enum
  • Syntax
  • Remarks
  • Members
  • Requirements
  • ObjectiveDefinition.GetObjectiveData Class
  • Syntax
  • Member Details
  • ObjectPrivate Class
  • Syntax
  • Member Details
  • ObjectPrivate.AddInteractionData Class
  • Syntax
  • Member Details
  • ObjectPublic Class
  • Syntax
  • Member Details
  • ObjectScript Class
  • Syntax
  • Member Details
  1. Script API Docs
  2. Sansar Simulation Namespace

Objective

Objective, Data, Definition, Get Objective Data, State, ObjectPrivate, AddInteractionData, Public, and Script docs.

Objective Class

The Objective is the interface for a user's Quest Objective

Syntax

Member Details

Agent Property

The session Id for the user on this quest.

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


Count Property

Get the number of objectives collected for this user.

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


Definition Property

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


GetState Method

Syntax

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


Ready Property

If the Objective data is ready.

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


SetState Method

Set the state of the objective.

Syntax

Parameters

state

The state to transition to.

Remarks

Requirements

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


SetState Method

Set the state of the objective.

Syntax

Parameters

state

The state to transition to.

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


Subscribe Method

Subscribes to Objective Events.

Syntax

See Also

Parameters

State

The state of the objective

callback

Callback which is executed when the event completes.

persistent

Optional, set to false to unsubscribe after one event.

Returns

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


Update Method

Update the ObjectiveDefinition data.

Syntax

Remarks

Requirements

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


Update Method

Update the ObjectiveDefinition data.

Syntax

Parameters

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



ObjectiveData Class

Handler for Objective state change events.

Syntax

Member Details

AgentId Property

The SessionId of the agent on the quest.

Syntax

Value

Remarks

Requirements

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


State Property

The state of the objective

Syntax

Value

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



ObjectiveDefinition Class

The ObjectiveDefinition stores the data that is used to create quest objective instances for users.

Syntax

Member Details

Description Property

The objective description.

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


GetObjective Method

Get the state of this objective for a particular user.

Syntax

Parameters

agent

Remarks

Requirements

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


GetObjective Method

Get the state of this objective for a particular user.

Syntax

Parameters

agent

Obtain the objective state for this user.

Remarks

Requirements

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


GetObjective Method

Get the state of this objective for a particular user.

Syntax

Parameters

agent

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


GetObjective Method

Get the state of this objective for a particular user.

Syntax

Parameters

agent

Obtain the objective state for this user.

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


InitialState Property

The initial state that this objective will have when a user starts the quest

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


Ready Property

If the QuestDefinition data is ready.

Syntax

See Also

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


RequiredCount Property

The required count to complete the objective.

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


Title Property

The objective title.

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


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


Update Method

Update the ObjectiveDefinition data.

Syntax

Remarks

Requirements

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


Update Method

Update the ObjectiveDefinition data.

Syntax

Parameters

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



ObjectiveState Enum

State of a quest objective for a user.

Syntax

[Sansar.Script.Interface] public enum ObjectiveState

Remarks

Members

Member Name
Description

Active

The objective is currently active and available to complete for this user.

Completed

The objective has been completed for this user.

Locked

The objective is locked for this user and can not be completed.

None

The objective state is not set, probably the user is not on the quest.

Requirements

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


ObjectiveDefinition.GetObjectiveData Class

Syntax

Member Details

Objective Property

Syntax

Value

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



ObjectPrivate Class

Syntax

Member Details

AddInteraction Method

Add an Interaction to the object to make it clickable.

Syntax

Parameters

prompt

The string prompt to show on hover, leave blank to only highlight the object.

enabled

Whether or not the interaction is enabled.

Remarks

Requirements

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


AddInteraction Method

Add an Interaction to the object to make it clickable.

Syntax

Parameters

prompt

The string prompt to show on hover, leave blank to only highlight the object.

enabled

Whether or not the interaction is enabled.

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


FindScripts Generic Method

Looks up scripts on this ObjectPrivate that match the interface type by class name.

Syntax

Type Parameters

TInterface

The interface to find.

Parameters

name

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

Returns

An IEnumerable which contains all scripts of the given type name on this ObjectPrivate that match the given interface.

Remarks

Requirements

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


ForwardVector Property

The forward vector of the ObjectPrivate in the world frame.

Syntax

Value

A normalized vector.

Remarks

Requirements

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


GetComponent Method

Get interfaces to the components that are available at runtime.

Syntax

Parameters

componentType

index

uint32 index

Returns

Remarks

Requirements

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


GetComponentCount Method

Syntax

Parameters

componentType

Returns

Remarks

Requirements

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


InitialPosition Property

The position of the ObjectPrivate in world frame before simulation started.

Syntax

Value

Remarks

Requirements

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


InitialRotation Property

The rotation of the ObjectPrivate in world frame before simulation started.

Syntax

Value

Remarks

Requirements

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


LookupScripts Method

Get handles to the scripts on the ObjectPrivate

Syntax

Returns

object [] of Objects of the scripts on the ObjectPrivate

Remarks

Requirements

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


Name Property

This ObjectPrivate name, as specified in the editor.

Syntax

Value

Remarks

Requirements

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


ObjectId Property

This ObjectPrivate Id. Unique to this Scene.

Syntax

Value

Remarks

Requirements

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


Position Property

The current position of the ObjectPrivate in world frame.

Syntax

Value

Remarks

Requirements

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


RightVector Property

The right vector of the ObjectPrivate in the world frame.

Syntax

Value

A normalized vector.

Remarks

Requirements

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


Rotation Property

The current rotation of the ObjectPrivate in the world frame.

Syntax

Value

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


TryGetComponent Generic Method

Try to get a component of a particular type from this ObjectPrivate

Syntax

Type Parameters

ComponentClass

Parameters

index

The index of this component type to get. zero based index.

component

The component out parameter of the correct type to get.

Returns

True if a component of the correct type at index is found, false otherwise.

Remarks

Requirements

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


TryGetFirstComponent Generic Method

Try to get the first component of a specific type on this ObjectPrivate

Syntax

Type Parameters

ComponentClass

Parameters

component

Out parameter of the correct component type.

Returns

Returns true if able to get a component of the correct type on this ObjectPrivate.

Remarks

Requirements

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


UpVector Property

The up vector of the ObjectPrivate in the world frame.

Syntax

Value

A normalized vector.

Remarks

Requirements

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



ObjectPrivate.AddInteractionData Class

The result of AddInteraction request.

Syntax

Member Details

Interaction Property

The interaction that was added.

Syntax

Value

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



ObjectPublic Class

Syntax

Member Details

ForwardVector Property

The forward vector of the ObjectPublic in the world frame.

Syntax

Value

A normalized vector.

Remarks

Requirements

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


InitialPosition Property

The position of the ObjectPublic in world frame before simulation started.

Syntax

Value

Remarks

Requirements

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


InitialRotation Property

The rotation of the ObjectPublic in world frame before simulation started.

Syntax

Value

Remarks

Requirements

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


Name Property

This ObjectPublic name, as specified in the editor.

Syntax

Value

Remarks

Requirements

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


ObjectId Property

This ObjectPublic Id. Unique to this Scene.

Syntax

Value

Remarks

Requirements

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


Position Property

The current position of the ObjectPublic in world frame.

Syntax

Value

Remarks

Requirements

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


RightVector Property

The right vector of the ObjectPublic in the world frame.

Syntax

Value

A normalized vector.

Remarks

Requirements

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


Rotation Property

The current rotation of the ObjectPublic in the world frame.

Syntax

Value

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


UpVector Property

The up vector of the ObjectPublic in the world frame.

Syntax

Value

A normalized vector.

Remarks

Requirements

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



ObjectScript Class

Extend SceneObjectScript to create a script that can be used on content that is rezzable in a scene.

Syntax

Member Details

ObjectScript Constructor

Syntax

[Sansar.Script.Interface] protected ObjectScript ()

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


ScenePublic Property

Public scene information for the current scene.

Syntax

Value

The Scene this object is in.

Remarks

Requirements

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


PreviousMove Mode and MoverNextPlayHandle

Last updated 6 months ago

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

[Sansar.Script.Interface] public GetState ()

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

An that can be used to cancel the subscription.

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

[Sansar.Script.Interface] public Update ()

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

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

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

The of the user.

[Sansar.Script.Interface] public GetObjective ( agent)

The of the user.

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

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

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

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

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

[Sansar.Script.Interface] public Update ()

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

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

Interface to an object in a in the Scene.

[Sansar.Script.Interface] public AddInteraction ( prompt, enabled)

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

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

[Sansar.Script.Interface] public GetComponent ( componentType, index)

.

[Sansar.Script.Interface] public GetComponentCount ( componentType)

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

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

[Sansar.Script.Interface] public [] LookupScripts ()

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

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

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

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

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

[Sansar.Script.Interface] public TryGetComponent ( index, out ComponentClass component) where ComponentClass : class

The component type.

[Sansar.Script.Interface] public TryGetFirstComponent (out ComponentClass component) where ComponentClass : class

The component type. and

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

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

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

The ObjectPublic class is a more limited subset of the API for use by other scripts in the scene.

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

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

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

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

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

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

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

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

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

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 ScenePublic { protected get; set; }

int
ObjectiveState
bool
Sansar.Script.IEventSubscription
string
void
ObjectiveState
string
string
Sansar.Script.SessionId
void
AgentPrivate
Sansar.Script.SessionId
ObjectiveState
bool
int
string
string
void
Objective
string
Sansar.Simulation.Cluster
void
string
bool
IEnumerable
string
Sansar.Vector
object
ComponentType
uint
Sansar.Simulation.ComponentType
uint
ComponentType
Sansar.Simulation.ComponentType
Sansar.Vector
Sansar.Quaternion
object
string
Sansar.Vector
Sansar.Vector
Sansar.Quaternion
string
bool
uint
Sansar.Simulation.AnimationComponent
Sansar.Simulation.RigidBodyComponent
bool
Sansar.Simulation.AnimationComponent
Sansar.Simulation.RigidBodyComponent
Sansar.Vector
Interaction
string
Sansar.Simulation.ObjectPrivate
Sansar.Vector
Sansar.Vector
Sansar.Quaternion
string
Sansar.Vector
Sansar.Vector
Sansar.Quaternion
string
Sansar.Vector
Sansar.Script.ScriptBase.Init()
ObjectPrivate
ScenePublic