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
  • Animation Class
  • Syntax
  • Member Details
  • AnimationComponent Class
  • Syntax
  • Member Details
  • AnimationComponent.SubscriptionHandler Delegate
  • Syntax
  • Remarks
  • Requirements
  • AnimationData Class
  • Syntax
  • Member Details
  • AnimationParameters Struct
  • Syntax
  • Member Details
  • AnimationPlaybackMode Enum
  • Syntax
  • Remarks
  • Members
  • Requirements
  1. Script API Docs
  2. Sansar Simulation Namespace

Animation

Animation, component, subscription handler, data, parameters, and playback mode docs.

PreviousAgent InfoNextAudio Component

Last updated 6 months ago

Animation Class

Represents a scriptable Animation node.

Syntax

Member Details

GetFrameCount Method

Gets the frame count of the animation

Syntax

[Sansar.Script.Interface] public GetFrameCount ()

Returns

Returns the total number of frames in the animation.

Remarks

Requirements

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

GetName Method

Gets the name of the animation

Syntax

Returns

Returns the name of the animation.

Remarks

Requirements

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

GetParameters Method

Gets the last applied parameters for the animation

Syntax

Returns

Returns the current parameters.

Remarks

Requirements

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

IsPaused Method

Gets whether or not the animation is paused.

Syntax

Returns

A bool value indicating the pause state.

Remarks

Requirements

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

JumpToFrame Method

Jump to frame. The animation will be set to the specified frame, and paused.

Syntax

Parameters

frame

Frame to jump to.

Returns

Returns an internal event id.

Remarks

Requirements

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

JumpToFrame Method

Jump to frame. The animation will be set to the specified frame, and paused.

Syntax

Parameters

frame

Frame to jump to.

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

JumpToFrame Method

Jump to frame. The animation will be set to the specified frame, and paused.

Syntax

Parameters

frame

Frame to jump to.

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

Pause Method

Pauses the animation.

Syntax

Returns

Returns an internal event id.

Remarks

Requirements

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

Pause Method

Pauses the animation.

Syntax

Parameters

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

Pause Method

Pauses the animation.

Syntax

Parameters

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

Play Method

Plays the animation. It will become the active animation for this object, and resume playing if it is paused.

Syntax

Returns

Returns an internal event id.

Remarks

Requirements

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

Play Method

Plays the animation, without changing the current animation frame.

Syntax

Parameters

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

Play Method

Plays the animation and applies the provided parameters.

Syntax

Parameters

parameters

Animation parameters to apply.

Returns

Returns an internal event id.

Remarks

Requirements

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

Play Method

Plays the animation. It will become the active animation for this object, and resume playing if it is paused.

Syntax

Parameters

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

Play Method

Plays the animation and applies the provided parameters.

Syntax

Parameters

parameters

Animation parameters to apply.

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

Play Method

Plays the animation and applies the provided parameters.

Syntax

Parameters

parameters

Animation parameters to apply.

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

Reset Method

Resets the animation. The animation is paused and reset to frame 0 (or the RangeStartFrame if clamping is enabled).

Syntax

Returns

Returns an internal event id.

Remarks

Requirements

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

Reset Method

Resets the animation. The animation is paused and reset to frame 0 (or the RangeStartFrame if clamping is enabled).

Syntax

Parameters

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

Reset Method

Resets the animation and applies the provided parameters.

Syntax

Parameters

parameters

Animation parameters to apply.

Returns

Returns an internal event id.

Remarks

Requirements

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

Reset Method

Resets the animation. The animation is paused and reset to frame 0 (or the RangeStartFrame if clamping is enabled).

Syntax

Parameters

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

Reset Method

Resets the animation and applies the provided parameters.

Syntax

Parameters

parameters

Animation parameters to apply.

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

Reset Method

Resets the animation and applies the provided parameters.

Syntax

Parameters

parameters

Animation parameters to apply.

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

SetParameters Method

Sets the parameters for the animation. The parameters are applied immediately.

Syntax

Parameters

parameters

Animation parameters to apply.

Returns

Returns an internal event id.

Remarks

Requirements

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

SetParameters Method

Sets the parameters for the animation. The parameters are applied immediately.

Syntax

Parameters

parameters

Animation parameters to apply.

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

SetParameters Method

Sets the parameters for the animation. The parameters are applied immediately.

Syntax

Parameters

parameters

Animation parameters to apply.

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

AnimationComponent Class

The AnimationComponent handles interactions with animations.

Syntax

Member Details

ComponentId Property

Retrieves the component id for this AnimationComponent.

Syntax

Value

The id.

Remarks

Requirements

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

ComponentType Field

Syntax

Remarks

Requirements

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

DefaultAnimation Property

Gets the default scriptable animation.

Syntax

Value

An Animation object.

Remarks

Requirements

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

EnqueueEvent Method

Enqueues an event for this component.

Syntax

Parameters

internalId

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

EnqueueEvent Method

Enqueues an event for this component.

Syntax

Parameters

internalId

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

EnqueueEvent Method

Enqueues an event for this component.

Syntax

Parameters

internalId

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

GetAnimation Method

Finds a scriptable animations by name.

Syntax

Parameters

animationName

The name of the animation.

Returns

An Animation, or null if no animation was found with the correct name.

Remarks

Requirements

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

GetAnimations Method

Gets the scriptable animations for this object.

Syntax

Returns

An IEnumarable collection of animation objects.

Remarks

Requirements

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

GetEventId Method

Lookup the event id for the named event.

Syntax

Parameters

eventName

