The Character Controller component is used for user movement and simulating physics, and has many settings and values that can alter the way on how a user can control either their self or another slot (For example: Vehicles). These Settings allow you to control the mass, speed, force, etc.
{{Note|When getting the character controller of a user, avoid using the character controller under the user root slot. Instead use the node [[ProtoFlux:Find Character Controller From User|Find Character Controller From User]].|suggestion}}
Keep in mind that the character controller under the user root slot is currently useless (as in, not used besides it needing to be there) at this time. And removing it just recreates it back on the user root slot.
For this component, when using some features, you may need to either write/drive the field <code>SimulatingUser</code>. This will activate the character controller on the slot and make it start simulating. Doing this also lets you use some nodes such as [[ProtoFlux:Is Character Controller|Is Character Controller]] and [[ProtoFlux:Is Character On Ground|Is Character On Ground]], and without a simulating user, the values from some nodes would not be updated.
<!--T:2-->
<!--T:2-->
Line 10:
Line 19:
{{Table ComponentFields
{{Table ComponentFields
|SimulatingUser|User| The user who is currently simulating and networking this Character Controller.
|SimulatingUser|User| The user who is currently simulating and networking this Character Controller.
|CharacterRoot|Slot| {{stub}}
|CharacterRoot|Slot| The slot to simulate
|HeadReference|Slot| What the Simulation uses for the capsule height (TODO: is this correct?)
|HeadReference|Slot| What the Simulation uses for the capsule height
|RootAtBottom|Bool| {{stub}}
|SimulateRotation|Bool| Allow the object simulated by this object to rotate, essentially making it a rigid body. See warning.
|MassScaling|ScalingMode| {{stub}}
|MassScaling|PhysicsScalingMode| {{stub}}
|ForceScaling|ScalingMode| {{stub}}
|ForceScaling|PhysicsScalingMode| {{stub}}
|SpeedScaling|ScalingMode| {{stub}}
|SpeedScaling|PhysicsScalingMode| {{stub}}
|JumpScaling|ScalingMode| {{stub}}
|JumpScaling|PhysicsScalingMode| {{stub}}
|GravityScaling|ScalingMode| {{stub}}
|GravityScaling|PhysicsScalingMode| {{stub}}
|Mass|Float| {{stub}}
|LinearDamping|Float| {{stub}}
|Damping|Float| {{stub}}
|AngularDamping|Float|
|Height|Float| Height of the driven [[CapsuleCollider (Component)]]
|Radius|Float| Radius of the driven [[CapsuleCollider (Component)]]
|Margin|Float| {{stub}}
|Margin|Float| {{stub}}
|StepUpHeight|Float|
|StepUpCheckDistance|Float|
|KillVerticalVelocityAfterStepUp|Bool|
|EdgeDetectionDepth|Float|
|Speed|Float| {{stub}}
|Speed|Float| {{stub}}
|SlidingSpeed|Float| {{stub}}
|SlidingSpeed|Float| {{stub}}
Line 35:
Line 46:
|SlidingJumpSpeed|Float| {{stub}}
|SlidingJumpSpeed|Float| {{stub}}
|Gravity|Float3| Force of Gravity for this character controller
|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.
|DebugVisualDuration|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float|Float]]>'''|TypeAdv29=true| Allows for the component to visualize the force vectors acting on the character simulator if set above 0.
|OverrideRootSpace|RootSpace| {{stub}}
|__height|Float| Height of the driven [[CapsuleCollider (Component)]] Currently does nothing.
|CollideWithOtherCharacters|Bool| {{stub}}
|__radius|Float| Radius of the driven [[CapsuleCollider (Component)]] Currently does nothing.
|IgnoreRaycasts|Bool| {{stub}}
|__mass|Float| Mass of the of the driven [[CapsuleCollider (Component)]] Currently does nothing.
|__collideWithOtherCharacters|Bool| Currently does nothing.
|__ignoreRaycasts|Bool| Currently does nothing.
|__rootAtBottom|Bool| Currently does nothing.
}}
}}
Line 46:
Line 60:
This component is usually used internally by Resonite to simulate user movement physics like walking and climbing.
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 Position(ProtoFlux)| Trajectory Position]] ProtoFlux node is vastly superior.
But the component 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 [[ProtoFlux:Trajectory Position| Trajectory Position]] ProtoFlux node is vastly superior.
This component is also used in certain types of vehicles and making them controllable by the user. This is done by having a vehicle you want to make controllable, then making an anchor for the user to sit in, then setting up this component to make that user become the simulating user, thus making their controls change in such a way where they are controlling a vehicle they are sitting on.
{{stub}}
{{stub}}
<!--T:4-->
== Examples ==
A Shrike NPC running around the cloud home:
A Shrike NPC running around the cloud home:
File:Example_Of_A_CharacterController_NPC.webp
<!--T:4-->
[[File:Example_Of_A_CharacterController_NPC.webp|200px|A 4 foot tall Avali NPC with the likeness of a user named Shrike, running in the Resonite Default Cloud Home. It is set to Nighttime and the NPC is near the Reading Nook running towards it.]]
Using [[ProtoFlux:Character Controller User|Character Controller User]] will give you the Simulating User of this Character Controller Component.
Using [[ProtoFlux:Get User From Component|Get User From Component]] will give you the Owner User of this Character Controller Component.
Using [[ProtoFlux:Allocating User|Allocating User]] will give you the User that spawned out a slot that has this Character Controller Component.
Revision as of 21:20, 13 April 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
Description
The Character Controller component is used for user movement and simulating physics, and has many settings and values that can alter the way on how a user can control either their self or another slot (For example: Vehicles). These Settings allow you to control the mass, speed, force, etc.
When getting the character controller of a user, avoid using the character controller under the user root slot. Instead use the node Find Character Controller From User.
Keep in mind that the character controller under the user root slot is currently useless (as in, not used besides it needing to be there) at this time. And removing it just recreates it back on the user root slot.
For this component, when using some features, you may need to either write/drive the field SimulatingUser. This will activate the character controller on the slot and make it start simulating. Doing this also lets you use some nodes such as Is Character Controller and Is Character On Ground, and without a simulating user, the values from some nodes would not be updated.
This component is usually used internally by Resonite to simulate user movement physics like walking and climbing.
But the component 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 Position ProtoFlux node is vastly superior.
This component is also used in certain types of vehicles and making them controllable by the user. This is done by having a vehicle you want to make controllable, then making an anchor for the user to sit in, then setting up this component to make that user become the simulating user, thus making their controls change in such a way where they are controlling a vehicle they are sitting on.
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Examples
A Shrike NPC running around the cloud home:
Protoflux Notes
Using Character Controller User will give you the Simulating User of this Character Controller Component.
Using Get User From Component will give you the Owner User of this Character Controller Component.
Using Allocating User will give you the User that spawned out a slot that has this Character Controller Component.
