Component:GradientImage: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
Filled in the page for the GradiantImage component.
 
Line 3: Line 3:
|Name=Gradient Image
|Name=Gradient Image
}}
}}
{{stub}}


== Usage ==
The '''GradiantImage''' component takes in a [[Component:SpriteProvider|SpriteProvider]] or [[Material]] and controls the image color using the four corners of the image, then gradients them into the image.
 
{{Table ComponentFields
{{Table ComponentFields
|Sprite|{{RootFieldType|AssetRef`1|[[Type:Sprite|Sprite]]}}|TypeAdv0=true|
|Sprite|{{RootFieldType|AssetRef`1|[[Type:Sprite|Sprite]]}}|TypeAdv0=true|The sprite to use as the image.
|Material|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv1=true|
|Material|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv1=true|The Material to use as the image.
|PreserveAspect|Bool|
|PreserveAspect|Bool|Preserves the aspect ratio of this image provided.
|NineSliceSizing|NineSliceSizing|
|NineSliceSizing|NineSliceSizing|Tells how the image gets 9-sliced on this UIX.
|FlipHorizontally|Bool|
|FlipHorizontally|Bool|Flips the image horizontally (but not the color).
|FlipVertically|Bool|
|FlipVertically|Bool|Flips the image vertically (but not the color).
|InteractionTarget|Bool|
|InteractionTarget|Bool|Makes this image as the interaction target for this UIX.
|FillRect|Rect|
|FillRect|Rect|The filling rect for this image.
|__legacyZWrite|Bool|
|__legacyZWrite|Bool|The legacy Z writing for this image.
|TintTopLeft|ColorX|
|TintTopLeft|ColorX|The color of this top left corner.
|TintTopRight|ColorX|
|TintTopRight|ColorX|The color of this top right corner.
|TintBottomRight|ColorX|
|TintBottomRight|ColorX|The color of this bottom right corner.
|TintBottomLeft|ColorX|
|TintBottomLeft|ColorX|The color of this bottom left corner.
}}
}}


== Behavior ==
== Usage ==
 
You can make fancy effects and icons using this component, especially if your hue shifting the different color corners.


== Examples ==
== Examples ==
Line 30: Line 32:
[[Category:Components:UIX:Graphics{{#translation:}}|Gradient Image]]
[[Category:Components:UIX:Graphics{{#translation:}}|Gradient Image]]
[[Category:Components{{#translation:}}|Gradient Image]]
[[Category:Components{{#translation:}}|Gradient Image]]
[[Category:ComponentStubs]]

Latest revision as of 03:20, 21 July 2024

Component image 
Gradient Image component as seen in the Scene Inspector


The GradiantImage component takes in a SpriteProvider or Material and controls the image color using the four corners of the image, then gradients them into the image.

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.
Sprite Sprite The sprite to use as the image.
Material Material The Material to use as the image.
PreserveAspect Bool Preserves the aspect ratio of this image provided.
NineSliceSizing NineSliceSizing Tells how the image gets 9-sliced on this UIX.
FlipHorizontally Bool Flips the image horizontally (but not the color).
FlipVertically Bool Flips the image vertically (but not the color).
InteractionTarget Bool Makes this image as the interaction target for this UIX.
FillRect Rect The filling rect for this image.
__legacyZWrite Bool The legacy Z writing for this image.
TintTopLeft ColorX The color of this top left corner.
TintTopRight ColorX The color of this top right corner.
TintBottomRight ColorX The color of this bottom right corner.
TintBottomLeft ColorX The color of this bottom left corner.

Usage

You can make fancy effects and icons using this component, especially if your hue shifting the different color corners.

Examples

See Also