Component:BipedRig

From Resonite Wiki
Revision as of 22:28, 10 February 2025 by 989onan (talk | contribs) (add info)


Component image 
Biped Rig component as seen in the Scene Inspector

This component is used by ProtoFlux and other Resonite systems to read the different parts of an anthro/humanoid avatar by Body Node. This is created and assigned to by the Assimp import system that FrooxEngine uses internally, and cannot be edited in game without mods. If this component is deleted, internal code or ProtoFlux might not be able to read what parts of your body are which Body Node designation, and will cause issues in user creations and some FrooxEngine functions. If the Biped Rig is not present or it does not contain the slot for the Body Node, the Body Node search will fallback to looking for AvatarObjectSlot components on the user instead.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
ForwardAxis Nullable`1<Float3> The forward direction the VRIK should use when setting up the VRIK in the game internally. Is not used after the avatar is generated by Assimp. Mostly for debugging.
Bones direct SyncRefDictionary`2<BodyNode, Slot> A list of bones this component has stored and mapped in the form of body nodes to slot assignments.


Special Functions

Lua error in mw.text.lua at line 25: bad argument #1 to 'match' (string expected, got nil).
Triggers
Method Name Method type and Arguments. Is the method hidden? Description

Usage

This component can be used to try to fix malformed or misdetected hands by using it's special functions. It can also be used to check which parts of an avatar are recognised as which Body Nodes for debugging and bug reports.

Examples

Related Issues

See Also