imported>Chemicalcrux Creating the page (with a bot!) |
not a component stub |
||
(3 intermediate revisions by 3 users not shown) | |||
Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=NestedCanvasComponent.png | |Image=NestedCanvasComponent.png | ||
Line 9: | Line 8: | ||
<!--T:2--> | <!--T:2--> | ||
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--> | <!--T:3--> | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|TargetCanvas|Canvas| | |TargetCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv0=true|The target canvas to nest as | ||
|_renderOffset|Int| | |_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|Int| | |_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--> | <!--T:4--> | ||
== | == 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--> | <!--T:5--> | ||
Line 27: | Line 26: | ||
<!--T:6--> | <!--T:6--> | ||
== Related Components == | == Related Components == | ||
This needs a [[Component:Canvas|Canvas]] component to work. | |||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}| | [[Category:Components{{#translation:}}|Nested Canvas]] | ||
[[Category:Components:UIX{{#translation:}}|Nested Canvas]] | |||
[[Category:Components:UIX{{#translation:}}| |
Latest revision as of 21:10, 28 October 2024
Component image
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.
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.