Component:NestedCanvas: Difference between revisions

Revision as of 21:38, 20 July 2024

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. Some components stop their functionality when this field is disabled, but some don't.
`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.

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=NestedCanvasComponent.png
@@ Line 9: / Line 8: @@
 <!--T:2-->
-== Intoduction ==
+The '''Nested Canvas''' component takes in a target [[Component:Canvas|Canvas]] to nest as, and then it drives the values to the <code>StartingOffset</code>, <code>StartingMaskDepth</code>, and sets the [[Component:BoxCollider|BoxCollider]] <code>Offset</code> and <code>Size</code>, for consistency with the main canvas this component is under.
 <!--T:3-->
-== Usage ==
 {{Table ComponentFields
-|TargetCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv0=true|
+|TargetCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv0=true|The target canvas to nest as
-|_renderOffset|{{RootFieldType|FieldDrive`1|[[Type:Int|Int]]}}|TypeAdv1=true|
+|_renderOffset|{{RootFieldType|FieldDrive`1|[[Type:Int|Int]]}}|TypeAdv1=true|The render offset reference from the target canvas to be applied to the new nested canvas
-|_maskDepth|{{RootFieldType|FieldDrive`1|[[Type:Int|Int]]}}|TypeAdv2=true|
+|_maskDepth|{{RootFieldType|FieldDrive`1|[[Type:Int|Int]]}}|TypeAdv2=true|The mask depth reference from the target canvas to be applied to the new nested canvas
 }}
 <!--T:4-->
-== Behavior ==
+== 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.
 <!--T:5-->
@@ Line 27: / Line 26: @@
 <!--T:6-->
 == Related Components ==
+This needs a [[Component:Canvas|Canvas]] component to work.
 </translate>
 [[Category:Components{{#translation:}}|Nested Canvas]]
 [[Category:ComponentStubs]]
 [[Category:Components:UIX{{#translation:}}|Nested Canvas]]