Component:NestedCanvas

From Resonite Wiki
Revision as of 21:38, 20 July 2024 by AmasterAmaster (talk | contribs) (Filling in details about the Nested Canvas component page.)
Component image 
NestedCanvas component as seen in the Scene Inspector


The Nested Canvas component takes in a target Canvas to nest as, and then it drives the values to the StartingOffset, StartingMaskDepth, and sets the BoxCollider Offset and Size, for consistency with the main canvas this component is under.

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.
TargetCanvas Canvas The target canvas to nest as
_renderOffset field drive of Int The render offset reference from the target canvas to be applied to the new nested canvas
_maskDepth field drive of Int The mask depth reference from the target canvas to be applied to the new nested canvas

Usage

This component is used mainly for consistency with other canvas components, no matter where in the world hierarchy. It does not need to be on the same canvas or panel to work.

Examples

Related Components

This needs a Canvas component to work.