Component:ColorMemberEditor: Difference between revisions

Latest revision as of 22:52, 18 March 2025

Component image

**Color Member Editor** component as seen in the Scene Inspector

The ColorMemberEditor component is used in inspectors and Ref Hacking to edit Color Fields and their elements.

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.
`Continuous`	Bool	Whether updates to the target are continuous.
`_path`	String	Usually "r" "g" "b" "a" to edit parts of the color value.
`_target`	direct RelayRef`1<IField>	The color to edit.
`Labels`	Bool	Whether to show field labels.
`Vertical`	Bool	Whether the inspector showing this component is showing it in a vertical fashion.
`_colorDrive`	field drive of ColorX	The field to drive with the color value for the inspector visual.
`_colorDriveNoAlpha`	field drive of ColorX	The field to drive with the color target with no alpha applied for the inspector visual.
`_colorDialog`	direct SlotCleanupRef`1<ColorDialogInterface>	The color dialogue currently being used to edit the color.

Sync Delegates

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
`OpenColorPicker:ButtonEventHandler`	ButtonEventHandler	✓	Handles opening and spawning the user's favorite color picker for editing the color via a picker.

Usage

Internal.

Examples

Used in the Scene Inspector where colors are on Components so the user can edit the colors.

@@ Line 3: / Line 3: @@
 |Name=Color Member Editor
 }}
-{{stub}}
+The '''ColorMemberEditor''' component is used in inspectors and [[Ref Hacking]] to edit Color Fields and their elements.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|Continuous|Bool|
+|Continuous|Bool| Whether updates to the target are continuous.
-|_path|String|
+|_path|String| Usually "r" "g" "b" "a" to edit parts of the color value.
-|_target|{{RootFieldType|RelayRef`1|[[Type:IField|IField]]}}|TypeAdv2=true|
+|_target|{{RootFieldType|RelayRef`1|[[Type:IField|IField]]}}|TypeAdv2=true| The color to edit.
-|Labels|Bool|
+|Labels|Bool| Whether to show field labels.
-|Vertical|Bool|
+|Vertical|Bool| Whether the inspector showing this component is showing it in a vertical fashion.
-|_colorDrive|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv5=true|
+|_colorDrive|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv5=true| The field to drive with the color value for the inspector visual.
-|_colorDriveNoAlpha|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv6=true|
+|_colorDriveNoAlpha|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv6=true| The field to drive with the color target with no alpha applied for the inspector visual.
-|_colorDialog|{{RootFieldType|SlotCleanupRef`1|[[Component:ColorDialogInterface|ColorDialogInterface]]}}|TypeAdv7=true|
+|_colorDialog|{{RootFieldType|SlotCleanupRef`1|[[Component:ColorDialogInterface|ColorDialogInterface]]}}|TypeAdv7=true| The color dialogue currently being used to edit the color.
+}}
+== Sync Delegates ==
+{{Table ComponentTriggers
+|OpenColorPicker:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles opening and spawning the user's favorite color picker for editing the color via a picker.
 }}
-== Behavior ==
+== Usage ==
+Internal.
 == Examples ==
+Used in the [[Scene Inspector]] where colors are on Components so the user can edit the colors.
 == See Also ==
+* [[Scene Inspector]]
+* [[Type:Color]]
 [[Category:Components:Uncategorized{{#translation:}}|Color Member Editor]]
 [[Category:Components{{#translation:}}|Color Member Editor]]
-[[Category:ComponentStubs]]