SocketDefinitionBase

Inheritance 2 descendants

• SocketDefinitionBasecurrent
  • SocketDefinitionSingleJoint
  • SocketDefinitionWorld

Class Documentation

Edit documentation

A socket is a named point on a character skin's skeleton that is not a joint. A skin lists its sockets in SkinMeshDataProperties.SocketDefinitions.

When the engine looks up a bone's transform by name, it searches the skeleton's joints first. If no joint has the name, it searches the sockets in list order and uses the first socket whose name matches. A socket with the same name as a joint is never used.

Bone names that use this lookup include MissileMovementSpec.mStartBoneName, SpellDataResource.mHitBoneName, SkinCharacterDataProperties_CharacterIdleEffect.boneName, SeqInputCreateEffectEmitter.AttachTargetBone and the bone that a VFX system is attached to. A JointSnapEventData can also snap a joint to a socket.

The socket's transform is calculated from the skeleton's current pose at each lookup. Each kind of socket calculates it differently:

• SocketDefinitionSingleJoint follows one joint.
• SocketDefinitionWorld is fixed to the character's origin.

The pose a socket reads is the pose after every pose modifier. So a socket on a joint of a dynamics chain follows the simulated joint.

Notes

• Only the socket list of a character skin is read, from SkinCharacterDataProperties.skinMeshProperties. The list on other classes that embed SkinMeshDataProperties is ignored.
• No shipped skin defines sockets.
• Two sockets with the same name: the first in the list is used. The second is never tried, even when the first cannot be resolved.
• A socket cannot be attached to another socket.
• The joint snap is the exception to the pose order: it resolves its socket before the dynamics chains run, and without the position of the unit in the world.
• A socket is not a joint for the systems that take joints by index or only search the skeleton: a dynamics chain, the collision shapes of a dynamics chain and the BoneTransform driver do not find sockets.

Properties

name

String

Documentation Edit documentation

The bone name of the socket. It is compared with the requested name the same way as a joint name, ignoring case.

Referenced by 1 class · 1 property

• SkinMeshDataProperties SocketDefinitions List2<SocketDefinitionBase>

name