Facets: Difference between revisions

Latest revision as of 17:17, 28 September 2024

Facets are a modular system made from UIX allowing the user to customize the user interface of the Dash Menu, including the Facet Anchors.

Basic functionality

Facets are currently not editable in Desktop Mode. A GitHub issue #628 is open to track the status of that feature.

UI Edit Mode

To be able to move, remove, and place facets onto your Dash Menu, you will need to enable UI Edit Mode.

You can toggle UI Edit Mode in several ways:

This can be done in the "User Interface" section of the settings.
Using your controllers, hold down the dash menu button on one side of the controllers, and the other side you double tap the dash button.
Using a community-made facets to toggle this mode (there are several out there).
Using a the 3D Dash On Screen Mod made by rampa3, pressing the F4 key will allow you to toggle UI Edit Mode.

Mods are not officially supported. All issues must be reported to the mod creator.

Using Facets

When you are ready to place your facet on your Dash or Facet Anchors, and you have UI Edit Mode on, go to your Inventory and to a folder you own, then click on one of the facets and click on the button that says "Spawn Facet".

When the facet is spawned, it will be in user space (and will follow you positionally). You can then grab it and click and drag across the grid of your dash or facet anchors and the facet will conform to the preferred size you highlighted. Sometimes you have to push the facet slightly behind the grid for this to work.

If the facet is not getting onto your dash, it is most likely that it is in world space, you would need to save it to your inventory first.

Basic Facets

By default, the Dash Menu comes with a variety of facets in the home, worlds, settings, migration tabs.

You can find those default facets in the Resonite Essentials public folder.

Creating facets from settings

While having UI Edit Mode enabled, you can grab the six dots at the right of any setting to transform it into a facet you can place onto your Dash Menu or Facet Anchors.

Facet Anchors

Added in the version Beta 2024.5.28.94, facet anchors allow users to snap facets to their hands, forearms, and in front of their view, to create quick shortcuts to certain settings and other facets.

When enabled in the User Interface section of the settings, facet anchors can be toggled via the dash button on the controller of choice of the user (set in the same setting category).

Creating Facets

The sample facet created using the dev tool.

Facets are created using UIX. There is a sample facet to get you started. Use the Dev Tool and open the Create New Wizard and select Object -> Facet.

Creating facets is like working with any other UIX, except for these few differences:

The root contains a Facet and a Grabbable component.
The background is provided for you already
There is a Slot labeled "REPLACE THIS" that is just an image. This is the spot where you place your custom UIX.

@@ Line 1: / Line 1: @@
-<!--T:1-->
+'''Facets''' are a modular system made from [[UIX]] allowing the [[User|user]] to customize the user interface of the [[Dash Menu]], including the [[Facets#Facet Anchors|Facet Anchors]].
-Facets are a system made to make adjusting and replacing your UI elements on your [[Dash Menu|Dash]]
-<!--T:2-->
+== Basic functionality ==
-To currently use Facets, you need to enable UI Edit mode in [[Basic Controls]] to remove and replace any facet.
-<!--T:3-->
+{{Note|Facets are currently not editable in Desktop Mode. A [https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/628 GitHub issue #628] is open to track the status of that feature.|warning}}
-{| class="wikitable"
-|+Values
+=== UI Edit Mode ===
-|-
-| Name
+To be able to move, remove, and place facets onto your Dash Menu, you will need to enable [[UI Edit Mode]].
-| Default Value
-| Type
+You can toggle [[UI Edit Mode]] in several ways:
-|-
+* This can be done in the "User Interface" section of the [[Settings|settings]].
-| MinWidth
+* Using your controllers, hold down the dash menu button on one side of the controllers, and the other side you double tap the dash button.
-| 32
+* Using a community-made facets to toggle this mode (there are several out there).
-| [[:Category:Types:Float|Float]]
+* Using a the [https://github.com/rampa3/3DDashOnScreen 3D Dash On Screen Mod] made by [[User:rampa3|rampa3]], pressing the <code>F4</code> key will allow you to toggle UI Edit Mode.
-|-
-| MaxWidth
+{{Mod Warning}}
-| 1024
-| [[:Category:Types:Float|Float]]
+=== Using Facets ===
-|-
-| MinHeight
+When you are ready to place your facet on your Dash or Facet Anchors, and you have UI Edit Mode on, go to your [[Inventory]] and to a folder you own, then click on one of the facets and click on the button that says "Spawn Facet".
-| 32
-| [[:Category:Types:Float|Float]]
+When the facet is spawned, it will be in user space (and will follow you positionally). You can then grab it and click and drag across the grid of your dash or facet anchors and the facet will conform to the preferred size you highlighted. Sometimes you have to push the facet slightly behind the grid for this to work.
-|-
-| MaxHeight
+{{Note|If the facet is not getting onto your dash, it is most likely that it is in world space, you would need to save it to your inventory first.|information}}
-| 1024
-| [[:Category:Types:Float|Float]]
+=== Basic Facets ===
-|-
-| LastPlacedSized
+By default, the Dash Menu comes with a variety of facets in the home, worlds, settings, migration tabs.
-| null
-| [[:Category:Types:Float2|Float2]]
+You can find those default facets in the [[List_of_Public_Folders#Resonite_Essentials|Resonite Essentials public folder]].
-|}
+=== Creating facets from settings ===
+While having UI Edit Mode enabled, you can grab the six dots at the right of any setting to transform it into a facet you can place onto your Dash Menu or Facet Anchors.
+== Facet Anchors ==
+Added in the version [[Beta 2024.5.28.94]], facet anchors allow users to snap facets to their hands, forearms, and in front of their view, to create quick shortcuts to certain settings and other facets.
+When enabled in the User Interface section of the settings, facet anchors can be toggled via the dash button on the controller of choice of the user (set in the same setting category).
+== Creating Facets ==
+[[File:FacetSample.png|alt=The sample facet created using the dev tool.|thumb|The sample facet created using the dev tool.]]
+Facets are created using [[UIX]]. There is a sample facet to get you started. Use the [[Dev Tool]] and open the [[Create New Wizard]] and select Object -> Facet.
+Creating facets is like working with any other UIX, except for these few differences:
+* The root contains a [[Component:Facet|Facet]] and a [[Component:Grabbable|Grabbable]] component.
+* The background is provided for you already
+* There is a [[Slot]] labeled "REPLACE THIS" that is just an image. This is the spot where you place your custom UIX.
-<!--T:4-->
 == See Also ==
-<!--T:5-->
+* [[Component:Facet|Facet (Component)]]
-{{stub}}
+* [[Component:AvatarFacetAnchor|AvatarFacetAnchor]]
+* [[Component:FacetAnchorsSettings|FacetAnchorSettings]]
+* [[Component:UserspaceFacetAnchor|UserspaceFacetAnchor]]
+* [[Component:UserspaceFacetAnchorsManager|UserspaceFacetAnchorsManager]]
+[[Category:Features]]