The name of the event to query.

Returns

The id of the named event or -1 if the name is not valid.

Remarks

Requirements

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

GetVectorAnimationVariable Method

Get a Vector type variable from the animation by name

Syntax

Parameters

variableName

The name of the animation variable

Returns

A Mono.Simd.Vector4f of the value of the named variable

Exceptions

Type
Reason

Thrown when attempting to get a variable that doesn't exist or is of the wrong type

If variableName is null

Remarks

Requirements

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

HasEvent Method

Check this component for the existence of the named event.

Syntax

Parameters

eventName

The name of the event to query.

Returns

true if the event exits.

Remarks

Requirements

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

Name Property

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

SetPosition Method

Asynchronously set the position for this object.

Syntax

Parameters

position

The Mono.Simd.Vector4f position desired.

Returns

Returns an internal event id.

Remarks

Requirements

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

SetPosition Method

Asynchronously set the position for this object.

Syntax

Parameters

position

The Mono.Simd.Vector4f position desired.

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

SetPosition Method

Asynchronously set the position for this object.

Syntax

Parameters

position

The Mono.Simd.Vector4f position desired.

handler

Handler to be called when the event completes.

Returns

Returns an internal event id.

Remarks

Requirements

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

Subscribe Method

Subscribes to Animation Events.

Syntax

Parameters

BehaviorName

The behavior name of the Animation. This name will match the subscribed event.

callback

Callback which is executed when the event completes.

persistent

Optional, set to false to unsubscribe after one event.

Remarks

Requirements

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

Subscribe Method

Subscribes to Animation Events.

Syntax

See Also

Parameters

BehaviorName

The behavior name of the Animation. This name will match the subscribed event.

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

AnimationComponent.SubscriptionHandler Delegate

Animation events.

Syntax

Parameters

BehaviorName

The behavior name of the Animation. This name will match the subscribed event.

ComponentId

The id of the animation component.

Remarks

Requirements

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

AnimationData Class

Animation events.

Syntax

Member Details

BehaviorName Property

The behavior name of the Animation. This name will match the subscribed event.

Syntax

Value

Remarks

Requirements

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

ComponentId Property

The id of the animation component.

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

AnimationParameters Struct

The AnimationParameters struct contains settings for playing animations.

Syntax

[Sansar.Script.Interface] public struct AnimationParameters

Member Details

BlendDuration Field

Time in seconds taken to blend to this animation.

Syntax

Remarks

Requirements

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

ClampToRange Field

If true, clamp the animation frames to the range specified by rangeStartFrame and rangeLength. If false, play the whole animation.

Syntax

Remarks

Requirements

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

PlaybackMode Field

Animation playback mode.

Syntax

Remarks

Requirements

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

PlaybackSpeed Field

Animation playback speed. Negative values will play the animation backwards.

Syntax

Remarks

Requirements

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

RangeEndFrame Field

End frame to use when clamping animation range. This should always be greater or equal to the range start frame.

Syntax

Remarks

Requirements

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

RangeStartFrame Field

Start frame to use when clamping animation range.

Syntax

Remarks

Requirements

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

AnimationPlaybackMode Enum

Enumeration for the different animation playback modes

Syntax

[Sansar.Script.Interface] public enum AnimationPlaybackMode

Remarks

Members

Member Name
Description

Loop

Loop indefinitely.

PingPong

Play indefinitely, alternating between forwards and backwards.

PlayOnce

Play once then stop.

Requirements

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

[Sansar.Script.Interface] public GetName ()

[Sansar.Script.Interface] public IsPaused ()

[Sansar.Script.Interface] public JumpToFrame ( frame)

[Sansar.Script.Interface] public Pause ()

[Sansar.Script.Interface] public Play ()

[Sansar.Script.Interface] public Reset ()

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

[Sansar.Script.Interface] public EnqueueEvent ( internalId)

The id of the animation event, may be looked up by name from

The id of the animation event, may be looked up by name from

The id of the animation event, may be looked up by name from

[Sansar.Script.Interface] public GetAnimation ( animationName)

[Sansar.Script.Interface] public GetEventId ( eventName)

[Sansar.Script.Interface] public GetVectorAnimationVariable ( variableName)

[Sansar.Script.Interface] public HasEvent ( eventName)

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

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

[Sansar.Script.Interface] [System.Obsolete("Use subscription callbacks of type Action<Sansar.Simulation.AnimationData>", true)] public Subscribe ( BehaviorName, callback, persistent)

An that can be used to cancel the subscription.

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

[Sansar.Script.Interface] [System.Obsolete("Use subscription callbacks of type Action<Sansar.Simulation.AnimationData>", false)] public delegate AnimationComponent.SubscriptionHandler ( BehaviorName, ComponentId)

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

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

[Sansar.Script.Interface] public BlendDuration

[Sansar.Script.Interface] public ClampToRange

[Sansar.Script.Interface] public PlaybackSpeed

[Sansar.Script.Interface] public RangeEndFrame

[Sansar.Script.Interface] public RangeStartFrame

int
string
bool
void
int
void
void
void
Animation
void
int
AnimationComponent.GetEventId(string)
AnimationComponent.GetEventId(string)
AnimationComponent.GetEventId(string)
Animation
string
int
string
Sansar.Vector
string
bool
string
string
void
Sansar.Vector
void
string
AnimationComponent.SubscriptionHandler
bool
Sansar.Script.IEventSubscription
string
void
string
Sansar.Script.ComponentId
string
string
float
bool
float
int
int
ArgumentException
ArgumentNullException