diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2017-09-17 12:05:48 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-17 12:05:48 +0200 |
| commit | 356af7d2a5f195867b41e2428ad7130c08472c2c (patch) | |
| tree | 675f0bf99d1589325ee64bfd3d22d311430906e6 | |
| parent | 6dd8dd935e1c018a5515932cb418a9066cd5a895 (diff) | |
| parent | e1e9dde4f3c756964334051f7eefd18679091d90 (diff) | |
Merge pull request #11345 from cbscribe/kcc_canvaslayer_doc
[DOCS] CanvasLayer member descriptions
[ci skip]
| -rw-r--r-- | doc/classes/CanvasLayer.xml | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index f19e7ef041..3ee1f10536 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="CanvasLayer" inherits="Node" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Canvas Item layer. + Canvas drawing layer. </brief_description> <description> - Canvas Item 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). + 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> </tutorials> @@ -131,12 +131,16 @@ </methods> <members> <member name="layer" type="int" setter="set_layer" getter="get_layer"> + Layer index for draw order. Lower values are drawn first. Default value: [code]1[/code]. </member> <member name="offset" type="Vector2" setter="set_offset" getter="get_offset"> + The layer's base offset. </member> <member name="rotation" type="float" setter="set_rotationd" getter="get_rotationd"> + The layer's rotation in degrees. </member> <member name="scale" type="Vector2" setter="set_scale" getter="get_scale"> + The layer's scale. </member> </members> <constants> |