Interface PBAvatarMovementInfo

Hierarchy

  • PBAvatarMovementInfo

Properties

activeAnimationState?: AvatarAnimationState

current state of a scene-driven movement animation. Absent when the engine is using its velocity-based fallback. playback_time freezes while a triggerSceneEmote is overriding the animation.

activeAvatarLocomotionSettings: undefined | PBAvatarLocomotionSettings
activeInputModifier: undefined | PBInputModifier
actualVelocity: undefined | PBVector3

the resulting velocity taking collisions into account

externalVelocity: undefined | PBVector3

the velocity imparted by movement of the "ground" platform or pushing from other moving colliders

previousStepTime: number

the length of time the previous step velocity applied for

requestedVelocity: undefined | PBVector3

the velocity requested for the previous frame

stepTime: number

the length of time the current step velocity will apply for

walkTarget?: PBVector3

if set, the movement scene should walk the player to this scene-relative position

walkThreshold?: number

stop distance for walk_target; considered reached when within this distance