Component:RadiantDash: Difference between revisions

From Resonite Wiki
Automated: update SyncDelegates
add info
 
(3 intermediate revisions by 3 users not shown)
Line 3: Line 3:
|Name=Radiant Dash
|Name=Radiant Dash
}}
}}
{{stub}}
See [[Dash menu]].


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|CurrentScreen|'''[[Component:RadiantDashScreen|RadiantDashScreen]]'''|TypeAdv0=true|
|CurrentScreen|'''[[Component:RadiantDashScreen|RadiantDashScreen]]'''|TypeAdv0=true| The current screen this is showing.
|Open|Bool|
|Open|Bool| Whether the dash is open.
|AnimationSpeed|Float|
|AnimationSpeed|Float| How fast the dash should open.
|ScreenProjection|Bool|
|ScreenProjection|Bool| Whether this should be rendering in desktop mode.
|Curvature|Float|
|Curvature|Float| How curved the dash is.
|AspectRatioCompensation|CurvatureAspectRatioCompensation|
|AspectRatioCompensation|'''[[Component:CurvedPlaneMesh#CurvatureAspectRatioCompensation|CurvedPlaneMesh.CurvatureAspectRatioCompensation]]'''|TypeAdv5=true| How much to compensate the animation for curvature
|ScreenSwitchingEnabled|Bool|
|ScreenSwitchingEnabled|Bool| Whether to allow user screen switching.
|_screensContainer|Slot|
|_screensContainer|Slot| The slot to store different screens.
|_camera|'''[[Component:Camera|Camera]]'''|TypeAdv8=true|
|_camera|'''[[Component:Camera|Camera]]'''|TypeAdv8=true| The camera being used to render the screen onto the curved surface.
|_renderTexture|'''[[Component:RenderTextureProvider|RenderTextureProvider]]'''|TypeAdv9=true|
|_renderTexture|'''[[Component:RenderTextureProvider|RenderTextureProvider]]'''|TypeAdv9=true| the texture to render to the curved surface.
|_topContainer|Slot|
|_topContainer|Slot| The slot to store top elements.
|_topMesh|'''[[Component:CurvedPlaneMesh|CurvedPlaneMesh]]'''|TypeAdv11=true|
|_topMesh|'''[[Component:CurvedPlaneMesh|CurvedPlaneMesh]]'''|TypeAdv11=true| The mesh to show the top elements.
|_screenMesh|'''[[Component:CurvedPlaneMesh|CurvedPlaneMesh]]'''|TypeAdv12=true|
|_screenMesh|'''[[Component:CurvedPlaneMesh|CurvedPlaneMesh]]'''|TypeAdv12=true| The mesh to show the screen elements.
|_buttonsMesh|'''[[Component:CurvedPlaneMesh|CurvedPlaneMesh]]'''|TypeAdv13=true|
|_buttonsMesh|'''[[Component:CurvedPlaneMesh|CurvedPlaneMesh]]'''|TypeAdv13=true| The mesh to show the button elements.
|_topMaterial|'''[[UnlitMaterial|UnlitMaterial]]'''|TypeAdv14=true|
|_topMaterial|'''[[Component:UnlitMaterial|UnlitMaterial]]'''|TypeAdv14=true| The material to use for the top element.
|_screenMaterial|'''[[UnlitMaterial|UnlitMaterial]]'''|TypeAdv15=true|
|_screenMaterial|'''[[Component:UnlitMaterial|UnlitMaterial]]'''|TypeAdv15=true| The material to use for the screen element.
|_buttonsMaterial|'''[[UnlitMaterial|UnlitMaterial]]'''|TypeAdv16=true|
|_buttonsMaterial|'''[[Component:UnlitMaterial|UnlitMaterial]]'''|TypeAdv16=true| The material to use for the buttons element.
|_overlayEffectMaterial|'''[[UI_UnlitMaterial|UI_UnlitMaterial]]'''|TypeAdv17=true|
|_overlayEffectMaterial|'''[[Component:UI_UnlitMaterial|UI_UnlitMaterial]]'''|TypeAdv17=true| The material to use for an overlay effect.
|_topBorderMaterial|'''[[UV_RectMaterial|UV_RectMaterial]]'''|TypeAdv18=true|
|_topBorderMaterial|'''[[Component:UV_RectMaterial|UV_RectMaterial]]'''|TypeAdv18=true| The material to use for the top border.
|_screenBorderMaterial|'''[[UV_RectMaterial|UV_RectMaterial]]'''|TypeAdv19=true|
|_screenBorderMaterial|'''[[Component:UV_RectMaterial|UV_RectMaterial]]'''|TypeAdv19=true| The material to use for the screen border.
|_buttonsBorderMaterial|'''[[UV_RectMaterial|UV_RectMaterial]]'''|TypeAdv20=true|
|_buttonsBorderMaterial|'''[[Component:UV_RectMaterial|UV_RectMaterial]]'''|TypeAdv20=true| The material to use for the buttons border.
|_renderRoot|Slot|
|_renderRoot|Slot| The slot to render with the camera to create the visual for the curved screen.
|_topRoot|Slot|
|_topRoot|Slot| The root of the top element renderable.
|_screenRoot|Slot|
|_screenRoot|Slot| The root of the screen element renderable.
|_buttonsRoot|Slot|
|_buttonsRoot|Slot| The root of the button element renderable.
|_visualsRoot|Slot|
|_visualsRoot|Slot| The root of the visuals.
|_effectRoot|Slot|
|_effectRoot|Slot| The root of special effects.
|_topCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv27=true|
|_topCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv27=true| The UIX canvas of the top element.
|_buttonsUIroot|Slot|
|_buttonsUIroot|Slot| The root slot of the buttons element.
|_buttonsCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv29=true|
|_buttonsCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv29=true| The UIX canvas of the buttons element.
|_style|'''[[Component:ParticleStyle|ParticleStyle]]'''|TypeAdv30=true|
|_style|'''[[Component:ParticleStyle|ParticleStyle]]'''|TypeAdv30=true| The style of the particle system creating the screen animation opening and closing edge.
|_particleColors|'''[[Component:ColorRangeInitializer|ColorRangeInitializer]]'''|TypeAdv31=true|
|_particleColors|'''[[Component:ColorRangeInitializer|ColorRangeInitializer]]'''|TypeAdv31=true| The color of the particles being spawned in when the dash is opening and closing.
|_emitter|'''[[Component:MeshEmitter|MeshEmitter]]'''|TypeAdv32=true|
|_emitter|'''[[Component:MeshEmitter|MeshEmitter]]'''|TypeAdv32=true| The emitter for the opening and closing animation.
|_topCollider|'''[[Component:MeshCollider|MeshCollider]]'''|TypeAdv33=true|
|_topCollider|'''[[Component:MeshCollider|MeshCollider]]'''|TypeAdv33=true| The collider for the top element.
|_screenCollider|'''[[Component:MeshCollider|MeshCollider]]'''|TypeAdv34=true|
|_screenCollider|'''[[Component:MeshCollider|MeshCollider]]'''|TypeAdv34=true| The collider for the screens element.
|_buttonsCollider|'''[[Component:MeshCollider|MeshCollider]]'''|TypeAdv35=true|
|_buttonsCollider|'''[[Component:MeshCollider|MeshCollider]]'''|TypeAdv35=true| The collider for the buttons element.
}}
}}


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|IsRenderRoot:[[Type:Func`3|Func`3]]<[[Type:ICollider|ICollider]], [[Type:Int|Int]], [[Type:Bool|Bool]]>|[[Type:Func`3|Func`3]]<[[Type:ICollider|ICollider]], [[Type:Int|Int]], [[Type:Bool|Bool]]>|true|
|IsRenderRoot:[[Type:Func`3|Func`3]]<[[Type:ICollider|ICollider]], [[Type:Int|Int]], [[Type:Bool|Bool]]>|[[Type:Func`3|Func`3]]<[[Type:ICollider|ICollider]], [[Type:Int|Int]], [[Type:Bool|Bool]]>|true| Can be used to filter a raycast portal to only hit items that are part of the colliders under this component's render root.
}}
}}


