ItemTextureThumbnailSource (Component)

From Neos Wiki
Revision as of 16:57, 25 January 2022 by Psychpsyo (talk | contribs) (Wrote the entire article.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


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


Texture Thumbnail Source component as seen in the Scene Inspector

The ItemTextureThumbnailSource component can be used to customize the inventory preview of an item, setting it to a texture.

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
Texture IAssetProvider<Texture2D> The texture that should be used as the item's inventory preview. If null, the component will be ignored.
Crop Nullable<Rect> The rectangle that defines what section of the image to use. (Or null to use the entire image)

Usage

To work, the component just needs to be attached to any slot in the object's hierarchy and have an image in its Texture.

Examples

This component can be used when the automatically generated preview for an item isn't satisfying enough or you want to ensure that the preview looks the same every time or shows the item off in a certain way.

An example of an item that uses this is the Clear Logix button in the Essential Tools folder.

Related Issues

#677 - TextureThumbnailSource component prevents the saving of an object if the Crop parameter is invalid

#761 - TextureThumbnailSource Doesn't work on curtain items.

#949 - When you have more than one Texture Thumbnail Source component in slot hierarchy, it ignores all of them.

Related Components