989onan bot (talk | contribs) Automated: update SyncDelegates |
clean and add sync delegate desc |
||
| (One intermediate revision by one other user not shown) | |||
| Line 3: | Line 3: | ||
|Name=Rig | |Name=Rig | ||
}} | }} | ||
The '''Rig''' component is used to inform what bones are "Rig" bones for components like [[Component:DynamicBoneChain|Dynamic Bone Chains]]. | |||
Rig | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Bones|{{RootFieldType|SyncRefList`1|[[Type:Slot|Slot]]}}|TypeAdv0=true| The bones that are a part of the item this component is on. | |Bones|{{RootFieldType|SyncRefList`1|[[Type:Slot|Slot]]}}|TypeAdv0=true| The bones that are a part of the item this component is on. | ||
| Line 13: | Line 12: | ||
== Sync Delegates == | == Sync Delegates == | ||
{{Table ComponentTriggers | {{Table ComponentTriggers | ||
|CleanupBoneColliders[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| | |CleanupBoneColliders:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the cleanup bone colliders button is touched. | ||
|GenerateDebugVisual[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| | |GenerateDebugVisual:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the generate debug visuals button is touched. | ||
|ClearDebugVisual[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| | |ClearDebugVisual:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the clear debug visuals button is touched. | ||
}} | }} | ||
== | == Usage == | ||
== Examples == | == Examples == | ||
Latest revision as of 22:30, 7 April 2025
Component image 
Rig component as seen in the Scene Inspector
The Rig component is used to inform what bones are "Rig" bones for components like Dynamic Bone Chains.
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. |
Bones
|
list of Slot | The bones that are a part of the item this component is on. |
Sync Delegates
| Method Name | Method type and Arguments. | Is the method hidden? | Description |
|---|---|---|---|
CleanupBoneColliders:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the cleanup bone colliders button is touched. |
GenerateDebugVisual:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the generate debug visuals button is touched. |
ClearDebugVisual:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the clear debug visuals button is touched. |