== Behavior ==
== Usage ==


== Examples ==
== Examples ==
Line 58: Line 58:
[[Category:Components:Uncategorized{{#translation:}}|Radiant Dash]]
[[Category:Components:Uncategorized{{#translation:}}|Radiant Dash]]
[[Category:Components{{#translation:}}|Radiant Dash]]
[[Category:Components{{#translation:}}|Radiant Dash]]
[[Category:ComponentStubs]]

Latest revision as of 02:44, 1 August 2025

Component image 
Radiant Dash component as seen in the Scene Inspector

See Dash menu.

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.
CurrentScreen RadiantDashScreen The current screen this is showing.
Open Bool Whether the dash is open.
AnimationSpeed Float How fast the dash should open.
ScreenProjection Bool Whether this should be rendering in desktop mode.
Curvature Float How curved the dash is.
AspectRatioCompensation CurvedPlaneMesh.CurvatureAspectRatioCompensation How much to compensate the animation for curvature
ScreenSwitchingEnabled Bool Whether to allow user screen switching.
_screensContainer Slot The slot to store different screens.
_camera Camera The camera being used to render the screen onto the curved surface.
_renderTexture RenderTextureProvider the texture to render to the curved surface.
_topContainer Slot The slot to store top elements.
_topMesh CurvedPlaneMesh The mesh to show the top elements.
_screenMesh CurvedPlaneMesh The mesh to show the screen elements.
_buttonsMesh CurvedPlaneMesh The mesh to show the button elements.
_topMaterial UnlitMaterial The material to use for the top element.
_screenMaterial UnlitMaterial The material to use for the screen element.
_buttonsMaterial UnlitMaterial The material to use for the buttons element.
_overlayEffectMaterial UI_UnlitMaterial The material to use for an overlay effect.
_topBorderMaterial UV_RectMaterial The material to use for the top border.
_screenBorderMaterial UV_RectMaterial The material to use for the screen border.
_buttonsBorderMaterial UV_RectMaterial The material to use for the buttons border.
_renderRoot Slot The slot to render with the camera to create the visual for the curved screen.
_topRoot Slot The root of the top element renderable.
_screenRoot Slot The root of the screen element renderable.
_buttonsRoot Slot The root of the button element renderable.
_visualsRoot Slot The root of the visuals.
_effectRoot Slot The root of special effects.
_topCanvas Canvas The UIX canvas of the top element.
_buttonsUIroot Slot The root slot of the buttons element.
_buttonsCanvas Canvas The UIX canvas of the buttons element.
_style ParticleStyle The style of the particle system creating the screen animation opening and closing edge.
_particleColors ColorRangeInitializer The color of the particles being spawned in when the dash is opening and closing.
_emitter MeshEmitter The emitter for the opening and closing animation.
_topCollider MeshCollider The collider for the top element.
_screenCollider MeshCollider The collider for the screens element.
_buttonsCollider MeshCollider The collider for the buttons element.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
IsRenderRoot:Func`3<ICollider, Int, Bool> Func`3<ICollider, Int, Bool> Can be used to filter a raycast portal to only hit items that are part of the colliders under this component's render root.

Usage

Examples

See Also