Automated: create new component page |
add info |
||
Line 3: | Line 3: | ||
|Name=Teleport Locomotion | |Name=Teleport Locomotion | ||
}} | }} | ||
The '''TeleportLocomotion''' component is used to allow users to teleport to spots using an arc path as a location selector. | |||
== | == 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}} | ||
|BackstepDistance|Float| | |BackstepDistance|Float| How far to go backwards when pressing the backwards movement direction. | ||
|ActivationTime|Float| | |ActivationTime|Float| How long it takes for the teleport visual to show and for the locomotion to allow teleport when pressing the forward movement direction. | ||
|HeightInputMax|Float| | |HeightInputMax|Float| The maximum teleport up distance. | ||
|HeightInputMin|Float| | |HeightInputMin|Float| The minimum teleport height distance. | ||
|InitialForceMin|Float| | |InitialForceMin|Float| The minimum inital arc force value for the destination selection arc. | ||
|InitialForceMax|Float| | |InitialForceMax|Float| The maximum inital arc force value for the destination selection arc. | ||
|RangeExp|Float| | |RangeExp|Float| The amount to boost the teleport range. | ||
|StepUnit|Float| | |StepUnit|Float| What to use for the step value in the teleport arc. | ||
|Drag|Float| | |Drag|Float| What to use for the drag value in the teleport arc. | ||
|MaxSmallObjectSize|Float| | |MaxSmallObjectSize|Float| The maximum size to allow before a small object is not ignored for teleport destinations. | ||
|WallDistance|Float| | |WallDistance|Float| The depth a wall has to be compared to the user's size to be considered a wall. | ||
|_pathMesh|'''[[Component:BallisticPathMesh|BallisticPathMesh]]'''|TypeAdv17=true| | |_pathMesh|'''[[Component:BallisticPathMesh|BallisticPathMesh]]'''|TypeAdv17=true| The path mesh being used to display this locomotion's teleport location selector. | ||
|_pathMaterial|'''[[PBS_RimMetallic|PBS_RimMetallic]]'''|TypeAdv18=true| | |_pathMaterial|'''[[PBS_RimMetallic|PBS_RimMetallic]]'''|TypeAdv18=true| The material to control the look of that is on <code>_pathMesh</code>. | ||
|_pathRenderer|'''[[Component:MeshRenderer|MeshRenderer]]'''|TypeAdv19=true| | |_pathRenderer|'''[[Component:MeshRenderer|MeshRenderer]]'''|TypeAdv19=true| The renderer of this teleport locomotion's location selector visual. | ||
|_pathVisual|Slot| | |_pathVisual|Slot| the root slot of this teleport locomotion's location selector visual | ||
|_targetPointVisual|Slot| | |_targetPointVisual|Slot| the root of the hit point visual of this teleport locomotion's location selector visual | ||
|_characterController|'''[[Component:CharacterController|CharacterController]]'''|TypeAdv22=true| | |_characterController|'''[[Component:CharacterController|CharacterController]]'''|TypeAdv22=true| The character controller for this teleport locomotion. | ||
}} | }} | ||
== | == Usage == | ||
Used for accessibility reasons, and for puzzle games. | |||
== Examples == | == Examples == | ||
{{stub}} | |||
== See Also == | == See Also == | ||
* [[Type:ILocomotionModule|Other locomotion module types]] | |||
[[Category:Components:Locomotion:Modules{{#translation:}}|Teleport Locomotion]] | [[Category:Components:Locomotion:Modules{{#translation:}}|Teleport Locomotion]] | ||
[[Category:Components{{#translation:}}|Teleport Locomotion]] | [[Category:Components{{#translation:}}|Teleport Locomotion]] | ||
Latest revision as of 21:16, 26 January 2025
Component image 
Teleport Locomotion component as seen in the Scene Inspector

The TeleportLocomotion component is used to allow users to teleport to spots using an arc path as a location selector.
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. |
BackstepDistance
|
Float | How far to go backwards when pressing the backwards movement direction. |
ActivationTime
|
Float | How long it takes for the teleport visual to show and for the locomotion to allow teleport when pressing the forward movement direction. |
HeightInputMax
|
Float | The maximum teleport up distance. |
HeightInputMin
|
Float | The minimum teleport height distance. |
InitialForceMin
|
Float | The minimum inital arc force value for the destination selection arc. |
InitialForceMax
|
Float | The maximum inital arc force value for the destination selection arc. |
RangeExp
|
Float | The amount to boost the teleport range. |
StepUnit
|
Float | What to use for the step value in the teleport arc. |
Drag
|
Float | What to use for the drag value in the teleport arc. |
MaxSmallObjectSize
|
Float | The maximum size to allow before a small object is not ignored for teleport destinations. |
WallDistance
|
Float | The depth a wall has to be compared to the user's size to be considered a wall. |
_pathMesh
|
BallisticPathMesh | The path mesh being used to display this locomotion's teleport location selector. |
_pathMaterial
|
PBS_RimMetallic | The material to control the look of that is on _pathMesh .
|
_pathRenderer
|
MeshRenderer | The renderer of this teleport locomotion's location selector visual. |
_pathVisual
|
Slot | the root slot of this teleport locomotion's location selector visual |
_targetPointVisual
|
Slot | the root of the hit point visual of this teleport locomotion's location selector visual |
_characterController
|
CharacterController | The character controller for this teleport locomotion. |
Usage
Used for accessibility reasons, and for puzzle games.
Examples
This article or section is a Stub. You can help the Resonite Wiki by expanding it.