Component:SettingValueActionProxy: Difference between revisions

From Resonite Wiki
Automated: update SyncDelegates
add info\
Line 3: Line 3:
|Name=Setting Value Action Proxy`2
|Name=Setting Value Action Proxy`2
}}
}}
{{stub}}
The '''SettingValueActionProxy''' component is used to trigger an action while passing a value to it 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`1|Action`1]]<T>|[[Type:Action`1|Action`1]]<T>|false|
|Trigger:[[Type:Action|Action]]|[[Type:Action|Action]]|false|  
}}
}}


== Behavior ==
== Sync Delegates ==
{{Table ComponentTriggers
|Trigger:[[Type:Action`1|Action`1]]<T>|[[Type:Action`1|Action`1]]<T>|false| triggers the target, while passing a value of type '''T''', which the target specified by this component's values and generic typing.
}}
 
== Usage ==
Not to be used directly by the user.


== Examples ==
== Examples ==
Is used in the session tab in the dash.


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

Revision as of 17:53, 8 April 2025

Component image 
File:SettingValueActionProxy`2Component.png
Setting Value Action Proxy`2 component as seen in the Scene Inspector

The SettingValueActionProxy component is used to trigger an action while passing a value to it 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

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
Trigger:Action`1<T> Action`1<T> X triggers the target, while passing a value of type T, which the target specified by this component's values and generic typing.

Usage

Not to be used directly by the user.

Examples

Is used in the session tab in the dash.

See Also