s&
newspaper
About
info
About s&box
newspaper
Latest News
published_with_changes
Changes
map
Roadmap
monitoring
Metrics
games
Games
sports_esports
Browse Games
rocket
Discover Games
business_center
Workshop
sports_esports
Games
landscape
Maps
chair
Models
texture
Materials
apparel
Clothing
construction
More..
forum
Forum
docs
Docs
docs
Documentation
dashboard
Api Reference
school
Tutorials
input
Log in with Steam
chevron_left
Change Language
简体中文
English
Русский
Español
Português-Brasil
Deutsch
日本語
Français
Polski
Türkçe
한국어
Pirate
Italiano
ไทย
繁體中文
Українська
Čeština
Nederlands
Magyar
Dansk
Suomi
Svenska
Norsk
Ελληνικά
Română
Български
Tiếng Việt
Bahasa Indonesia
Español-Latinoamérica
العربية
Api
Classes
SceneModel
chevron_left
Classes
class
SceneModel
search
Constructors
functions
SceneModel
Properties
data_object
AnimationGraph
data_object
CurrentSequence
data_object
DirectPlayback
data_object
Morphs
data_object
OnAnimTagEvent
data_object
OnFootstepEvent
data_object
OnGenericEvent
data_object
OnSoundEvent
data_object
PlaybackRate
data_object
RootMotion
data_object
UseAnimGraph
Methods
functions
ClearBoneOverrides
functions
DispatchTagEvents
functions
GetAttachment
functions
GetBoneLocalTransform
functions
GetBoneVelocity
functions
GetBoneWorldTransform
functions
GetBool
functions
GetFloat
functions
GetInt
functions
GetParentSpaceBone
functions
GetRotation
functions
GetVector3
functions
HasBoneOverrides
functions
MergeBones
functions
ResetAnimParameters
functions
RunPendingEvents
remove_circle
SetAnimGraph
functions
SetAnimParameter
functions
SetBodyGroup
functions
SetBoneOverride
functions
SetBoneWorldTransform
functions
SetMaterialGroup
functions
Update
functions
UpdateToBindPose
SceneModel
A model scene object that supports animations and can be rendered within a Sandbox.SceneWorld.
class
Sandbox
.
account_tree
extends
SceneObject
sealed
Sandbox.Engine
build
Constructors
1
SceneModel
(
sceneWorld
,
model
,
transform
)
data_object
Properties
11
AnimationGraph
AnimationGraph
CurrentSequence
AnimationSequence
Allows playback of sequences directly, rather than using an animation graph. Requires Sandbox.SceneModel.UseAnimGraph disabled if the scene model has one.
DirectPlayback
AnimGraphDirectPlayback
Access this sceneobject's direct playback. Direct playback is used to control the direct playback node in an animgraph to play sequences directly in code
Morphs
MorphCollection
Access this sceneobject's morph collection. Morphs are generally used in the model to control the face, for things like emotions and lip sync.
OnAnimTagEvent
Action`1
Called when a anim tag event happens
OnFootstepEvent
Action`1
Called when a footstep event happens
OnGenericEvent
Action`1
Called when a generic event happens
OnSoundEvent
Action`1
Called when a sound event happens
PlaybackRate
float
RootMotion
Transform
Get the calculated motion from animgraph since last frame
UseAnimGraph
bool
Allows the scene model to not use the anim graph so it can play sequences directly
functions
Methods
24
ClearBoneOverrides
(
)
Clears all bone transform overrides.
DispatchTagEvents
(
)
GetAttachment
(
name
,
worldspace
)
Nullable`1
Get attachment transform by name.
GetBoneLocalTransform
(
boneIndex
)
Transform
Returns the local space transform of a bone by its index.
GetBoneVelocity
(
boneIndex
,
linear
,
angular
)
Calculates the velocity from the previous and current bone transforms.
GetBoneWorldTransform
(
boneIndex
)
Transform
Returns the world space transform of a bone by its index.
GetBool
(
name
)
bool
Get an animated parameter
GetFloat
(
name
)
float
Get an animated parameter
GetInt
(
name
)
int
Get an animated parameter
GetParentSpaceBone
(
i
)
Transform
Returns the parent space transform of a bone by its index.
GetRotation
(
name
)
Rotation
Get an animated parameter
GetVector3
(
name
)
Vector3
Get an animated parameter
HasBoneOverrides
(
)
bool
Whether any bone transforms have been overridden.
MergeBones
(
parent
)
Update our bones to match the target's bones. This is a manual bone merge.
ResetAnimParameters
(
)
Reset all animgraph parameters to their default values.
RunPendingEvents
(
)
SetAnimGraph
(
name
)
obsolete
Override the anim graph this scene model uses
SetAnimParameter
(
name
,
value
)
Sets a boolean animation graph parameter by name.
SetBodyGroup
(
name
,
value
)
Set which body group to use.
SetBoneOverride
(
boneIndex
,
transform
)
Manually override the final bone transform.
SetBoneWorldTransform
(
boneIndex
,
transform
)
Sets the world space bone transform of a bone by its index.
SetMaterialGroup
(
name
)
Set material group to replace materials of the model as set up in ModelDoc.
Update
(
delta
)
Update this animation. Delta is the time you want to advance, usually RealTime.Delta
UpdateToBindPose
(
)
Update all of the bones to the bind pose
Inheritance
SceneObject
SceneModel
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.