Component:WorldCaptureThumbnailSource: Difference between revisions

From Resonite Wiki
Automated: update Fields
add info
 
Line 7: Line 7:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Overlay|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv0=true|
|Overlay|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv0=true| The texture to use as an overlay for capturing the thumbnail.
|ExcludeUsersInCapture|Bool|
|ExcludeUsersInCapture|Bool| Whether to exclude users from the thumbnail.
}}
}}



Latest revision as of 00:24, 4 May 2025

Component image 
File:WorldCaptureThumbnailSourceComponent.png
World Capture Thumbnail Source component as seen in the Scene Inspector

The WorldCaptureThumbnailSource component is used as a point in space to capture the preview of a world in the world browser minus users in the session when a world is saved.

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.
Overlay Texture2D The texture to use as an overlay for capturing the thumbnail.
ExcludeUsersInCapture Bool Whether to exclude users from the thumbnail.

Usage

see: World and Session Thumbnails#Customising Thumbnails

Examples

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

See Also