LockRootOrientationEventData

Inheritance 1 ancestor · 15 siblings

BaseEventData

Class Documentation

An animation event that keeps a joint pointing the same way in the world while the unit turns. When the event starts, the client records the rotation of the unit. On every frame after that, it turns the joint JointName back by the amount the unit has turned since then. The joint and everything below it keep the world orientation they had at the start of the event.

A typical use is an animation whose body must stay in place while the game turns the unit, with JointName set to the root joint.

When the event ends, the correction fades out over BlendOutTime and the joint turns to follow the unit again.

Notes

The client needs no setup on the skin for this event. It adds the pose modifier that does the lock, a LockRootOrientationRigPoseModifierData, when a clip of the graph has an event of this kind.
JointName can be any joint. The joint is turned back in the frame of its parent, so the world orientation is kept exactly only when no joint above it is turned, which is the case for the root joint. On a joint such as hip_JNT it is kept while the joints above turn only around the vertical axis.
The recorded rotation is the full rotation of the unit, and the whole difference is turned back, not only the turn around the vertical axis.
The track of the clip does not matter, additive tracks included. The lock is applied after all tracks are combined, and the track's weight does not scale it.
Events under the same key of mEventDataMap share one lock, which ends when the last of them has ended. Events under different keys on the same joint each turn it back, so the correction is applied twice.

Properties

BlendOutTime

F32 = 0.20000000298023224

Documentation Edit documentation

The time over which the joint goes back to following the unit after the event has ended, in seconds of real time. The fade is linear. 0 lets the joint go back in one frame.

JointName

Hash = "0x0"

Documentation Edit documentation

The joint to hold, as the hash of its name (FNV-1a 32 of the lowercased name).