Favorites: Difference between revisions

From Resonite Wiki
VisualWikitext
maybe I am blind, but why does this not have a page. here have fun!
 
forgot avatars and world orbs oops.
 
Line 1: Line 1:
Favorites are a system in Resonite to allow users to set their own custom UI for different elements of the game. A favoritable item will have a component that extends the EntityInterface class in game.
Favorites are a system in Resonite to allow users to set their own custom UI for different elements of the game. A favoritable item will have a component that extends the EntityInterface class in game. The exceptions to the EntityInterface rules are Avatars and WorldOrbs.


These items will all have in common:
EntityInterfaces will all have in common:
{{Table TypeFields
{{Table TypeFields
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true| The name of this favoritable item.  
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true| The name of this favoritable item.  
Line 12: Line 12:
* The game will spawn the user's favorited version rather than the default in all cases where the user opens that type of UI
* The game will spawn the user's favorited version rather than the default in all cases where the user opens that type of UI
* when the item is spawned by means not from inventory, the <code>IsInstance</code> boolean is switched on, allowing ProtoFlux to read this and know it was spawned by the game. This is used in [[Component:ProgressBarInterface]]s to make them disappear and delete themselves after loading is done
* when the item is spawned by means not from inventory, the <code>IsInstance</code> boolean is switched on, allowing ProtoFlux to read this and know it was spawned by the game. This is used in [[Component:ProgressBarInterface]]s to make them disappear and delete themselves after loading is done
* these items can be modified, saved to inventory, and then favorited. Allowing for users to customize their UI elements when working.
* these items can be modified, saved to inventory, and then favorited. Allowing for users to customize their UI elements and game elements.


Components that currently support this are:
Components that currently support this are:
{{Template:EntityInterface_SeeAlso}}
{{Template:EntityInterface_SeeAlso}}
* [[Avatar]]s
* [[Component:WorldOrb]]

Latest revision as of 22:18, 4 January 2025

Favorites are a system in Resonite to allow users to set their own custom UI for different elements of the game. A favoritable item will have a component that extends the EntityInterface class in game. The exceptions to the EntityInterface rules are Avatars and WorldOrbs.

EntityInterfaces will all have in common:

Fields
Name Type Description
ItemName IField`1<String> The name of this favoritable item.
SpawningUser UserRef The user that spawned this favoritable item.
SpawningUserID IField`1<String> The field containing the ID of the user that spawned this favoritable item.
IsInstance Bool Whether this item is an instance.

Items that have this component at the root of their hiearchy all have in common that:

  • The game will spawn the user's favorited version rather than the default in all cases where the user opens that type of UI
  • when the item is spawned by means not from inventory, the IsInstance boolean is switched on, allowing ProtoFlux to read this and know it was spawned by the game. This is used in Component:ProgressBarInterfaces to make them disappear and delete themselves after loading is done
  • these items can be modified, saved to inventory, and then favorited. Allowing for users to customize their UI elements and game elements.

Components that currently support this are:

Retrieved from "https://wiki.resonite.com/index.php?title=Favorites&oldid=94003"
Last modified
This page was last edited on 4 January 2025, at 22:18.