s&
About
The Project
info
About s&box
map
Roadmap
monitoring
Metrics
Engine startup and usage numbers
Updates
newspaper
Latest News
published_with_changes
Changes
Release-by-release changelog
Games
Browse Games
Discover Games
gamejams
Workshop
Playable
sports_esports
Games
Standalone games and gamemodes
Assets
landscape
Maps
view_in_ar
Models
texture
Materials
apparel
Clothing
apps
Everything
Every asset type in one list
Forum
Learn
Documentation
rocket_launch
Getting Started
docs
Documentation
api
API Reference
Resources
school
Tutorials
manage_search
Code Search
Get s&box
Sign in with Steam
Api
Classes
Clip
chevron_left
Classes
class
Clip
Properties
data_object
AverageLinearVelocity
data_object
Duration
data_object
FrameCount
data_object
FrameRate
data_object
IsAdditive
data_object
IsBound
data_object
IsError
data_object
IsValid
data_object
Name
data_object
Skeleton
data_object
SkeletonName
data_object
SyncEventCount
data_object
TrackCount
Methods
functions
GetEvents
functions
GetLocalTransform
functions
GetRootMotion
Static Methods
functions
Load
Clip
A compiled animation clip (.anim) - a compressed pose stream authored against a Sandbox.Animation.Clip.Skeleton.
class
Sandbox.Animation
.
account_tree
extends
Resource
sealed
Sandbox.Engine
data_object
Properties
13
AverageLinearVelocity
float
Average speed the root moves at over the clip, in units per second.
Duration
float
Length of the clip in seconds.
FrameCount
int
How many frames of pose data this clip holds.
FrameRate
float
Frames per second. Zero for single frame clips.
IsAdditive
bool
Whether this clip is a difference to be layered onto another pose rather than a pose itself.
IsBound
bool
Whether the clip's skeleton has loaded. Sampling returns identity transforms until it has.
IsError
bool
Whether the clip is invalid, or has not yet loaded.
IsValid
bool
Name
string
Clip resource name.
Skeleton
Skeleton
The skeleton this clip was authored against. Null if it failed to load.
SkeletonName
string
The name of the skeleton this clip was authored against.
SyncEventCount
int
How many sync events the clip is divided into. Sync events let clips of different lengths be blended by phase rather than by time.
TrackCount
int
How many bone tracks the clip encodes.
functions
Methods
3
GetEvents
(
)
IEnumerable`1
Read all game-defined events and their authored timing, without playing the clip. Events are returned in start-time order, with a fresh payload for each enumeration. Native engine events are not included.
GetLocalTransform
(
cycle
,
bone
)
Transform
Sample one bone's transform, relative to its parent bone.
GetRootMotion
(
cycle
)
Transform
Sample the root motion transform, relative to where the clip started.
functions
Static Methods
1
Load
(
filename
)
Clip
Load an animation clip from the given file.
Inheritance
Resource
Clip
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.