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
  • MoveMode Enum
  • Syntax
  • Remarks
  • Members
  • Requirements
  • Mover Class
  • Syntax
  • Member Details
  1. Script API Docs
  2. Sansar Simulation Namespace

Move Mode and Mover

MoveMode Enum

Type of interpolation to use for movement

Syntax

[Sansar.Script.Interface] public enum MoveMode

Remarks

Movement is computed according to the movement type with a parametric parameter 't' that varies from zero to one.

  • Linear movement is directly proportional to 't'.

  • Ease-in movement is proportional to 't^2'.

  • Ease-out movement is computed with 't*(2-t)'.

  • Smoothstep interpolation uses '(3-2t)*t^2'.

Members

Member Name
Description

EaseIn

Ease In. The object with move slowly at first and quickly at the end.

EaseOut

Ease Out. The object with move quickly at first and slow down at the end.

Linear

Linear Interpolation. The object will move at a constant velocity.

Smoothstep

Smoothstep Interpolation. The object with speed up and slow down smoothly when moving.

Requirements

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

Mover Class

The Mover handles adding moves to process for an object.

Syntax

Member Details

AddMove Method

Sets the transform of this Mover to a target World Space position and rotation.

Syntax

Parameters

position

The target position.

rotation

The target rotation.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddMove Method

Sets the transform of this Mover to a target World Space position and rotation.

Syntax

Parameters

position

The target position.

rotation

The target rotation.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddMove Method

Translate and rotate the Mover to the target World Space position and rotation over time.

Syntax

Parameters

targetPosition

The target position.

targetRotation

The target rotation.

timeInSeconds

The time in seconds to move over.

interpolationMode

The method of interpolation to use when moving

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddMove Method

Translate and rotate the Mover to the target World Space position and rotation over time.

Syntax

Parameters

targetPosition

The target position.

targetRotation

The target rotation.

timeInSeconds

The time in seconds to move over.

interpolationMode

The method of interpolation to use when moving

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddMoveOffset Method

Sets the transform of this Mover to a target Local Space position and rotation.

Syntax

Parameters

positionOffset

The local space position offset.

rotationOffset

The local space rotation offset.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddMoveOffset Method

Sets the transform of this Mover to a target Local Space position and rotation.

Syntax

Parameters

positionOffset

The local space position offset.

rotationOffset

The local space rotation offset.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddMoveOffset Method

Translate and rotate the Mover to the target Local Space position and rotation over time.

Syntax

Parameters

positionOffset

The local space position offset.

rotationOffset

The local space rotation offset.

timeInSeconds

The time in seconds to move over.

interpolationMode

The method of interpolation to use when moving

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddMoveOffset Method

Translate and rotate the Mover to the target Local Space position and rotation over time.

Syntax

Parameters

positionOffset

The local space position offset.

rotationOffset

The local space rotation offset.

timeInSeconds

The time in seconds to move over.

interpolationMode

The method of interpolation to use when moving

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddPause Method

Adds a pause of the given length for this Mover.

Syntax

Parameters

timeInSeconds

The amount of time in seconds that the movement should be paused.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddPause Method

Adds a pause of the given length for this Mover.

Syntax

Parameters

timeInSeconds

The amount of time in seconds that the movement should be paused.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddRotate Method

Sets the rotation of this Mover to a target World Space rotation.

Syntax

Parameters

rotation

The target rotation.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddRotate Method

Sets the rotation of this Mover to a target World Space rotation.

Syntax

Parameters

rotation

The target rotation.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddRotate Method

Rotate the Mover to the target World Space rotation over time.

Syntax

Parameters

targetRotation

The target rotation.

timeInSeconds

The time in seconds to move over.

interpolationMode

The method of interpolation to use when moving

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddRotate Method

Rotate the Mover to the target World Space rotation over time.

Syntax

Parameters

targetRotation

The target rotation.

timeInSeconds

The time in seconds to move over.

interpolationMode

The method of interpolation to use when moving

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddRotateOffset Method

Sets the rotation of this Mover to a target Local Space rotation.

