Component:Canvas: Difference between revisions

Revision as of 21:36, 3 March 2024

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

Component image

A Canvas is the starting point for anything based on UIX. It provides the bounds of the UI and controls how users can interact with it.

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.
`Size`	Float2	The dimensions of the canvas. At normal scale, this is equivalent to meters.
`EditModeOnly`	Bool	FIXME
`AcceptRemoteTouch`	Bool	Makes the canvas accepts laser touches
`AcceptPhysicalTouch`	Bool	Makes the canvas accepts direct touches
`AcceptExistingTouch`	Bool	FIXME
`HighPriorityIntegration`	Bool	FIXME
`IgnoreTouchesFromBehind`	Bool	Makes the canvas ignore all touches from behind
`BlockAllInteractions`	Bool	Prevents any interaction if enabled
`LaserPassThrough`	Bool	Allows the laser to go through the canvas
`PixelScale`	Float	FIXME
`UnitScale`	Float
`_rootRect`	RectTransform	Internal
`Collider`	BoxCollider	The collider that receives touches
`DefaultCulling`	Culling
`_colliderSize`	field drive of Float3	Internal
`_colliderOffset`	field drive of Float3	Internal
`StartingOffset`	Int	FIXME
`StartingMaskDepth`	Int	FIXME

@@ Line 18: / Line 18: @@
 |Size|Float2|The dimensions of the canvas. At normal scale, this is equivalent to meters.
 |EditModeOnly|Bool|FIXME
 |AcceptRemoteTouch|Bool|Makes the canvas accepts laser touches
 |AcceptPhysicalTouch|Bool|Makes the canvas accepts direct touches
 |AcceptExistingTouch|Bool|FIXME
@@ Line 26: / Line 26: @@
 |LaserPassThrough|Bool|Allows the laser to go through the canvas
 |PixelScale|Float|FIXME
-|_rootRect|RectTransform|Internal
+|UnitScale|Float|
-|Collider|BoxCollider|The collider that receives touches
+|_rootRect|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv11=true|Internal
-|_colliderSize|Float3|Internal
+|Collider|'''[[Component:BoxCollider|BoxCollider]]'''|TypeAdv12=true|The collider that receives touches
-|_colliderOffset|Float3|Internal
+|DefaultCulling|Culling|
+|_colliderSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv14=true|Internal
+|_colliderOffset|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv15=true|Internal
 |StartingOffset|Int|FIXME
 |StartingMaskDepth|Int|FIXME
@@ Line 43: / Line 45: @@
 == Related Components ==
 </translate>
-[[Category:Components{{#translation:}}|Canvas (Component){{#translation:}}]]
+[[Category:Components{{#translation:}}|Canvas]]
 [[Category:ComponentStubs]]
-[[Category:Components:UIX{{#translation:}}|Canvas (Component){{#translation:}}]]
+[[Category:Components:UIX{{#translation:}}|Canvas]]