Component:SettingsDataFeed: Difference between revisions

From Resonite Wiki
update method identity
"dash world" -> userspace, cleanup
 
(3 intermediate revisions by 3 users not shown)
Line 3: Line 3:
|Name=Settings Data Feed
|Name=Settings Data Feed
}}
}}
The '''SettingsDataFeed''' component is a [[Data Feed]] that can be used with a data feed view to create and generate a list of settings. This component only works within the dash world.
 
The '''SettingsDataFeed''' component is a [[Data Feed|data feed]] that generates a list of [[settings]] and their categories.
 
{{Note|Using this outside of [[userspace]] and interacting with it can crash the session!|warning}}


== Usage ==
== Usage ==
{{Table ComponentFields
 
}}
{{Table ComponentFields}}


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|PathSegmentName:[[Type:PathSegmentConverter|PathSegmentConverter]]|[[Type:PathSegmentConverter|PathSegmentConverter]]|false| Gets the locale string of a path using a depth and a name.
|PathSegmentName:[[Type:PathSegmentConverter|PathSegmentConverter]]|[[Type:PathSegmentConverter|PathSegmentConverter]]|false| Gets the locale string of a path using a depth and a name.
Line 15: Line 19:


== Usage ==
== Usage ==
{{stub}}
{{stub}}


== Examples ==
== Examples ==
Used in the settings menu in the [[Dash Menu]].
 
Used for the settings facet used in the settings tab of the [[Dash Menu|dash menu]].


== See Also ==
== See Also ==
* [[Settings]]
* [[Settings]]


[[Category:Components:Utility{{#translation:}}|Settings Data Feed]]
[[Category:Components:Utility{{#translation:}}|Settings Data Feed]]
[[Category:Components{{#translation:}}|Settings Data Feed]]
[[Category:Components{{#translation:}}|Settings Data Feed]]

Latest revision as of 15:19, 14 April 2025

Component image 
Settings Data Feed component as seen in the Scene Inspector


The SettingsDataFeed component is a data feed that generates a list of settings and their categories.

Using this outside of userspace and interacting with it can crash the session!

Usage

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.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
PathSegmentName:PathSegmentConverter PathSegmentConverter X Gets the locale string of a path using a depth and a name.

Usage

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

Examples

Used for the settings facet used in the settings tab of the dash menu.

See Also