Syntax

Parameters

rotationOffset

The local space rotation offset.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddRotateOffset Method

Sets the rotation of this Mover to a target Local Space rotation.

Syntax

Parameters

rotationOffset

The local space rotation offset.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddRotateOffset Method

Rotate the Mover to the target Local Space rotation over time.

Syntax

Parameters

rotationOffset

The local space rotation offset.

timeInSeconds

The time in seconds to move over.

interpolationMode

The method of interpolation to use when moving

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddRotateOffset Method

Rotate the Mover to the target Local Space rotation over time.

Syntax

Parameters

rotationOffset

The local space rotation offset.

timeInSeconds

The time in seconds to move over.

interpolationMode

The method of interpolation to use when moving

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddTranslate Method

Sets the position of this Mover to a target World Space position.

Syntax

Parameters

position

The target position.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddTranslate Method

Sets the position of this Mover to a target World Space position.

Syntax

Parameters

position

The target position.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddTranslate Method

Translate the Mover to the target World Space position over time.

Syntax

Parameters

targetPosition

The target position.

timeInSeconds

The time in seconds to move over.

interpolationMode

The method of interpolation to use when moving.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddTranslate Method

Translate the Mover to the target World Space position over time.

Syntax

Parameters

targetPosition

The target position.

timeInSeconds

The time in seconds to move over.

interpolationMode

The method of interpolation to use when moving.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddTranslateOffset Method

Sets the position of this Mover to a target Local Space position.

Syntax

Parameters

positionOffset

The local space position offset.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddTranslateOffset Method

Sets the position of this Mover to a target Local Space position.

Syntax

Parameters

positionOffset

The local space position offset.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddTranslateOffset Method

Translate the Mover to the target Local Space position over time.

Syntax

Parameters

positionOffset

The local space position offset.

timeInSeconds

The time in seconds to move over.

interpolationMode

The method of interpolation to use when moving.

Returns

The return value is an internal event id.

Remarks

Requirements

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

AddTranslateOffset Method

Translate the Mover to the target Local Space position over time.

Syntax

Parameters

positionOffset

The local space position offset.

timeInSeconds

The time in seconds to move over.

interpolationMode

The method of interpolation to use when moving.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

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

IsMoving Property

Property to check if a move command is currently executing for this Mover.

Syntax

Value

Whether or not this object is currently executing a move (includes pauses).

Remarks

Requirements

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

MoveCount Property

The number of move commands waiting to be excuted and currently executing for this Mover.

Syntax

Value

The number of enqueued move commands. Includes the current active move and any pause commands.

Remarks

Requirements

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

StopAndClear Method

Stops the current movement and clears any further movements for this Mover.

Syntax

Returns

The return value is an internal event id.

Remarks

Requirements

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

StopAndClear Method

Stops the current movement and clears any further movements for this Mover.

Syntax

Parameters

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

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

PreviousModal DialogueNextObjective

Last updated 6 months ago

[Sansar.Script.Interface] public AddPause ( timeInSeconds)

[Sansar.Script.Interface] public AddRotateOffset ( rotationOffset)

[Sansar.Script.Interface] public AddTranslate ( position)

[Sansar.Script.Interface] public AddTranslate ( targetPosition, timeInSeconds, interpolationMode)

[Sansar.Script.Interface] public AddTranslateOffset ( positionOffset)

[Sansar.Script.Interface] public AddTranslateOffset ( positionOffset, timeInSeconds, interpolationMode)

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

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

[Sansar.Script.Interface] public StopAndClear ()

This method is not enqueued like other operations on the Mover. To block until the operation has executed, pass this method to while in a coroutine.

This method is not enqueued like other operations on the Mover. To block until the operation has executed, pass this method to while in a coroutine.

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

void
double
void
Sansar.Quaternion
void
Sansar.Vector
void
Sansar.Vector
double
MoveMode
void
Sansar.Vector
void
Sansar.Vector
double
MoveMode
bool
int
void
Sansar.Script.ScriptBase.WaitFor
Sansar.Script.ScriptBase.WaitFor
string