add sync delegate desc |
add info |
||
| Line 3: | Line 3: | ||
|Name=Proto Flux Global Ref Proxy | |Name=Proto Flux Global Ref Proxy | ||
}} | }} | ||
The '''ProtoFluxGlobalRefProxy''' component allows for a piece of UI to act as a relay for interacting with global value component. | |||
== Fields == | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Node|ProtoFluxNode| | |Node|ProtoFluxNode| The node that this is on. | ||
|ElementName|String| | |ElementName|String| the name of the target component. | ||
|ValueType|{{RootFieldType|SyncType}}|TypeAdv2=true| | |ValueType|{{RootFieldType|SyncType}}|TypeAdv2=true| The type of the value being held. | ||
|_label|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv3=true| | |_label|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv3=true| The field to drive with global value properties to make a name. | ||
|_proxyVisual|'''[[Component:Button|Button]]'''|TypeAdv4=true| | |_proxyVisual|'''[[Component:Button|Button]]'''|TypeAdv4=true| The Button used for the proxy surrounding visual. | ||
|_refProxySource|{{RootFieldType|RelayRef`1|[[Component:ReferenceProxySource|ReferenceProxySource]]}}|TypeAdv5=true| | |_refProxySource|{{RootFieldType|RelayRef`1|[[Component:ReferenceProxySource|ReferenceProxySource]]}}|TypeAdv5=true| The proxy used to get the global ref. | ||
|TargetGlobalRef|{{RootFieldType|RelayRef`1|[[Type:ISyncRef|ISyncRef]]}}|TypeAdv6=true| | |TargetGlobalRef|{{RootFieldType|RelayRef`1|[[Type:ISyncRef|ISyncRef]]}}|TypeAdv6=true| The target global reference this visual has been made for. | ||
|_currentProxy|{{RootFieldType|RelayRef`1|[[Type:IGlobalValueProxy|IGlobalValueProxy]]}}|TypeAdv7=true| | |_currentProxy|{{RootFieldType|RelayRef`1|[[Type:IGlobalValueProxy|IGlobalValueProxy]]}}|TypeAdv7=true| The current proxy this is using. | ||
}} | }} | ||
| Line 23: | Line 23: | ||
== Usage == | == Usage == | ||
Used in nodes like raw data tool events to show the field for the raw data tool. This is also used to interact with said visual. | |||
== Examples == | == Examples == | ||
== See Also == | == See Also == | ||
* [[ProtoFlux]] | |||
[[Category:Components:Uncategorized{{#translation:}}|Proto Flux Global Ref Proxy]] | [[Category:Components:Uncategorized{{#translation:}}|Proto Flux Global Ref Proxy]] | ||
[[Category:Components{{#translation:}}|Proto Flux Global Ref Proxy]] | [[Category:Components{{#translation:}}|Proto Flux Global Ref Proxy]] | ||
Latest revision as of 19:29, 23 July 2025
Component image 
Proto Flux Global Ref Proxy component as seen in the Scene Inspector
The ProtoFluxGlobalRefProxy component allows for a piece of UI to act as a relay for interacting with global value component.
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. |
Node
|
ProtoFluxNode | The node that this is on. |
ElementName
|
String | the name of the target component. |
ValueType
|
direct SyncType | The type of the value being held. |
_label
|
field drive of String | The field to drive with global value properties to make a name. |
_proxyVisual
|
Button | The Button used for the proxy surrounding visual. |
_refProxySource
|
direct RelayRef`1<ReferenceProxySource> | The proxy used to get the global ref. |
TargetGlobalRef
|
direct RelayRef`1<ISyncRef> | The target global reference this visual has been made for. |
_currentProxy
|
direct RelayRef`1<IGlobalValueProxy> | The current proxy this is using. |
Sync Delegates
| Method Name | Method type and Arguments. | Is the method hidden? | Description |
|---|---|---|---|
OnProxyButtonPressed:ButtonEventHandler
|
ButtonEventHandler | ✓ | Called when the proxy button is touched on the visual. |
Usage
Used in nodes like raw data tool events to show the field for the raw data tool. This is also used to interact with said visual.