Component:ProtoFluxNodeVisual: Difference between revisions

From Resonite Wiki
Automated: update Fields
add info
 
Line 3: Line 3:
|Name=Proto Flux Node Visual
|Name=Proto Flux Node Visual
}}
}}
{{stub}}
The '''ProtoFluxNodeVisual''' component is  used to manage the visuals and interaction with ProtoFlux nodes when they are unpacked.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Node|{{RootFieldType|RelayRef`1|[[Type:ProtoFluxNode|ProtoFluxNode]]}}|TypeAdv0=true|
|Node|{{RootFieldType|RelayRef`1|[[Type:ProtoFluxNode|ProtoFluxNode]]}}|TypeAdv0=true| The protoflux node this is a visual for.
|IsSelected|Bool|
|IsSelected|Bool| Whether or not this node is selected.
|IsHighlighted|Bool|
|IsHighlighted|Bool| Whether or not this node is highlighted.
|_nodeHoverArea|'''[[Component:HoverArea|HoverArea]]'''|TypeAdv3=true|
|_nodeHoverArea|'''[[Component:HoverArea|HoverArea]]'''|TypeAdv3=true| The Hover interaction area for this visual.
|_bgImage|'''[[Component:Image|Image]]'''|TypeAdv4=true|
|_bgImage|'''[[Component:Image|Image]]'''|TypeAdv4=true| The background image for tye protoflux visual.
|_inputsRoot|Slot|
|_inputsRoot|Slot| The root of the different slots for node inputs.
|_outputsRoot|Slot|
|_outputsRoot|Slot| The root of the different slots for node outputs.
|_referencesRoot|Slot|
|_referencesRoot|Slot| The slot for references to other nodes like arrows for protoflux variables/globals.
|_overviewVisual|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv8=true|
|_overviewVisual|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv8=true| The field for enabling the overview alt version of this node.
|_overviewBg|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv9=true|
|_overviewBg|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv9=true| The BG color of the overview version of the visual.
|_labelBg|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv10=true|
|_labelBg|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv10=true| The enabled field of the label BG.
|_labelText|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv11=true|
|_labelText|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv11=true| The enabled field of the label text.
}}
}}


== Behavior ==
== Usage ==


== Examples ==
== Examples ==
Line 29: Line 29:
[[Category:Components:Uncategorized{{#translation:}}|Proto Flux Node Visual]]
[[Category:Components:Uncategorized{{#translation:}}|Proto Flux Node Visual]]
[[Category:Components{{#translation:}}|Proto Flux Node Visual]]
[[Category:Components{{#translation:}}|Proto Flux Node Visual]]
[[Category:ComponentStubs]]

Latest revision as of 19:27, 30 July 2025

Component image 
File:ProtoFluxNodeVisualComponent.png
Proto Flux Node Visual component as seen in the Scene Inspector

The ProtoFluxNodeVisual component is used to manage the visuals and interaction with ProtoFlux nodes when they are unpacked.

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 direct RelayRef`1<ProtoFluxNode> The protoflux node this is a visual for.
IsSelected Bool Whether or not this node is selected.
IsHighlighted Bool Whether or not this node is highlighted.
_nodeHoverArea HoverArea The Hover interaction area for this visual.
_bgImage Image The background image for tye protoflux visual.
_inputsRoot Slot The root of the different slots for node inputs.
_outputsRoot Slot The root of the different slots for node outputs.
_referencesRoot Slot The slot for references to other nodes like arrows for protoflux variables/globals.
_overviewVisual field drive of Bool The field for enabling the overview alt version of this node.
_overviewBg field drive of ColorX The BG color of the overview version of the visual.
_labelBg field drive of Bool The enabled field of the label BG.
_labelText field drive of Bool The enabled field of the label text.

Usage

Examples

See Also