diff options
Diffstat (limited to 'doc/classes/CanvasLayer.xml')
| -rw-r--r-- | doc/classes/CanvasLayer.xml | 29 |
1 files changed, 26 insertions, 3 deletions
diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index 2f99f94893..ff2c3a8855 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CanvasLayer" inherits="Node" version="4.0"> +<class name="CanvasLayer" inherits="Node" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Canvas drawing layer. </brief_description> @@ -7,8 +7,8 @@ Canvas drawing layer. [CanvasItem] nodes that are direct or indirect children of a [CanvasLayer] will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [CanvasLayer] with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). </description> <tutorials> - <link title="Viewport and canvas transforms">https://docs.godotengine.org/en/latest/tutorials/2d/2d_transforms.html</link> - <link title="Canvas layers">https://docs.godotengine.org/en/latest/tutorials/2d/canvas_layers.html</link> + <link title="Viewport and canvas transforms">$DOCS_URL/tutorials/2d/2d_transforms.html</link> + <link title="Canvas layers">$DOCS_URL/tutorials/2d/canvas_layers.html</link> <link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link> </tutorials> <methods> @@ -18,6 +18,18 @@ Returns the RID of the canvas used by this layer. </description> </method> + <method name="hide"> + <return type="void" /> + <description> + Hides any [CanvasItem] under this [CanvasLayer]. This is equivalent to setting [member visible] to [code]false[/code]. + </description> + </method> + <method name="show"> + <return type="void" /> + <description> + Shows any [CanvasItem] under this [CanvasLayer]. This is equivalent to setting [member visible] to [code]true[/code]. + </description> + </method> </methods> <members> <member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport"> @@ -44,5 +56,16 @@ <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform" default="Transform2D(1, 0, 0, 1, 0, 0)"> The layer's transform. </member> + <member name="visible" type="bool" setter="set_visible" getter="is_visible" default="true"> + If [code]false[/code], any [CanvasItem] under this [CanvasLayer] will be hidden. + Unlike [member CanvasItem.visible], visibility of a [CanvasLayer] isn't propagated to underlying layers. + </member> </members> + <signals> + <signal name="visibility_changed"> + <description> + Emitted when visibility of the layer is changed. See [member visible]. + </description> + </signal> + </signals> </class> |