Sansar Docs
Ask or search…
K

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

[get: Sansar.Script.Interface] [set: Sansar.Script.Interface] public int Count { get; set; }
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

[Sansar.Script.Interface] public ObjectiveState GetState ()
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

[get: Sansar.Script.Interface] public bool Ready { get; }
Value
Documentation for this section has not yet been entered.

Remarks

Requirements

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

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
An Sansar.Script.IEventSubscription that can be used to cancel the subscription.

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

Update Method

Update the ObjectiveDefinition data.

Syntax

[Sansar.Script.Interface] public void Update ()

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

[get: Sansar.Script.Interface] public ObjectiveState State { get; }
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

[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


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

[get: Sansar.Script.Interface] public string Description { get; }
Value
Documentation for this section has not yet been entered.

Remarks

Requirements

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

GetObjective Method

Get the state of this objective for a particular user.

Syntax

Parameters
agent
The Sansar.Script.SessionId of the 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

[Sansar.Script.Interface] public void GetObjective (AgentPrivate agent)
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
The Sansar.Script.SessionId of the 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

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

[get: Sansar.Script.Interface] public ObjectiveState InitialState { get; }
Value
Documentation for this section has not yet been entered.

Remarks

Requirements

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

Ready Property

If the QuestDefinition data is ready.

Syntax

[get: Sansar.Script.Interface] public bool Ready { get; }
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

[get: Sansar.Script.Interface] public int RequiredCount { get; }
Value
Documentation for this section has not yet been entered.

Remarks

Requirements

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

Title Property

The objective title.

Syntax

[get: Sansar.Script.Interface] public string Title { get; }
Value
Documentation for this section has not yet been entered.

Remarks

Requirements

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

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

Update Method

Update the ObjectiveDefinition data.

Syntax

[Sansar.Script.Interface] public void Update ()

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

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

[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


ObjectPrivate Class

Interface to an object in a Sansar.Simulation.Cluster in the Scene.

Syntax

Member Details

AddInteraction Method

Add an Interaction to the object to make it clickable.

Syntax

[Sansar.Script.Interface] public void AddInteraction (string prompt, bool enabled)
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

[Sansar.Script.Interface] [Sansar.Script.NonReflective] [System.Runtime.CompilerServices.IteratorStateMachine(typeof(Sansar.Simulation.ObjectPrivate/d__45`1))] public IEnumerable FindScripts (string name) where TInterface : class
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

[get: Sansar.Script.Interface] public Sansar.Vector ForwardVector { get; }
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

[Sansar.Script.Interface] public object GetComponent (ComponentType componentType, uint index)
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

[Sansar.Script.Interface] public uint GetComponentCount (ComponentType componentType)
Parameters
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

[get: Sansar.Script.Interface] public Sansar.Vector InitialPosition { get; }
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

[get: Sansar.Script.Interface] public Sansar.Quaternion InitialRotation { get; }
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

[Sansar.Script.Interface] public object[] LookupScripts ()
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

[get: Sansar.Script.Interface] public string Name { get; }
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

[get: Sansar.Script.Interface] public Sansar.Vector Position { get; }
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

[get: Sansar.Script.Interface] public Sansar.Vector RightVector { get; }
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

[get: Sansar.Script.Interface] public Sansar.Quaternion Rotation { get; }
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

[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

TryGetComponent Generic Method

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

Syntax

[Sansar.Script.Interface] public bool TryGetComponent (uint index, out ComponentClass component) where ComponentClass : class
Type Parameters
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

[Sansar.Script.Interface] public bool TryGetFirstComponent (out ComponentClass component) where ComponentClass : class
Type Parameters
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

[get: Sansar.Script.Interface] public Sansar.Vector UpVector { get; }
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

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

[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


ObjectPublic Class

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

Syntax

Member Details

ForwardVector Property

The forward vector of the ObjectPublic in the world frame.

Syntax

[get: Sansar.Script.Interface] public Sansar.Vector ForwardVector { get; }
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

[get: Sansar.Script.Interface] public Sansar.Vector InitialPosition { get; }
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

[get: Sansar.Script.Interface] public Sansar.Quaternion InitialRotation { get; }
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

[get: Sansar.Script.Interface] public string Name { get; }
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

[get: Sansar.Script.Interface] public Sansar.Vector Position { get; }
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

[get: Sansar.Script.Interface] public Sansar.Vector RightVector { get; }
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

[get: Sansar.Script.Interface] public Sansar.Quaternion Rotation { get; }
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

[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

UpVector Property

The up vector of the ObjectPublic in the world frame.

Syntax

[get: Sansar.Script.Interface] public Sansar.Vector UpVector { get; }
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

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 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

[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

ScenePublic Property

Public scene information for the current scene.

Syntax

[Sansar.Script.NonReflective] [get: Sansar.Script.Interface] public ScenePublic ScenePublic { protected get; set; }
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