Component:CharacterParenter: Difference between revisions

Revision as of 15:55, 16 October 2024

Component image

**Character Parenter** component as seen in the Scene Inspector

Character Parenters are a component that allow for parenting or aligning the gravity of a user when they hit a collider.

Usage

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.
`TriggersOnly`	Bool	Whether to only allow trigger colliders that are part of this component's slot hierarchy to activate parenting.
`NestIntoSpace`	Bool	Parent the user into the slot `ParentSpace` or not.
`MustBeOnGround`	Bool	The user must be on the ground according to the character controller before they will be aligned/parented.
`Filters`	list of AlignmentFilter	What directions a user must be aligned to relative to the slot this component is on for them to get parented.
`IgnoreParentUser`	Bool	Ignore the active user of this component when attempting to parent a user.
`ParentSpace`	direct RootSpace	The space that users should get parented to when using `NestIntoSpace`.

Behavior

Examples

This component is used in many different zones where keeping a user moving with something is essential. Objects like this include: platforms, elevators, mech control rooms, parkour platforms, spaceships, and the list can go on.

@@ Line 3: / Line 3: @@
 |Name=Character Parenter
 }}
-{{stub}}
+Character Parenters are a component that allow for parenting or aligning the gravity of a user when they hit a collider.
 == Usage ==
 {{Table ComponentFields
-|TriggersOnly|Bool|
+|TriggersOnly|Bool| Whether to only allow trigger colliders that are part of this component's slot hierarchy to activate parenting.
-|NestIntoSpace|Bool|
+|NestIntoSpace|Bool| Parent the user into the slot <code>ParentSpace</code> or not.
-|MustBeOnGround|Bool|
+|MustBeOnGround|Bool| The user must be on the ground according to the [[Component:CharacterController|character controller]] before they will be aligned/parented.
-|Filters|{{RootFieldType|SyncList`1|[[#AlignmentFilter|AlignmentFilter]]}}|TypeAdv3=true|
+|Filters|{{RootFieldType|SyncList`1|[[#AlignmentFilter|AlignmentFilter]]}}|TypeAdv3=true| What directions a user must be aligned to relative to the slot this component is on for them to get parented.
-|IgnoreParentUser|Bool|
+|IgnoreParentUser|Bool| Ignore the active user of this component when attempting to parent a user.
-|ParentSpace|{{RootFieldType|RootSpace}}|TypeAdv5=true|
+|ParentSpace|{{RootFieldType|RootSpace}}|TypeAdv5=true| The space that users should get parented to when using <code>NestIntoSpace</code>.
 }}
@@ Line 18: / Line 18: @@
 == Examples ==
+This component is used in many different zones where keeping a user moving with something is essential. Objects like this include: platforms, elevators, mech control rooms, parkour platforms, spaceships, and the list can go on.
 == See Also ==
+[https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/353 Issue 353, bumpiness issues when on another user]
 [[Category:Components:Locomotion:Interaction{{#translation:}}|Character Parenter]]
 [[Category:Components{{#translation:}}|Character Parenter]]
 [[Category:Components With Nested Types{{#translation:}}|Character Parenter]]
-[[Category:ComponentStubs]]