Component:CharacterController: Difference between revisions

From Resonite Wiki
← Older editNewer edit →
VisualWikitext
m ProbablePrime moved page CharacterController (Component) to Component:CharacterController: Creating component Namespace
Automated: update Fields, Categories
Line 12: Line 12:
|CharacterRoot|Slot| {{stub}}
|CharacterRoot|Slot| {{stub}}
|HeadReference|Slot| What the Simulation uses for the capsule height (TODO: is this correct?)
|HeadReference|Slot| What the Simulation uses for the capsule height (TODO: is this correct?)
|RootAtBottom|Bool| {{stub}}
|SimulateRotation|Bool|
|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 37:
|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.
|GravitySpace|{{RootFieldType|RootSpace}}|TypeAdv28=true|
|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|
|OverrideRootSpace|RootSpace| {{stub}}
|__height|Float| Height of the driven [[CapsuleCollider (Component)]]
|CollideWithOtherCharacters|Bool| {{stub}}
|__radius|Float| Radius of the driven [[CapsuleCollider (Component)]]
|IgnoreRaycasts|Bool| {{stub}}
|__mass|Float| {{stub}}
|__collideWithOtherCharacters|Bool| {{stub}}
|__ignoreRaycasts|Bool| {{stub}}
|__rootAtBottom|Bool| {{stub}}
}}
}}


Line 58: Line 63:


[[Category:ComponentStubs]]
[[Category:ComponentStubs]]
[[Category:Components|Character Controller]]
[[Category:Components:Physics{{#translation:}}|Character Controller]]
[[Category:Components:Physics|Character Controller]]
[[Category:Components{{#translation:}}|Character Controller]]

Revision as of 20:57, 3 March 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?)
SimulateRotation Bool
MassScaling PhysicsScalingMode This article or section is a Stub. You can help the Resonite Wiki by expanding it.
ForceScaling PhysicsScalingMode This article or section is a Stub. You can help the Resonite Wiki by expanding it.
SpeedScaling PhysicsScalingMode This article or section is a Stub. You can help the Resonite Wiki by expanding it.
JumpScaling PhysicsScalingMode This article or section is a Stub. You can help the Resonite Wiki by expanding it.
GravityScaling PhysicsScalingMode This article or section is a Stub. You can help the Resonite Wiki by expanding it.
LinearDamping Float This article or section is a Stub. You can help the Resonite Wiki by expanding it.
AngularDamping Float
Margin Float This article or section is a Stub. You can help the Resonite Wiki by expanding it.
StepUpHeight Float
StepUpCheckDistance Float
KillVerticalVelocityAfterStepUp Bool
EdgeDetectionDepth Float
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
GravitySpace direct RootSpace
DebugVisualDuration Nullable`1<Float>
__height Float Height of the driven CapsuleCollider (Component)
__radius Float Radius of the driven CapsuleCollider (Component)
__mass Float 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.
__rootAtBottom 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 Position ProtoFlux node is vastly superior.

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


A Shrike NPC running around the cloud home:

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.

Examples

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

Retrieved from "https://wiki.resonite.com/index.php?title=Component:CharacterController&oldid=78759"