Component:SlideLocomotion: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Slide Locomotion
|Name=Slide Locomotion
}}
}}
{{stub}}
The '''SlideLocomotion''' component acts the same as a [[Component:NoclipLocomotion]] except that this locomotion will attach the user to a raycasted surface below them regardless of collider type. When a surface is not found, Behavior compared to noclip is identical.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Icon|'''[[Type:IAssetProvider`1|IAssetProvider`1]]<[[Type:ITexture2D|ITexture2D]]>'''|TypeAdv0=true|
|Icon|'''[[Type:IAssetProvider`1|IAssetProvider`1]]<[[Type:ITexture2D|ITexture2D]]>'''|TypeAdv0=true| {{Template:ILocomotion_Icon}}
|Color|ColorX|
|Color|ColorX| {{Template:ILocomotion_Color}}
|_currentController|'''[[Component:LocomotionController|LocomotionController]]'''|TypeAdv2=true|
|_currentController|'''[[Component:LocomotionController|LocomotionController]]'''|TypeAdv2=true| {{Template:ILocomotion__currentController}}
|_lastDefaultIcon|Uri|
|_lastDefaultIcon|Uri| {{Template:ILocomotion__lastDefaultIcon}}
|_lastDefaultColor|'''[[Type:Nullable`1|Nullable`1]]<[[Type:ColorX|ColorX]]>'''|TypeAdv4=true|
|_lastDefaultColor|'''[[Type:Nullable`1|Nullable`1]]<[[Type:ColorX|ColorX]]>'''|TypeAdv4=true| {{Template:ILocomotion__lastDefaultColor}}
|Turn|{{RootFieldType|TurnSubmodule}}|TypeAdv5=true|
|Turn|{{RootFieldType|TurnSubmodule}}|TypeAdv5=true| {{Template:ILocmotion_Turn}}
|MaxSpeed|Float|
|MaxSpeed|Float| The fastest speed this locomotion can travel.
|MinimumFlySpeedRatio|Float|
|MinimumFlySpeedRatio|Float| Unused.
|MaxSnapDistance|Float|
|MaxSnapDistance|Float| The maximum distance to check from the user's feet position plus <code>SnapCheckOffset</code> downward.
|SnapCheckOffset|Float|
|SnapCheckOffset|Float| anything from the user's feet within this range downward is not raycasted.
|SnapMinObjectSize|Float|
|SnapMinObjectSize|Float| The minimum size of the object's max dimensions on any axis in global space compared to the user's max size on any axis needed for us to snap to it's surface below us.
}}
}}


== Behavior ==
== Usage ==
Can be used for sticky fly locomotion.


== Examples ==
== Examples ==
{{stub}}


== See Also ==
== See Also ==
* [[Type:ILocomotionModule|Other locomotion module types]]


[[Category:Components:Locomotion:Modules{{#translation:}}|Slide Locomotion]]
[[Category:Components:Locomotion:Modules{{#translation:}}|Slide Locomotion]]
[[Category:Components{{#translation:}}|Slide Locomotion]]
[[Category:Components{{#translation:}}|Slide Locomotion]]
[[Category:ComponentStubs]]

Latest revision as of 21:00, 26 January 2025

Component image 
Slide Locomotion component as seen in the Scene Inspector

The SlideLocomotion component acts the same as a Component:NoclipLocomotion except that this locomotion will attach the user to a raycasted surface below them regardless of collider type. When a surface is not found, Behavior compared to noclip is identical.

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. Some components stop their functionality when this field is disabled, but some don't.
Icon IAssetProvider`1<ITexture2D> The icon image visual for this locomotion in the context menu.
Color ColorX The color of this locomotion's icon in the context menu.
_currentController LocomotionController The current Locomotion controller which would be from a user controlling this locmotion.
_lastDefaultIcon Uri The last URI used for the default context menu icon for this locomotion.
_lastDefaultColor Nullable`1<ColorX> The last color used for the default version of this locomotion for the context menu.
Turn direct TurnSubmodule How turning should be handled for this locomotion.
MaxSpeed Float The fastest speed this locomotion can travel.
MinimumFlySpeedRatio Float Unused.
MaxSnapDistance Float The maximum distance to check from the user's feet position plus SnapCheckOffset downward.
SnapCheckOffset Float anything from the user's feet within this range downward is not raycasted.
SnapMinObjectSize Float The minimum size of the object's max dimensions on any axis in global space compared to the user's max size on any axis needed for us to snap to it's surface below us.

Usage

Can be used for sticky fly locomotion.

Examples

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


See Also