Component:ButtonEditColorX: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
This is no longer a stub. Added a description, added a usage description. Added field descriptions.
 
Line 3: Line 3:
|Name=Button Edit Color X
|Name=Button Edit Color X
}}
}}
{{stub}}


== Usage ==
The '''ButtonEditColorX''' component takes in a [[Type:ColorX|ColorX]] and a [[Component:ColorDialogInterface|ColorDialogInterface]] component, and when a button interacts with it, the color is presumed to be edited. However, currently, if this component is under the button being pressed, it removes the button, making the [[Slot|slot]] useless. (TODO: Figure out what is going on with this component.)
 
{{Table ComponentFields
{{Table ComponentFields
|Target|'''[[Type:IField`1|IField`1]]<[[Type:ColorX|ColorX]]>'''|TypeAdv0=true|
|Target|'''[[Type:IField`1|IField`1]]<[[Type:ColorX|ColorX]]>'''|TypeAdv0=true| The target [[Type:ColorX|ColorX]].
|_colorPicker|{{RootFieldType|SlotCleanupRef`1|[[Component:ColorDialogInterface|ColorDialogInterface]]}}|TypeAdv1=true|
|_colorPicker|{{RootFieldType|SlotCleanupRef`1|[[Component:ColorDialogInterface|ColorDialogInterface]]}}|TypeAdv1=true|The [[Component:ColorDialogInterface|ColorDialogInterface]] component.
|Continuous|Bool|
|Continuous|Bool|Makes the color editing change continuous.
|Alpha|Bool|
|Alpha|Bool|Allows for use of the alpha channel.
|HDR|Bool|
|HDR|Bool|Allows the use for HDR in this color.
}}
}}


== Behavior ==
== Usage ==
This is used to edit colors with a press of a button.


== Examples ==
== Examples ==
Line 22: Line 23:
[[Category:Components:Common UI:Button Interactions{{#translation:}}|Button Edit Color X]]
[[Category:Components:Common UI:Button Interactions{{#translation:}}|Button Edit Color X]]
[[Category:Components{{#translation:}}|Button Edit Color X]]
[[Category:Components{{#translation:}}|Button Edit Color X]]
[[Category:ComponentStubs]]

Latest revision as of 21:25, 11 September 2024

Component image 
Button Edit Color X component as seen in the Scene Inspector


The ButtonEditColorX component takes in a ColorX and a ColorDialogInterface component, and when a button interacts with it, the color is presumed to be edited. However, currently, if this component is under the button being pressed, it removes the button, making the slot useless. (TODO: Figure out what is going on with this 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.
Target IField`1<ColorX> The target ColorX.
_colorPicker direct SlotCleanupRef`1<ColorDialogInterface> The ColorDialogInterface component.
Continuous Bool Makes the color editing change continuous.
Alpha Bool Allows for use of the alpha channel.
HDR Bool Allows the use for HDR in this color.

Usage

This is used to edit colors with a press of a button.

Examples

See Also