s&
About
The Project
infoAbout s&box mapRoadmap monitoringMetricsEngine startup and usage numbers
Updates
newspaperLatest News published_with_changesChangesRelease-by-release changelog
Games
Browse Games Discover Games
gamejams
Workshop
Playable
sports_esportsGamesStandalone games and gamemodes
Assets
landscapeMaps view_in_arModels textureMaterials apparelClothing
appsEverythingEvery asset type in one list
Forum
Learn
Documentation
rocket_launchGetting Started docsDocumentation apiAPI Reference
Resources
schoolTutorials manage_searchCode Search
Get s&box
Sign in with Steam
Api
Classes
Skeleton
chevron_left Classes
class
Skeleton

Properties

data_objectBoneCountdata_objectBonesdata_objectIsErrordata_objectIsPropdata_objectIsValiddata_objectLowLodBoneCountdata_objectMaskCountdata_objectMaskNamesdata_objectNamedata_objectSecondarySkeletons

Static Methods

functionsLoad
Skeleton
A compiled skeleton (.skel) - a bone hierarchy and its reference pose. This is the skeleton animation clips and graphs are authored against, independent of any one model.
class Sandbox.Animation .account_tree extends Resource
sealedSandbox.Engine

data_object Properties 10

BoneCount
int
How many bones this skeleton has.
Bones
IReadOnlyList`1
The bones of this skeleton, in their reference pose. Parents always come before their children, so this can be walked in order.
IsError
bool
Whether the skeleton is invalid, or has not yet loaded.
IsProp
bool
Whether this skeleton belongs to a prop rather than a character.
IsValid
bool
LowLodBoneCount
int
How many bones are sampled at the lowest level of detail. Bones are ordered so these come first, letting distant characters animate only the leading part of the hierarchy.
MaskCount
int
How many bone masks this skeleton defines. Masks weight an animation's influence per bone.
MaskNames
IReadOnlyList`1
The names of this skeleton's bone masks. These are what an animation graph names to weight a pose per bone - a mask authored on a model won't resolve.
Name
string
Skeleton resource name.
SecondarySkeletons
IReadOnlyList`1
Skeletons attached to this one - a held weapon's skeleton, for example. These are resource names, they aren't loaded automatically.

functions Static Methods 1

Load (filename)
Skeleton
Load a skeleton from the given file.

Inheritance

Resource
Skeleton
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.
Facepunch
  • News
  • Docs
  • Metrics
  • FAQ
  • Forum
  • Discord
  • Twitter