Component:SettingActionProxy: Difference between revisions

From Resonite Wiki
Automated: update SyncDelegates
add info
 
Line 1: Line 1:
{{UserspaceComponent}}
{{Infobox Component
{{Infobox Component
|Image=SettingActionProxy`1Component.png
|Image=SettingActionProxy`1Component.png
|Name=Setting Action Proxy`1
|Name=Setting Action Proxy`1
}}
}}
{{stub}}
The '''SettingActionProxy''' component is used to trigger an action on a subsetting under the component of type '''S''' which would be globally registered in the world.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|ActionName|String|
|ActionName|String| The name of the action being triggered.
|SubsettingGetter|String|
|SubsettingGetter|String| The name of the sync delegate method being triggered.
|SubsettingKey|String|
|SubsettingKey|String| The key being used to find the sub setting being triggered.
}}
}}


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|Trigger:[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|Trigger:[[Type:Action|Action]]|[[Type:Action|Action]]|false| triggers the target specified by this component's values and generic typing.
}}
}}


== Behavior ==
== Usage ==
Used in the settings menu and only works in user space.


== Examples ==
== Examples ==
Settings menu UI.


== See Also ==
== See Also ==
Line 26: Line 29:
[[Category:Components{{#translation:}}|Setting Action Proxy`1]]
[[Category:Components{{#translation:}}|Setting Action Proxy`1]]
[[Category:Generic Components{{#translation:}}|Setting Action Proxy`1]]
[[Category:Generic Components{{#translation:}}|Setting Action Proxy`1]]
[[Category:ComponentStubs]]

Latest revision as of 17:50, 8 April 2025

This is a userspace component — you cannot attach it anywhere but the userspace. Messing with the userspace can be fun, but it is not recommended as you risk messing your dash up if you don't know what you're doing.
Component image 
File:SettingActionProxy`1Component.png
Setting Action Proxy`1 component as seen in the Scene Inspector

The SettingActionProxy component is used to trigger an action on a subsetting under the component of type S which would be globally registered in the world.

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.
ActionName String The name of the action being triggered.
SubsettingGetter String The name of the sync delegate method being triggered.
SubsettingKey String The key being used to find the sub setting being triggered.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
Trigger:Action Action X triggers the target specified by this component's values and generic typing.

Usage

Used in the settings menu and only works in user space.

Examples

Settings menu UI.

See Also