diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index d1524074fde..4a567981e62 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -119,6 +119,7 @@ + Draw a polyline with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing. @@ -133,6 +134,7 @@ + Draw a polyline with a uniform [code]width[/code], segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. @@ -177,7 +179,7 @@ - Set a custom transform for drawing. Anything drawn afterwards will be transformed by this. + Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. @@ -186,6 +188,7 @@ + Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. @@ -359,6 +362,7 @@ + Returns [code]true[/code] if local transform notifications are communicated to children. @@ -372,12 +376,14 @@ + Returns [code]true[/code] if global transform notifications are communicated to children. + Returns [code]true[/code] if the node is in the [SceneTree] and is visible on-screen. @@ -386,6 +392,7 @@ + Assigns [code]screen_point[/code] as this node's new local transform. @@ -394,6 +401,7 @@ + Transformations issued by [code]event[/code]'s inputs are applied in local space instead of global space. @@ -402,7 +410,7 @@ - Set as top level. This means that it will not inherit transform from parent canvas items. + Sets as top level. This means that it will not inherit transform from parent canvas items. @@ -411,6 +419,7 @@ + If [code]enable[/code] is [code]true[/code], children will be updated with local transform data. @@ -419,6 +428,7 @@ + If [code]enable[/code] is [code]true[/code], children will be updated with global transform data. @@ -438,20 +448,28 @@ + The rendering layers in which this [code]CanvasItem[/code] responds to [Light2D] nodes. Default value: [code]1[/code]. + The material applied to textures on this [code]CanvasItem[/code]. Default value: [code]null[/code]. + The color applied to textures on this [code]CanvasItem[/code]. Default value: [code]Color(1, 1, 1, 1)[/code] (opaque "white"). + The color applied to textures on this [code]CanvasItem[/code]. This is not inherited by children [code]CanvasItem[/code]s. Default value: [code]Color(1, 1, 1, 1)[/code] (opaque "white").. + If [code]true[/code] the object draws behind its parent. Default value: [code]false[/code]. + If [code]true[/code] the object draws on top of its parent. Default value: [code]true[/code]. + If [code]true[/code] the parent [code]CanvasItem[/code]'s [member material] property is used as this one's material. Default value: [code]false[/code]. + If [code]true[/code] this [code]CanvasItem[/code] is drawn. Default value: [code]true[/code]. diff --git a/doc/classes/CanvasItemMaterial.xml b/doc/classes/CanvasItemMaterial.xml index b30261d5bfd..81709227adb 100644 --- a/doc/classes/CanvasItemMaterial.xml +++ b/doc/classes/CanvasItemMaterial.xml @@ -1,8 +1,10 @@ + A material for [CanvasItem]s. + [code]CanvasItemMaterial[/code]s provide a means of modifying the textures associated with a CanvasItem. They specialize in describing blend and lighting behaviors for textures. Use a [ShaderMaterial] to more fully customize a material's interactions with a [CanvasItem]. @@ -12,26 +14,36 @@ + The manner in which a material's rendering is applied to underlying textures. + The manner in which material reacts to lighting. + Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value. + Additive blending mode. + Subtractive blending mode. + Multiplicative blending mode. + Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. + Render the material using both light and non-light sensitive material properties. + Render the material as if there were no light. + Render the material as if there were only light. diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index 86b788bb44d..01c2dd6ba9d 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -15,6 +15,7 @@ + Returns the [Viewport] used by the camera if it is not using the default viewport. @@ -44,6 +45,7 @@ + Assigns a custom [Viewport] node to the [code]CanvasLayer[/code]. If [code]viewport[/code] is not a [Viewport], it re-assigns the default viewport instead. diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index 37e85d033b3..b4d4d0b4482 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -35,6 +35,7 @@ + Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required. diff --git a/doc/classes/CollisionObject.xml b/doc/classes/CollisionObject.xml index 82f65b6d113..5d0984bcdf7 100644 --- a/doc/classes/CollisionObject.xml +++ b/doc/classes/CollisionObject.xml @@ -25,6 +25,7 @@ + Accepts unhandled [InputEvent]s. [code]click_position[/code] is the clicked location in world space and [code]click_normal[/code] is the normal vector extending from the clicked surface of the [Shape] at [code]shape_idx[/code]. Connect to the [code]input_event[/code] signal to easily pick up these events. @@ -134,6 +135,7 @@ + Returns the child index of the [Shape] with the given id from the given shape owner. @@ -181,8 +183,10 @@ + If [code]true[/code] the [code]CollisionObject[/code] will continue to receive input events as the mouse is dragged across its shapes. Default value: [code]false[/code]. + If [code]true[/code] the [CollisionObject]'s shapes will respond to [RayCast]s. Default value: [code]true[/code]. @@ -198,6 +202,7 @@ + Emitted when [method _input_event] receives an event. See its description for details. diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index ffc79d359de..086513cad5f 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -21,6 +21,7 @@ + Accepts unhandled [InputEvent]s. [code]shape_idx[/code] is the child index of the clicked [Shape2D]. Connect to the [code]input_event[/code] signal to easily pick up these events. @@ -61,6 +62,7 @@ + Returns [code]true[/code] if collisions for the shape owner originating from this [code]CollisionObject2D[/code] will not be reported to collided with [code]CollisionObject2D[/code]s. @@ -138,6 +140,7 @@ + Returns the child index of the [Shape2D] with the given id from the given shape owner. @@ -179,6 +182,7 @@ + If [code]enable[/code] is [code]true[/code], collisions for the shape owner originating from this [code]CollisionObject2D[/code] will not be reported to collided with [code]CollisionObject2D[/code]s. @@ -207,7 +211,7 @@ - Emitted when an input event occurs and [code]input_pickable[/code] is [code]true[/code]. + Emitted when an input event occurs and [code]input_pickable[/code] is [code]true[/code]. See [method _input_event] for details.