Component:AvatarSlotEquippedToggle: Difference between revisions

Latest revision as of 19:33, 10 November 2024

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Component image

The AvatarSlotEquippedToggle component drives one or two booleans to a state depending on if an Component:AvatarObjectSlot is equipped or not.

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.
`ObjectSlot`	direct RelayRef`1<AvatarObjectSlot>	The Avatar Object Slot to monitor for equipping status.
`EquippedDrive`	field drive of Bool	Drives the target bool to true when `ObjectSlot` is equipped. Otherwise false.
`DequippedDrive`	field drive of Bool	Drives the target bool to false when `ObjectSlot` is equipped. Otherwise true.

@@ Line 7: / Line 7: @@
 |Name=AvatarSlotEquippedToggle
 }}
+The '''AvatarSlotEquippedToggle''' component drives one or two booleans to a state depending on if an [[Component:AvatarObjectSlot]] is equipped or not.
-<!--T:2-->
-== Intoduction ==
 <!--T:3-->
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|ObjectSlot|{{RootFieldType|RelayRef`1|[[Component:AvatarObjectSlot|AvatarObjectSlot]]}}|TypeAdv0=true|
+|ObjectSlot|{{RootFieldType|RelayRef`1|[[Component:AvatarObjectSlot|AvatarObjectSlot]]}}|TypeAdv0=true| The Avatar Object Slot to monitor for equipping status.
-|EquippedDrive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv1=true|
+|EquippedDrive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv1=true| Drives the target bool to true when <code>ObjectSlot</code> is equipped. Otherwise false.
-|DequippedDrive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv2=true|
+|DequippedDrive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv2=true| Drives the target bool to false when <code>ObjectSlot</code> is equipped. Otherwise true.
 }}
 <!--T:4-->
-== Behavior ==
+== Usage ==
 <!--T:5-->
@@ Line 26: / Line 24: @@
 <!--T:6-->
-== Related Components ==
+== See Also ==
 </translate>
 [[Category:Components{{#translation:}}|Avatar Slot Equipped Toggle]]
-[[Category:ComponentStubs]]
 [[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar Slot Equipped Toggle]]