Component:CharacterController: Difference between revisions

Revision as of 01:39, 15 January 2024

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

Component image

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

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.
`SimulatingUser`	User	The user who is currently simulating and networking this Character Controller.
`CharacterRoot`	Slot	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`HeadReference`	Slot	What the Simulation uses for the capsule height (TODO: is this correct?)
`RootAtBottom`	Bool	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`MassScaling`	ScalingMode	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`ForceScaling`	ScalingMode	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`SpeedScaling`	ScalingMode	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`JumpScaling`	ScalingMode	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`GravityScaling`	ScalingMode	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`Mass`	Float	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`Damping`	Float	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`Height`	Float	Height of the driven CapsuleCollider (Component)
`Radius`	Float	Radius of the driven CapsuleCollider (Component)
`Margin`	Float	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`Speed`	Float	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`SlidingSpeed`	Float	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`AirSpeed`	Float	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`TractionForce`	Float	How much force is needed to overcome standing friction.
`SlidingForce`	Float	How much friction force is applied while the CharacterController is moving.
`AirForce`	Float	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`MaximumGlueForce`	Float	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`MaximumTractionSlope`	Float	Maximum Traction value before user slides down a slope. This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`MaximumSupportSlope`	Float	Maximum Support value before user slides down a slope. This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`JumpSpeed`	Float	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`SlidingJumpSpeed`	Float	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`Gravity`	Float3	Force of Gravity for this character controller
`LocalSpace`	Slot	This determines if gravity is a local or global direction. Turning this off makes you fall down relative to the Root rather than what you're parented under.
`UseParentSpace`	Bool	This determines if gravity is a local or the slot above what you're parented under.
`OverrideRootSpace`	RootSpace	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`CollideWithOtherCharacters`	Bool	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`IgnoreRaycasts`	Bool	This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Usage

This component is usually used internally by Resonite to simulate user movement physics like walking and climbing.

But the node can also be manipulated to create "Fake Players" commonly known by Resonite users as "NPC's". Before doing this, know that the physics simulation is always inconsistent when viewed by different players in the same session. It also causes high amounts of networking and FPS lag. Use too many and you may start rising in Queued Packets. The character controller can also be used as a ball, but for things that fly or bounce, using a Trajectory ProtoFlux node is vastly superior.

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

Examples

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

@@ Line 9: / Line 9: @@
 == Fields ==
 {{Table ComponentFields
-|SimulatingUser|User| {{stub}}
+|SimulatingUser|User| The user who is currently simulating and networking this Character Controller.
 |CharacterRoot|Slot| {{stub}}
-|HeadReference|Slot| {{stub}}
+|HeadReference|Slot| What the Simulation uses for the capsule height (TODO: is this correct?)
 |RootAtBottom|Bool| {{stub}}
 |MassScaling|ScalingMode| {{stub}}
@@ Line 20: / Line 20: @@
 |Mass|Float| {{stub}}
 |Damping|Float| {{stub}}
-|Height|Float| {{stub}}
+|Height|Float| Height of the driven [[CapsuleCollider (Component)]]
-|Radius|Float| {{stub}}
+|Radius|Float| Radius of the driven [[CapsuleCollider (Component)]]
 |Margin|Float| {{stub}}
 |Speed|Float| {{stub}}
 |SlidingSpeed|Float| {{stub}}
 |AirSpeed|Float| {{stub}}
-|TractionForce|Float| {{stub}}
+|TractionForce|Float| How much force is needed to overcome standing friction.
-|SlidingForce|Float| {{stub}}
+|SlidingForce|Float| How much friction force is applied while the CharacterController is moving.
 |AirForce|Float| {{stub}}
 |MaximumGlueForce|Float| {{stub}}
-|MaximumTractionSlope|Float| {{stub}}
+|MaximumTractionSlope|Float| Maximum Traction value before user slides down a slope. {{Stub}}
-|MaximumSupportSlope|Float| {{stub}}
+|MaximumSupportSlope|Float| Maximum Support value before user slides down a slope. {{Stub}}
 |JumpSpeed|Float| {{stub}}
 |SlidingJumpSpeed|Float| {{stub}}
-|Gravity|Float3| {{stub}}
+|Gravity|Float3| Force of Gravity for this character controller
-|LocalSpace|Slot|
+|LocalSpace|Slot| This determines if gravity is a local or global direction. Turning this off makes you fall down relative to the [[Root]] rather than what you're parented under.
-|UseParentSpace|Bool| {{stub}}
+|UseParentSpace|Bool| This determines if gravity is a local or the slot above what you're parented under.
 |OverrideRootSpace|RootSpace| {{stub}}
 |CollideWithOtherCharacters|Bool| {{stub}}
@@ Line 44: / Line 44: @@
 <!--T:3-->
 == Usage ==
+This component is usually used internally by Resonite to simulate user movement physics like walking and climbing.
+But the node can also be manipulated to create "Fake Players" commonly known by Resonite users as "NPC's". Before doing this, know that the physics simulation is always inconsistent when viewed by different players in the same session. It also causes high amounts of networking and FPS lag. Use too many and you may start rising in [[Queued Packets]]. The character controller can also be used as a ball, but for things that fly or bounce, using a [[Trajectory (ProtoFlux)| Trajectory]] ProtoFlux node is vastly superior.
 {{stub}}