Filled in this component page. |
this is not a stub |
||
| (One intermediate revision by one other user not shown) | |||
| Line 13: | Line 13: | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Sprite|{{RootFieldType|AssetRef`1|[[Type:Sprite|Sprite]]}}|TypeAdv0=true|The sprite to render | |Sprite|{{RootFieldType|AssetRef`1|[[Type:Sprite|Sprite]]}}|TypeAdv0=true|The sprite to render | ||
|Material|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv1=true|The material to render with | |Material|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv1=true|The material to render with. is not required. | ||
|PreserveAspect|Bool|Preserves the aspect ratio of this image provided. | |PreserveAspect|Bool|Preserves the aspect ratio of this image provided. | ||
|NineSliceSizing|NineSliceSizing|Tells how the image gets 9-sliced on this UIX. | |NineSliceSizing|NineSliceSizing|Tells how the image gets 9-sliced on this UIX. | ||
| Line 26: | Line 26: | ||
<!--T:4--> | <!--T:4--> | ||
== Usage == | == Usage == | ||
A user can use this to just display an image with an optional tint color, or have this as a background image for other images to be on top of. | A user can use this to just display an image with an optional tint color, or have this as a background image for other images to be on top of. | ||
<!--T:5--> | <!--T:5--> | ||
== Examples == | == Examples == | ||
Here is [[User:ProbablePrime|ProbablePrime]]'s tutorial on images: | |||
<youtube>FUUSjTwhvHk</youtube> | |||
<!--T:6--> | <!--T:6--> | ||
| Line 36: | Line 38: | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Image]] | [[Category:Components{{#translation:}}|Image]] | ||
[[Category:Components:UIX:Graphics{{#translation:}}|Image]] | [[Category:Components:UIX:Graphics{{#translation:}}|Image]] | ||
Latest revision as of 16:47, 23 October 2024
Component image 
Image component as seen in the Scene Inspector
The Image component takes in a SpriteProvider or Material and renders it onto the UIX. This can be used to display graphics and produce backgrounds.
| 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 render |
Material
|
Material | The material to render with. is not required. |
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. |
FlipVertically
|
Bool | Flips the image vertically. |
InteractionTarget
|
Bool | Makes this image as the interaction target for this UIX. |
FillRect
|
Rect | The filling rect for this image. |
__legacyZWrite
|
Bool | Internal - The legacy Z writing for this image. |
Tint
|
ColorX | A color that is multiplied with the material's color. |
Usage
A user can use this to just display an image with an optional tint color, or have this as a background image for other images to be on top of.
Examples
Here is ProbablePrime's tutorial on images: