Component:ColorDialogInterface: Difference between revisions

Latest revision as of 19:12, 5 January 2025

Component image

**Color Dialog Interface** component as seen in the Scene Inspector

The ColorDialogInterface component is generated by the game when a user interacts with choosing a color.

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.
`ItemName`	IField`1<String>	The name of this color dialogue
`SpawningUser`	UserRef	The user that spawned the dialouge
`SpawningUserID`	IField`1<String>	The field containing the User ID of the person that spawned the dialogue
`IsInstance`	Bool	Whether this dialogue was spawned by the game (true) or spawned from inventory (false)
`TargetColor`	SyncRef`1<IField`1<ColorX>>	The color this color editor is editing.
`Continuous`	IField`1<Bool>	Whether changes to the color should instantly update the target color.
`AllowAlpha`	IField`1<Bool>	Whether the color editor should allow transparency modification
`AllowHDR`	IField`1<Bool>	Whether this color editor should allow for making colors beyond 100%.

Usage

Attach to a slot or use an existing one by the game. Modifying this component and its hiearchy and its slots allow for making a custom version. To make it your default, follow the page on Favorites.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

@@ Line 3: / Line 3: @@
 |Name=Color Dialog Interface
 }}
-{{stub}}
+The '''ColorDialogInterface''' component is generated by the game when a user interacts with choosing a color.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|ItemName|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv0=true|
+|ItemName|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv0=true| The name of this color dialogue
-|SpawningUser|UserRef|
+|SpawningUser|UserRef| The user that spawned the dialouge
-|SpawningUserID|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv2=true|
+|SpawningUserID|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv2=true| The field containing the User ID of the person that spawned the dialogue
-|IsInstance|Bool|
+|IsInstance|Bool| Whether this dialogue was spawned by the game (true) or spawned from inventory (false)
-|TargetColor|'''[[Type:SyncRef`1|SyncRef`1]]&lt;[[Type:IField`1|IField`1]]&lt;[[Type:ColorX|ColorX]]&gt;&gt;'''|TypeAdv4=true|
+|TargetColor|'''[[Type:SyncRef`1|SyncRef`1]]&lt;[[Type:IField`1|IField`1]]&lt;[[Type:ColorX|ColorX]]&gt;&gt;'''|TypeAdv4=true| The color this color editor is editing.
-|Continuous|'''[[Type:IField`1|IField`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv5=true|
+|Continuous|'''[[Type:IField`1|IField`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv5=true| Whether changes to the color should instantly update the target color.
-|AllowAlpha|'''[[Type:IField`1|IField`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv6=true|
+|AllowAlpha|'''[[Type:IField`1|IField`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv6=true| Whether the color editor should allow transparency modification
-|AllowHDR|'''[[Type:IField`1|IField`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv7=true|
+|AllowHDR|'''[[Type:IField`1|IField`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv7=true| Whether this color editor should allow for making colors beyond 100%.
 }}
-== Behavior ==
+== Usage ==
+Attach to a slot or use an existing one by the game. Modifying this component and its hiearchy and its slots allow for making a custom version. To make it your default, follow the page on [[Favorites]].
 == Examples ==
+{{stub}}
 == See Also ==
+{{Template:EntityInterface SeeAlso}}
 [[Category:Components:Utility:Entity Interfaces{{#translation:}}|Color Dialog Interface]]
 [[Category:Components{{#translation:}}|Color Dialog Interface]]
-[[Category:ComponentStubs]]