Component:ProtoFluxReferenceProxy: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
(One intermediate revision by one other user not shown)
Line 3: Line 3:
|Name=Proto Flux Reference Proxy
|Name=Proto Flux Reference Proxy
}}
}}
{{stub}}
The '''ProtoFluxReferenceProxy''' component is used to usually manage global references like on write node write targets and the monitoring slot on the slot events node.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Node|'''[[Component:ProtoFluxNode|ProtoFluxNode]]'''|TypeAdv0=true|
|Node|ProtoFluxNode| The node this is making a visual for.
|ElementName|String|
|ElementName|String| The element this is pointing to.
|ValueType|{{RootFieldType|SyncType}}|TypeAdv2=true|
|ValueType|{{RootFieldType|SyncType}}|TypeAdv2=true| the type of the value input this is pointing to.
|_label|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv3=true|
|_label|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv3=true| The text element of the element this is for.
|_proxyVisual|'''[[Component:Button|Button]]'''|TypeAdv4=true|
|_proxyVisual|'''[[Component:Button|Button]]'''|TypeAdv4=true| The button to set the input field value with.
|_refProxySource|{{RootFieldType|RelayRef`1|[[Component:ReferenceProxySource|ReferenceProxySource]]}}|TypeAdv5=true|
|_refProxySource|{{RootFieldType|RelayRef`1|[[Component:ReferenceProxySource|ReferenceProxySource]]}}|TypeAdv5=true| the component that handles grabbing the value of the field this points to via UIX.
|NodeReference|{{RootFieldType|RelayRef`1|[[Type:ISyncRef|ISyncRef]]}}|TypeAdv6=true|
|NodeReference|{{RootFieldType|RelayRef`1|[[Type:ISyncRef|ISyncRef]]}}|TypeAdv6=true| The node the value field points to, if it should point to a protoflux node like for a write node.
|Arrow|{{RootFieldType|CleanupRef`1|[[Component:ProtofluxArrowManager|ProtofluxArrowManager]]}}|TypeAdv7=true|
|Arrow|{{RootFieldType|CleanupRef`1|[[Component:ProtofluxArrowManager|ProtofluxArrowManager]]}}|TypeAdv7=true| the arrow pointing to a protoflux node if the value field's value points to a protoflux node.
|ConnectPoint|Slot|
|ConnectPoint|Slot| The slot that should act as the connector point.
|_currentName|{{RootFieldType|RelayRef`1|[[Type:IValue`1|IValue`1]]<[[Type:String|String]]>}}|TypeAdv9=true|
|_currentName|{{RootFieldType|RelayRef`1|[[Type:IValue`1|IValue`1]]<[[Type:String|String]]>}}|TypeAdv9=true| The field to drive with the current name of the value that this component's value field is pointing to.
|_selfHovering|{{RootFieldType|RelayRef`1|[[Type:IValue`1|IValue`1]]<[[Type:Bool|Bool]]>}}|TypeAdv10=true|
|_selfHovering|{{RootFieldType|RelayRef`1|[[Type:IValue`1|IValue`1]]<[[Type:Bool|Bool]]>}}|TypeAdv10=true| The field to drive with whether or not this element is being hovered over.
|_targetHovering|{{RootFieldType|RelayRef`1|[[Type:IValue`1|IValue`1]]<[[Type:Bool|Bool]]>}}|TypeAdv11=true|
|_targetHovering|{{RootFieldType|RelayRef`1|[[Type:IValue`1|IValue`1]]<[[Type:Bool|Bool]]>}}|TypeAdv11=true| The field to drive with whether or not the element this is targeting is a node and is being hovered over.
|_arrowManagerEnabled|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv12=true|
|_arrowManagerEnabled|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv12=true| The field to drive in order to enable/disable the arrow manager.
|_arrowRendererEnabled|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv13=true|
|_arrowRendererEnabled|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv13=true| The field to drive in order to enable/disable the arrow manager's arrow visual.
}}
}}


== Behavior ==
== Usage ==


== Examples ==
== Examples ==
Line 31: Line 31:
[[Category:Components:Uncategorized{{#translation:}}|Proto Flux Reference Proxy]]
[[Category:Components:Uncategorized{{#translation:}}|Proto Flux Reference Proxy]]
[[Category:Components{{#translation:}}|Proto Flux Reference Proxy]]
[[Category:Components{{#translation:}}|Proto Flux Reference Proxy]]
[[Category:ComponentStubs]]

Latest revision as of 02:24, 1 August 2025

Component image 
Proto Flux Reference Proxy component as seen in the Scene Inspector

The ProtoFluxReferenceProxy component is used to usually manage global references like on write node write targets and the monitoring slot on the slot events node.

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.
Node ProtoFluxNode The node this is making a visual for.
ElementName String The element this is pointing to.
ValueType direct SyncType the type of the value input this is pointing to.
_label field drive of String The text element of the element this is for.
_proxyVisual Button The button to set the input field value with.
_refProxySource direct RelayRef`1<ReferenceProxySource> the component that handles grabbing the value of the field this points to via UIX.
NodeReference direct RelayRef`1<ISyncRef> The node the value field points to, if it should point to a protoflux node like for a write node.
Arrow direct CleanupRef`1<ProtofluxArrowManager> the arrow pointing to a protoflux node if the value field's value points to a protoflux node.
ConnectPoint Slot The slot that should act as the connector point.
_currentName direct RelayRef`1<IValue`1<String>> The field to drive with the current name of the value that this component's value field is pointing to.
_selfHovering direct RelayRef`1<IValue`1<Bool>> The field to drive with whether or not this element is being hovered over.
_targetHovering direct RelayRef`1<IValue`1<Bool>> The field to drive with whether or not the element this is targeting is a node and is being hovered over.
_arrowManagerEnabled field drive of Bool The field to drive in order to enable/disable the arrow manager.
_arrowRendererEnabled field drive of Bool The field to drive in order to enable/disable the arrow manager's arrow visual.

Usage

Examples

See Also