Component:SessionCaptureThumbnailSource: Difference between revisions

From Resonite Wiki
Automated: update Fields
rework
Line 3: Line 3:
|Name=Session Capture Thumbnail Source
|Name=Session Capture Thumbnail Source
}}
}}
The '''SessionCaptureThumbnailSource''' 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.
 
The '''SessionCaptureThumbnailSource''' component sets the slot it is on as a source for capturing the [[session thumbnail]], or the preview image used for the currently active session.


== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Overlay|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv0=true|
|Overlay|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv0=true|An overlay image to superimpose over the normal session capture. This image must have an average alpha channel value under 25% or else it will not be applied.
}}
}}


== Usage ==
== Usage ==
see: [[World and Session Thumbnails#Customising Thumbnails]]


== Examples ==
Place this component on a slot. The slot's position will then be used as the capture source for the [[session thumbnail]]. If multiple slots have this component on it, the slot with the lowest average user distance from it will be selected.
{{stub}}
 
== See also ==


== See Also ==
* [[Component:WorldCaptureThumbnailSource]] for capturing the world preview that shows up without an active session.
* [[Component:WorldCaptureThumbnailSource]] for capturing the world preview that shows up before creating a world instance in the world browser.


[[Category:Components{{#translation:}}|Session Capture Thumbnail Source]]
[[Category:Components{{#translation:}}|Session Capture Thumbnail Source]]
[[Category:Components:World{{#translation:}}|Session Capture Thumbnail Source]]
[[Category:Components:World{{#translation:}}|Session Capture Thumbnail Source]]

Revision as of 01:32, 14 June 2025

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

The SessionCaptureThumbnailSource component sets the slot it is on as a source for capturing the session thumbnail, or the preview image used for the currently active session.

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 An overlay image to superimpose over the normal session capture. This image must have an average alpha channel value under 25% or else it will not be applied.

Usage

Place this component on a slot. The slot's position will then be used as the capture source for the session thumbnail. If multiple slots have this component on it, the slot with the lowest average user distance from it will be selected.

See also