Component:CharacterForceField: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add some info
Line 7: Line 7:
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|TriggersOnly|Bool|
|TriggersOnly|Bool| Whether to only allow trigger colliders attached to character controller objects to activate the force field.
|Force|Float3|
|Force|Float3|force direction and magnitude to apply a character controller within range with.
|ForceMode|'''[[#Mode|Mode]]'''|TypeAdv2=true|
|ForceMode|'''[[#Mode|Mode]]'''|TypeAdv2=true| Whether to use impulse, apply, or set velocity using <code>Force</code>
|ForceSpace|'''[[#Space|Space]]'''|TypeAdv3=true|
|ForceSpace|'''[[#Space|Space]]'''|TypeAdv3=true| Whether to do the force direction in local or global space (so should <code>Force</code> be scaled and rotated by the slot this is on or not?)
|RadialForceRadius|Float|
|RadialForceRadius|Float| The range of effect this force field has.
|ForceSlotSpace|{{RootFieldType|RootSpace}}|TypeAdv5=true|
|ForceSlotSpace|{{RootFieldType|RootSpace}}|TypeAdv5=true| Override the transform space for <code>Force</code> with this if set.
|MinActivationVelocity|Float|
|MinActivationVelocity|Float| The minimum velocity a character controller has to be going to trigger this force field.
|MaxForceVelocity|Float|
|MaxForceVelocity|Float|  
|HoldJumpMaxForceVelocity|Float|
|HoldJumpMaxForceVelocity|Float|  
|PreseveDirectionAcrossPlane|Bool|
|PreseveDirectionAcrossPlane|Bool|  
|IgnoreParentUser|Bool|
|IgnoreParentUser|Bool| Whether to ignore the active user when finding character controllers within range of <code>RadialForceRadius</code>. This also ignores character controllers that are simulated by the user. (TODO: is this true?)
|NoJumpMultiplier|Float|
|NoJumpMultiplier|Float|
|HoldJumpMultiplier|Float|
|HoldJumpMultiplier|Float|
|MaxCharacterVelocity|Float|
|MaxCharacterVelocity|Float| The maximum velocity this component can set a character controller's speed to after setting a force on it.
|MinCharacterVelocity|Float|
|MinCharacterVelocity|Float| The minimum velocity this component can set a character controller's speed to after setting a force on it.
|CharacterVelocityDampeningSpeed|Float|
|CharacterVelocityDampeningSpeed|Float|
}}
}}
Line 30: Line 30:


== See Also ==
== See Also ==
[[Component:CharacterController|Character Controllers]]


[[Category:Components:Locomotion:Interaction{{#translation:}}|Character Force Field]]
[[Category:Components:Locomotion:Interaction{{#translation:}}|Character Force Field]]

Revision as of 15:45, 16 October 2024

Component image 
Character Force Field component as seen in the Scene Inspector


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


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 attached to character controller objects to activate the force field.
Force Float3 force direction and magnitude to apply a character controller within range with.
ForceMode Mode Whether to use impulse, apply, or set velocity using Force
ForceSpace Space Whether to do the force direction in local or global space (so should Force be scaled and rotated by the slot this is on or not?)
RadialForceRadius Float The range of effect this force field has.
ForceSlotSpace direct RootSpace Override the transform space for Force with this if set.
MinActivationVelocity Float The minimum velocity a character controller has to be going to trigger this force field.
MaxForceVelocity Float
HoldJumpMaxForceVelocity Float
PreseveDirectionAcrossPlane Bool
IgnoreParentUser Bool Whether to ignore the active user when finding character controllers within range of RadialForceRadius. This also ignores character controllers that are simulated by the user. (TODO: is this true?)
NoJumpMultiplier Float
HoldJumpMultiplier Float
MaxCharacterVelocity Float The maximum velocity this component can set a character controller's speed to after setting a force on it.
MinCharacterVelocity Float The minimum velocity this component can set a character controller's speed to after setting a force on it.
CharacterVelocityDampeningSpeed Float

Behavior

Examples

See Also

Character Controllers