maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc: Sync classref with current source + fixup some bindings

Browse source 
Includes various changes triggered by the refactoring of method bindings.
This commit is contained in:
Rémi Verschelde 2020-11-04 15:38:26 +01:00
parent 89f605c717
commit 424cd00f8b
No known key found for this signature in database
GPG key ID: C3336907360768E1
56 changed files with 579 additions and 574 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
core/math/rect2.h
View file

@ -367,8 +367,8 @@ struct Rect2i {
new_rect.position.x = MAX(p_rect.position.x, position.x);
new_rect.position.y = MAX(p_rect.position.y, position.y);
Point2 p_rect_end = p_rect.position + p_rect.size;
Point2 end = position + size;
Point2i p_rect_end = p_rect.position + p_rect.size;
Point2i end = position + size;
new_rect.size.x = (int)(MIN(p_rect_end.x, end.x) - new_rect.position.x);
new_rect.size.y = (int)(MIN(p_rect_end.y, end.y) - new_rect.position.y);
@ -390,7 +390,7 @@ struct Rect2i {
return new_rect;
}
bool has_point(const Point2 &p_point) const {
bool has_point(const Point2i &p_point) const {
if (p_point.x < position.x) {
return false;
}
@ -485,10 +485,10 @@ struct Rect2i {
size(p_r2.size) {
}
Rect2i(int p_x, int p_y, int p_width, int p_height) :
position(Point2(p_x, p_y)),
size(Size2(p_width, p_height)) {
position(Point2i(p_x, p_y)),
size(Size2i(p_width, p_height)) {
}
Rect2i(const Point2 &p_pos, const Size2 &p_size) :
Rect2i(const Point2i &p_pos, const Size2i &p_size) :
position(p_pos),
size(p_size) {
}

40
core/variant_call.cpp
View file

@ -1357,7 +1357,7 @@ void register_variant_methods() {
_VariantCall::construct_funcs = memnew_arr(_VariantCall::ConstructFunc, Variant::VARIANT_MAX);
_VariantCall::constant_data = memnew_arr(_VariantCall::ConstantData, Variant::VARIANT_MAX);
/* STRING */
/* String */
bind_method(String, casecmp_to, sarray("to"), varray());
bind_method(String, nocasecmp_to, sarray("to"), varray());
@ -1405,7 +1405,7 @@ void register_variant_methods() {
bind_method(String, plus_file, sarray("file"), varray());
bind_method(String, ord_at, sarray("at"), varray());
bind_method(String, dedent, sarray(), varray());
//string needs to be immutable when binding
// FIXME: String needs to be immutable when binding
//bind_method(String, erase, sarray("position", "chars"), varray());
bind_method(String, hash, sarray(), varray());
bind_method(String, md5_text, sarray(), varray());
@ -1415,7 +1415,7 @@ void register_variant_methods() {
bind_method(String, sha1_buffer, sarray(), varray());
bind_method(String, sha256_buffer, sarray(), varray());
bind_method(String, empty, sarray(), varray());
//static function, not sure how to bind
// FIXME: Static function, not sure how to bind
//bind_method(String, humanize_size, sarray("size"), varray());
bind_method(String, is_abs_path, sarray(), varray());
@ -1457,7 +1457,7 @@ void register_variant_methods() {
bind_method(String, to_utf16_buffer, sarray(), varray());
bind_method(String, to_utf32_buffer, sarray(), varray());
/* VECTOR2 */
/* Vector2 */
bind_method(Vector2, angle, sarray(), varray());
bind_method(Vector2, angle_to, sarray("to"), varray());
@ -1490,15 +1490,16 @@ void register_variant_methods() {
bind_method(Vector2, cross, sarray("with"), varray());
bind_method(Vector2, abs, sarray(), varray());
bind_method(Vector2, sign, sarray(), varray());
bind_method(Vector2, snapped, sarray("by"), varray());
bind_method(Vector2, clamped, sarray("length"), varray());
/* VECTOR2I */
/* Vector2i */
bind_method(Vector2i, aspect, sarray(), varray());
bind_method(Vector2i, sign, sarray(), varray());
bind_method(Vector2i, abs, sarray(), varray());
/* RECT2 */
/* Rect2 */
bind_method(Rect2, get_area, sarray(), varray());
bind_method(Rect2, has_no_area, sarray(), varray());
@ -1585,7 +1586,7 @@ void register_variant_methods() {
bind_methodv(intersects_ray, &Plane::intersects_ray_bind, sarray("from", "dir"), varray());
bind_methodv(intersects_segment, &Plane::intersects_segment_bind, sarray("from", "to"), varray());
/* Quaternion */
/* Quat */
bind_method(Quat, length, sarray(), varray());
bind_method(Quat, length_squared, sarray(), varray());
@ -1594,13 +1595,12 @@ void register_variant_methods() {
bind_method(Quat, is_equal_approx, sarray("to"), varray());
bind_method(Quat, inverse, sarray(), varray());
bind_method(Quat, dot, sarray("with"), varray());
bind_method(Quat, xform, sarray("v3"), varray());
bind_method(Quat, slerp, sarray("b", "t"), varray());
bind_method(Quat, slerpni, sarray("b", "t"), varray());
bind_method(Quat, cubic_slerp, sarray("b", "pre_a", "post_b", "t"), varray());
bind_method(Quat, get_euler, sarray(), varray());
//Quat is atomic, this should be done via construcror
// FIXME: Quat is atomic, this should be done via construcror
//ADDFUNC1(QUAT, NIL, Quat, set_euler, VECTOR3, "euler", varray());
//ADDFUNC2(QUAT, NIL, Quat, set_axis_angle, VECTOR3, "axis", FLOAT, "angle", varray());
@ -1621,7 +1621,7 @@ void register_variant_methods() {
bind_method(Color, to_html, sarray("with_alpha"), varray(true));
bind_method(Color, blend, sarray("over"), varray());
//Color is immutable, need to probably find a way to do this via constructor
// FIXME: Color is immutable, need to probably find a way to do this via constructor
//ADDFUNC4R(COLOR, COLOR, Color, from_hsv, FLOAT, "h", FLOAT, "s", FLOAT, "v", FLOAT, "a", varray(1.0));
bind_method(Color, is_equal_approx, sarray("to"), varray());
@ -1651,8 +1651,6 @@ void register_variant_methods() {
bind_method(Callable, hash, sarray(), varray());
bind_method(Callable, unbind, sarray("argcount"), varray());
//#define bind_custom(m_type, m_name, m_method, m_flags, m_arg_types, m_ret_type, m_arg_names) _VariantCall::_bind_custom(m_type, m_name, m_method, m_flags, m_arg_types, m_ret_type)
bind_custom(Variant::CALLABLE, "call", _VariantCall::func_Callable_call, Variant::InternalMethod::FLAG_VARARGS | Variant::InternalMethod::FLAG_RETURNS_VARIANT, Vector<Variant::Type>(), Variant::NIL, sarray());
bind_custom(Variant::CALLABLE, "call_deferred", _VariantCall::func_Callable_call_deferred, Variant::InternalMethod::FLAG_VARARGS, Vector<Variant::Type>(), Variant::NIL, sarray());
bind_custom(Variant::CALLABLE, "bind", _VariantCall::func_Callable_bind, Variant::InternalMethod::FLAG_VARARGS, Vector<Variant::Type>(), Variant::CALLABLE, sarray());
@ -1682,9 +1680,6 @@ void register_variant_methods() {
bind_method(Transform2D, rotated, sarray("phi"), varray());
bind_method(Transform2D, scaled, sarray("scale"), varray());
bind_method(Transform2D, translated, sarray("offset"), varray());
//too complex to bind this, operator * should be used instead
//ADDFUNC1R(TRANSFORM2D, NIL, Transform2D, xform, NIL, "v", varray());
//ADDFUNC1R(TRANSFORM2D, NIL, Transform2D, xform_inv, NIL, "v", varray());
bind_method(Transform2D, basis_xform, sarray("v"), varray());
bind_method(Transform2D, basis_xform_inv, sarray("v"), varray());
bind_method(Transform2D, interpolate_with, sarray("xform", "t"), varray());
@ -1703,9 +1698,6 @@ void register_variant_methods() {
bind_method(Basis, tdotx, sarray("with"), varray());
bind_method(Basis, tdoty, sarray("with"), varray());
bind_method(Basis, tdotz, sarray("with"), varray());
//use the operators instead
//ADDFUNC1R(BASIS, VECTOR3, Basis, xform, VECTOR3, "v", varray());
//ADDFUNC1R(BASIS, VECTOR3, Basis, xform_inv, VECTOR3, "v", varray());
bind_method(Basis, get_orthogonal_index, sarray(), varray());
bind_method(Basis, slerp, sarray("b", "t"), varray());
bind_method(Basis, is_equal_approx, sarray("b"), varray());
@ -1748,9 +1740,6 @@ void register_variant_methods() {
bind_method(Transform, looking_at, sarray("target", "up"), varray());
bind_method(Transform, interpolate_with, sarray("xform", "weight"), varray());
bind_method(Transform, is_equal_approx, sarray("xform"), varray());
//use the operators instead
//ADDFUNC1R(TRANSFORM, NIL, Transform, xform, NIL, "v", varray());
//ADDFUNC1R(TRANSFORM, NIL, Transform, xform_inv, NIL, "v", varray());
/* Dictionary */
@ -1923,6 +1912,7 @@ void register_variant_methods() {
bind_method(PackedVector2Array, invert, sarray(), varray());
bind_method(PackedVector2Array, subarray, sarray("from", "to"), varray());
bind_method(PackedVector2Array, to_byte_array, sarray(), varray());
bind_method(PackedVector2Array, sort, sarray(), varray());
/* Vector3 Array */
@ -1939,6 +1929,7 @@ void register_variant_methods() {
bind_method(PackedVector3Array, invert, sarray(), varray());
bind_method(PackedVector3Array, subarray, sarray("from", "to"), varray());
bind_method(PackedVector3Array, to_byte_array, sarray(), varray());
bind_method(PackedVector3Array, sort, sarray(), varray());
/* Color Array */
@ -1955,8 +1946,9 @@ void register_variant_methods() {
bind_method(PackedColorArray, invert, sarray(), varray());
bind_method(PackedColorArray, subarray, sarray("from", "to"), varray());
bind_method(PackedColorArray, to_byte_array, sarray(), varray());
bind_method(PackedColorArray, sort, sarray(), varray());
/* REGISTER CONSTRUCTORS */
/* Register constructors */
_VariantCall::add_constructor(_VariantCall::Vector2_init1, Variant::VECTOR2, "x", Variant::FLOAT, "y", Variant::FLOAT);
_VariantCall::add_constructor(_VariantCall::Vector2i_init1, Variant::VECTOR2I, "x", Variant::INT, "y", Variant::INT);
@ -1964,7 +1956,7 @@ void register_variant_methods() {
_VariantCall::add_constructor(_VariantCall::Rect2_init1, Variant::RECT2, "position", Variant::VECTOR2, "size", Variant::VECTOR2);
_VariantCall::add_constructor(_VariantCall::Rect2_init2, Variant::RECT2, "x", Variant::FLOAT, "y", Variant::FLOAT, "width", Variant::FLOAT, "height", Variant::FLOAT);
_VariantCall::add_constructor(_VariantCall::Rect2i_init1, Variant::RECT2I, "position", Variant::VECTOR2, "size", Variant::VECTOR2);
_VariantCall::add_constructor(_VariantCall::Rect2i_init1, Variant::RECT2I, "position", Variant::VECTOR2I, "size", Variant::VECTOR2I);
_VariantCall::add_constructor(_VariantCall::Rect2i_init2, Variant::RECT2I, "x", Variant::INT, "y", Variant::INT, "width", Variant::INT, "height", Variant::INT);
_VariantCall::add_constructor(_VariantCall::Transform2D_init2, Variant::TRANSFORM2D, "rotation", Variant::FLOAT, "position", Variant::VECTOR2);
@ -1997,7 +1989,7 @@ void register_variant_methods() {
_VariantCall::add_constructor(_VariantCall::Callable_init2, Variant::CALLABLE, "object", Variant::OBJECT, "method_name", Variant::STRING_NAME);
_VariantCall::add_constructor(_VariantCall::Signal_init2, Variant::SIGNAL, "object", Variant::OBJECT, "signal_name", Variant::STRING_NAME);
/* REGISTER CONSTANTS */
/* Register constants */
_populate_named_colors();
for (Map<String, Color>::Element *color = _named_colors.front(); color; color = color->next()) {

12
doc/classes/AABB.xml
View file

@ -176,8 +176,18 @@
Returns [code]true[/code] if the [AABB] is on both sides of a plane.
</description>
</method>
<method name="intersects_ray">
<return type="Variant">
</return>
<argument index="0" name="from" type="Vector3">
</argument>
<argument index="1" name="dir" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="intersects_segment">
<return type="bool">
<return type="Variant">
</return>
<argument index="0" name="from" type="Vector3">
</argument>

6
doc/classes/AnimatedSprite2D.xml
View file

@ -63,12 +63,6 @@
<member name="playing" type="bool" setter="_set_playing" getter="_is_playing" default="false">
If [code]true[/code], the [member animation] is currently playing.
</member>
<member name="shininess" type="float" setter="set_shininess" getter="get_shininess" default="1.0">
Strength of the specular light effect of this [AnimatedSprite2D].
</member>
<member name="specular_color" type="Color" setter="set_specular_color" getter="get_specular_color" default="Color( 1, 1, 1, 1 )">
The color of the specular light effect.
</member>
<member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale" default="1.0">
The animation speed is multiplied by this value.
</member>

6
doc/classes/Array.xml
View file

@ -160,7 +160,7 @@
</argument>
<argument index="1" name="obj" type="Object">
</argument>
<argument index="2" name="func" type="String">
<argument index="2" name="func" type="StringName">
</argument>
<argument index="3" name="before" type="bool" default="true">
</argument>
@ -362,7 +362,7 @@
</description>
</method>
<method name="resize">
<return type="void">
<return type="int">
</return>
<argument index="0" name="size" type="int">
</argument>
@ -433,7 +433,7 @@
</return>
<argument index="0" name="obj" type="Object">
</argument>
<argument index="1" name="func" type="String">
<argument index="1" name="func" type="StringName">
</argument>
<description>
Sorts the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return either [code]true[/code] or [code]false[/code].

19
doc/classes/Basis.xml
View file

@ -187,25 +187,6 @@
Returns the transposed version of the matrix.
</description>
</method>
<method name="xform">
<return type="Vector3">
</return>
<argument index="0" name="v" type="Vector3">
</argument>
<description>
Returns a vector transformed (multiplied) by the matrix.
</description>
</method>
<method name="xform_inv">
<return type="Vector3">
</return>
<argument index="0" name="v" type="Vector3">
</argument>
<description>
Returns a vector transformed (multiplied) by the transposed basis matrix.
[b]Note:[/b] This results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection.
</description>
</method>
</methods>
<members>
<member name="x" type="Vector3" setter="" getter="" default="Vector3( 1, 0, 0 )">

4
doc/classes/CPUParticles2D.xml
View file

@ -238,10 +238,6 @@
<member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates" default="true">
If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates.
</member>
<member name="normalmap" type="Texture2D" setter="set_normalmap" getter="get_normalmap">
Normal map to be used for the [member texture] property.
[b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.
</member>
<member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot" default="false">
If [code]true[/code], only one emission cycle occurs. If set [code]true[/code] during a cycle, emission will stop at the cycle's end.
</member>

2
doc/classes/Callable.xml
View file

@ -48,7 +48,7 @@
</description>
</method>
<method name="bind" qualifiers="vararg">
<return type="void">
<return type="Callable">
</return>
<description>
</description>

21
doc/classes/CanvasGroup.xml Normal file
View file

@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CanvasGroup" inherits="Node2D" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="clear_margin" type="float" setter="set_clear_margin" getter="get_clear_margin" default="10.0">
</member>
<member name="fit_margin" type="float" setter="set_fit_margin" getter="get_fit_margin" default="10.0">
</member>
<member name="use_mipmaps" type="bool" setter="set_use_mipmaps" getter="is_using_mipmaps" default="false">
</member>
</members>
<constants>
</constants>
</class>

88
doc/classes/CanvasItem.xml
View file

@ -86,16 +86,6 @@
</argument>
<argument index="3" name="texture" type="Texture2D" default="null">
</argument>
<argument index="4" name="normal_map" type="Texture2D" default="null">
</argument>
<argument index="5" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="6" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="7" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
<argument index="8" name="texture_repeat" type="int" enum="CanvasItem.TextureRepeat" default="0">
</argument>
<description>
Draws a colored polygon of any amount of points, convex or concave.
</description>
@ -122,19 +112,9 @@
</argument>
<argument index="1" name="texture" type="Texture2D">
</argument>
<argument index="2" name="normal_map" type="Texture2D" default="null">
<argument index="2" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )">
</argument>
<argument index="3" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="4" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="5" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )">
</argument>
<argument index="6" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="7" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
<argument index="8" name="texture_repeat" type="int" enum="CanvasItem.TextureRepeat" default="0">
<argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<description>
Draws a [Mesh] in 2D, using the provided texture. See [MeshInstance2D] for related documentation.
@ -173,16 +153,6 @@
</argument>
<argument index="1" name="texture" type="Texture2D">
</argument>
<argument index="2" name="normal_map" type="Texture2D" default="null">
</argument>
<argument index="3" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="4" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="5" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
<argument index="6" name="texture_repeat" type="int" enum="CanvasItem.TextureRepeat" default="0">
</argument>
<description>
Draws a [MultiMesh] in 2D with the provided texture. See [MultiMeshInstance2D] for related documentation.
</description>
@ -198,16 +168,6 @@
</argument>
<argument index="3" name="texture" type="Texture2D" default="null">
</argument>
<argument index="4" name="normal_map" type="Texture2D" default="null">
</argument>
<argument index="5" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="6" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="7" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
<argument index="8" name="texture_repeat" type="int" enum="CanvasItem.TextureRepeat" default="0">
</argument>
<description>
Draws a polygon of any amount of points, convex or concave.
</description>
@ -251,16 +211,6 @@
</argument>
<argument index="4" name="width" type="float" default="1.0">
</argument>
<argument index="5" name="normal_map" type="Texture2D" default="null">
</argument>
<argument index="6" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="7" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="8" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
<argument index="9" name="texture_repeat" type="int" enum="CanvasItem.TextureRepeat" default="0">
</argument>
<description>
Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle, and 4 points for a quad.
</description>
@ -358,16 +308,6 @@
</argument>
<argument index="2" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="3" name="normal_map" type="Texture2D" default="null">
</argument>
<argument index="4" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="5" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="6" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
<argument index="7" name="texture_repeat" type="int" enum="CanvasItem.TextureRepeat" default="0">
</argument>
<description>
Draws a texture at a given position.
</description>
@ -385,16 +325,6 @@
</argument>
<argument index="4" name="transpose" type="bool" default="false">
</argument>
<argument index="5" name="normal_map" type="Texture2D" default="null">
</argument>
<argument index="6" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="7" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="8" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
<argument index="9" name="texture_repeat" type="int" enum="CanvasItem.TextureRepeat" default="0">
</argument>
<description>
Draws a textured rectangle at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped.
</description>
@ -412,17 +342,7 @@
</argument>
<argument index="4" name="transpose" type="bool" default="false">
</argument>
<argument index="5" name="normal_map" type="Texture2D" default="null">
</argument>
<argument index="6" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="7" name="specular_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="8" name="clip_uv" type="bool" default="true">
</argument>
<argument index="9" name="texture_filter" type="int" enum="CanvasItem.TextureFilter" default="0">
</argument>
<argument index="10" name="texture_repeat" type="int" enum="CanvasItem.TextureRepeat" default="0">
<argument index="5" name="clip_uv" type="bool" default="true">
</argument>
<description>
Draws a textured rectangle region at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped.
@ -592,6 +512,8 @@
</method>
</methods>
<members>
<member name="clip_children" type="bool" setter="set_clip_children" getter="is_clipping_children" default="false">
</member>
<member name="light_mask" type="int" setter="set_light_mask" getter="get_light_mask" default="1">
The rendering layers in which this [CanvasItem] responds to [Light2D] nodes.
</member>

29
doc/classes/CanvasTexture.xml Normal file
View file

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CanvasTexture" inherits="Texture2D" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="diffuse_texture" type="Texture2D" setter="set_diffuse_texture" getter="get_diffuse_texture">
</member>
<member name="normal_texture" type="Texture2D" setter="set_normal_texture" getter="get_normal_texture">
</member>
<member name="specular_color" type="Color" setter="set_specular_color" getter="get_specular_color" default="Color( 1, 1, 1, 1 )">
</member>
<member name="specular_shininess" type="float" setter="set_specular_shininess" getter="get_specular_shininess" default="1.0">
</member>
<member name="specular_texture" type="Texture2D" setter="set_specular_texture" getter="get_specular_texture">
</member>
<member name="texture_filter" type="int" setter="set_texture_filter" getter="get_texture_filter" enum="CanvasItem.TextureFilter" default="0">
</member>
<member name="texture_repeat" type="int" setter="set_texture_repeat" getter="get_texture_repeat" enum="CanvasItem.TextureRepeat" default="0">
</member>
</members>
<constants>
</constants>
</class>

25
doc/classes/Color.xml
View file

@ -195,29 +195,6 @@
[/codeblocks]
</description>
</method>
<method name="from_hsv">
<return type="Color">
</return>
<argument index="0" name="h" type="float">
</argument>
<argument index="1" name="s" type="float">
</argument>
<argument index="2" name="v" type="float">
</argument>
<argument index="3" name="a" type="float" default="1.0">
</argument>
<description>
Constructs a color from an HSV profile. [code]h[/code], [code]s[/code], and [code]v[/code] are values between 0 and 1.
[codeblocks]
[gdscript]
var color = Color.from_hsv(0.58, 0.5, 0.79, 0.8) # Equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8)
[/gdscript]
[csharp]
Color color = Color.FromHsv(0.58f, 0.5f, 0.79f, 0.8f); // Equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8)
[/csharp]
[/codeblocks]
</description>
</method>
<method name="inverted">
<return type="Color">
</return>
@ -238,7 +215,7 @@
<method name="is_equal_approx">
<return type="bool">
</return>
<argument index="0" name="color" type="Color">
<argument index="0" name="to" type="Color">
</argument>
<description>
Returns [code]true[/code] if this color and [code]color[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.

2
doc/classes/ColorRect.xml
View file

@ -12,7 +12,7 @@
<methods>
</methods>
<members>
<member name="color" type="Color" setter="set_frame_color" getter="get_frame_color" default="Color( 1, 1, 1, 1 )">
<member name="color" type="Color" setter="set_color" getter="get_color" default="Color( 1, 1, 1, 1 )">
The fill color.
[codeblocks]
[gdscript]

20
doc/classes/DirectionalLight2D.xml Normal file
View file

@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="DirectionalLight2D" inherits="Light2D" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="height" type="float" setter="set_height" getter="get_height" default="0.0">
The height of the light. Used with 2D normal mapping.
</member>
<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="10000.0">
</member>
</members>
<constants>
</constants>
</class>

2
doc/classes/EditorPlugin.xml
View file

@ -379,7 +379,7 @@
Remember that you have to manage the visibility of all your editor controls manually.
</description>
</method>
<method name="queue_save_layout" qualifiers="const">
<method name="queue_save_layout">
<return type="void">
</return>
<description>

4
doc/classes/GPUParticles2D.xml
View file

@ -52,10 +52,6 @@
<member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates" default="true">
If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates.
</member>
<member name="normal_map" type="Texture2D" setter="set_normal_map" getter="get_normal_map">
Normal map to be used for the [member texture] property.
[b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.
</member>
<member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot" default="false">
If [code]true[/code], only one emission cycle occurs. If set [code]true[/code] during a cycle, emission will stop at the cycle's end.
</member>

4
doc/classes/Geometry2D.xml
View file

@ -200,11 +200,11 @@
Inflates or deflates [code]polygon[/code] by [code]delta[/code] units (pixels). If [code]delta[/code] is positive, makes the polygon grow outward. If [code]delta[/code] is negative, shrinks the polygon inward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. Returns an empty array if [code]delta[/code] is negative and the absolute value of it approximately exceeds the minimum bounding rectangle dimensions of the polygon.
Each polygon's vertices will be rounded as determined by [code]join_type[/code], see [enum PolyJoinType].
The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise].
[b]Note:[/b] To translate the polygon's vertices specifically, use the [method Transform2D.xform] method:
[b]Note:[/b] To translate the polygon's vertices specifically, multiply them to a [Transform2D]:
[codeblock]
var polygon = PackedVector2Array([Vector2(0, 0), Vector2(100, 0), Vector2(100, 100), Vector2(0, 100)])
var offset = Vector2(50, 50)
polygon = Transform2D(0, offset).xform(polygon)
polygon = Transform2D(0, offset) * polygon
print(polygon) # prints [Vector2(50, 50), Vector2(150, 50), Vector2(150, 150), Vector2(50, 150)]
[/codeblock]
</description>

56
doc/classes/Light2D.xml
View file

@ -11,8 +11,25 @@
<link title="2D lights and shadows">https://docs.godotengine.org/en/latest/tutorials/2d/2d_lights_and_shadows.html</link>
</tutorials>
<methods>
<method name="get_height" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_height">
<return type="void">
</return>
<argument index="0" name="height" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="Light2D.BlendMode" default="0">
The Light2D's blend mode. See [enum BlendMode] constants for values.
</member>
<member name="color" type="Color" setter="set_color" getter="get_color" default="Color( 1, 1, 1, 1 )">
The Light2D's [Color].
</member>
@ -25,15 +42,6 @@
<member name="energy" type="float" setter="set_energy" getter="get_energy" default="1.0">
The Light2D's energy value. The larger the value, the stronger the light.
</member>
<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="Light2D.Mode" default="0">
The Light2D's mode. See [enum Mode] constants for values.
</member>
<member name="offset" type="Vector2" setter="set_texture_offset" getter="get_texture_offset" default="Vector2( 0, 0 )">
The offset of the Light2D's [code]texture[/code].
</member>
<member name="range_height" type="float" setter="set_height" getter="get_height" default="0.0">
The height of the Light2D. Used with 2D normal mapping.
</member>
<member name="range_item_cull_mask" type="int" setter="set_item_cull_mask" getter="get_item_cull_mask" default="1">
The layer mask. Only objects with a matching mask will be affected by the Light2D.
</member>
@ -49,9 +57,6 @@
<member name="range_z_min" type="int" setter="set_z_range_min" getter="get_z_range_min" default="-1024">
Minimum [code]z[/code] value of objects that are affected by the Light2D.
</member>
<member name="shadow_buffer_size" type="int" setter="set_shadow_buffer_size" getter="get_shadow_buffer_size" default="2048">
Shadow buffer size.
</member>
<member name="shadow_color" type="Color" setter="set_shadow_color" getter="get_shadow_color" default="Color( 0, 0, 0, 0 )">
[Color] of shadows cast by the Light2D.
</member>
@ -67,26 +72,8 @@
<member name="shadow_item_cull_mask" type="int" setter="set_item_shadow_cull_mask" getter="get_item_shadow_cull_mask" default="1">
The shadow mask. Used with [LightOccluder2D] to cast shadows. Only occluders with a matching light mask will cast shadows.
</member>
<member name="texture" type="Texture2D" setter="set_texture" getter="get_texture">
[Texture2D] used for the Light2D's appearance.
</member>
<member name="texture_scale" type="float" setter="set_texture_scale" getter="get_texture_scale" default="1.0">
The [code]texture[/code]'s scale factor.
</member>
</members>
<constants>
<constant name="MODE_ADD" value="0" enum="Mode">
Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behavior of a light.
</constant>
<constant name="MODE_SUB" value="1" enum="Mode">
Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect.
</constant>
<constant name="MODE_MIX" value="2" enum="Mode">
Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation.
</constant>
<constant name="MODE_MASK" value="3" enum="Mode">
The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture.
</constant>
<constant name="SHADOW_FILTER_NONE" value="0" enum="ShadowFilter">
No filter applies to the shadow map. See [member shadow_filter].
</constant>
@ -96,5 +83,14 @@
<constant name="SHADOW_FILTER_PCF13" value="2" enum="ShadowFilter">
Percentage closer filtering (13 samples) applies to the shadow map. See [member shadow_filter].
</constant>
<constant name="BLEND_MODE_ADD" value="0" enum="BlendMode">
Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behavior of a light.
</constant>
<constant name="BLEND_MODE_SUB" value="1" enum="BlendMode">
Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect.
</constant>
<constant name="BLEND_MODE_MIX" value="2" enum="BlendMode">
Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation.
</constant>
</constants>
</class>

1
doc/classes/LinkButton.xml
View file

@ -12,7 +12,6 @@
<methods>
</methods>
<members>
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="0" />
<member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" override="true" enum="Control.CursorShape" default="2" />
<member name="text" type="String" setter="set_text" getter="get_text" default="&quot;&quot;">
The button's text that will be displayed inside the button's area.

1
doc/classes/MenuButton.xml
View file

@ -31,7 +31,6 @@
<members>
<member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" override="true" enum="BaseButton.ActionMode" default="0" />
<member name="flat" type="bool" setter="set_flat" getter="is_flat" override="true" default="true" />
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="0" />
<member name="switch_on_hover" type="bool" setter="set_switch_on_hover" getter="is_switch_on_hover" default="false">
If [code]true[/code], when the cursor hovers above another [MenuButton] within the same parent which also has [code]switch_on_hover[/code] enabled, it will close the current [MenuButton] and open the other one.
</member>

6
doc/classes/NodePath.xml
View file

@ -65,7 +65,7 @@
</description>
</method>
<method name="get_concatenated_subnames">
<return type="String">
<return type="StringName">
</return>
<description>
Returns all subnames concatenated with a colon character ([code]:[/code]) as separator, i.e. the right side of the first colon in a node path.
@ -76,7 +76,7 @@
</description>
</method>
<method name="get_name">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -99,7 +99,7 @@
</description>
</method>
<method name="get_subname">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="idx" type="int">
</argument>

22
doc/classes/PackedByteArray.xml
View file

@ -20,9 +20,9 @@
</description>
</method>
<method name="append">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="byte" type="int">
<argument index="0" name="value" type="int">
</argument>
<description>
Appends an element at the end of the array (alias of [method push_back]).
@ -128,9 +128,9 @@
<method name="insert">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="at_index" type="int">
</argument>
<argument index="1" name="byte" type="int">
<argument index="1" name="value" type="int">
</argument>
<description>
Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]).
@ -144,9 +144,9 @@
</description>
</method>
<method name="push_back">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="byte" type="int">
<argument index="0" name="value" type="int">
</argument>
<description>
Appends an element at the end of the array.
@ -155,16 +155,16 @@
<method name="remove">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<description>
Removes an element from the array by index.
</description>
</method>
<method name="resize">
<return type="void">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="new_size" type="int">
</argument>
<description>
Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.
@ -173,9 +173,9 @@
<method name="set">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="byte" type="int">
<argument index="1" name="value" type="int">
</argument>
<description>
Changes the byte at the given index.

38
doc/classes/PackedColorArray.xml
View file

@ -20,9 +20,9 @@
</description>
</method>
<method name="append">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="color" type="Color">
<argument index="0" name="value" type="Color">
</argument>
<description>
Appends an element at the end of the array (alias of [method push_back]).
@ -56,9 +56,9 @@
<method name="insert">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="at_index" type="int">
</argument>
<argument index="1" name="color" type="Color">
<argument index="1" name="value" type="Color">
</argument>
<description>
Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]).
@ -72,9 +72,9 @@
</description>
</method>
<method name="push_back">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="color" type="Color">
<argument index="0" name="value" type="Color">
</argument>
<description>
Appends a value to the array.
@ -83,16 +83,16 @@
<method name="remove">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<description>
Removes an element from the array by index.
</description>
</method>
<method name="resize">
<return type="void">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="new_size" type="int">
</argument>
<description>
Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.
@ -101,9 +101,9 @@
<method name="set">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="color" type="Color">
<argument index="1" name="value" type="Color">
</argument>
<description>
Changes the [Color] at the given index.
@ -123,6 +123,22 @@
Sorts the elements of the array in ascending order.
</description>
</method>
<method name="subarray">
<return type="PackedColorArray">
</return>
<argument index="0" name="from" type="int">
</argument>
<argument index="1" name="to" type="int">
</argument>
<description>
</description>
</method>
<method name="to_byte_array">
<return type="PackedByteArray">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>

30
doc/classes/PackedFloat32Array.xml
View file

@ -21,7 +21,7 @@
</description>
</method>
<method name="append">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="value" type="float">
</argument>
@ -57,7 +57,7 @@
<method name="insert">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="at_index" type="int">
</argument>
<argument index="1" name="value" type="float">
</argument>
@ -73,7 +73,7 @@
</description>
</method>
<method name="push_back">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="value" type="float">
</argument>
@ -84,16 +84,16 @@
<method name="remove">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<description>
Removes an element from the array by index.
</description>
</method>
<method name="resize">
<return type="void">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="new_size" type="int">
</argument>
<description>
Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.
@ -102,7 +102,7 @@
<method name="set">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="value" type="float">
</argument>
@ -124,6 +124,22 @@
Sorts the elements of the array in ascending order.
</description>
</method>
<method name="subarray">
<return type="PackedFloat32Array">
</return>
<argument index="0" name="from" type="int">
</argument>
<argument index="1" name="to" type="int">
</argument>
<description>
</description>
</method>
<method name="to_byte_array">
<return type="PackedByteArray">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>

30
doc/classes/PackedFloat64Array.xml
View file

@ -21,7 +21,7 @@
</description>
</method>
<method name="append">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="value" type="float">
</argument>
@ -57,7 +57,7 @@
<method name="insert">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="at_index" type="int">
</argument>
<argument index="1" name="value" type="float">
</argument>
@ -73,7 +73,7 @@
</description>
</method>
<method name="push_back">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="value" type="float">
</argument>
@ -84,16 +84,16 @@
<method name="remove">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<description>
Removes an element from the array by index.
</description>
</method>
<method name="resize">
<return type="void">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="new_size" type="int">
</argument>
<description>
Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.
@ -102,7 +102,7 @@
<method name="set">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="value" type="float">
</argument>
@ -124,6 +124,22 @@
Sorts the elements of the array in ascending order.
</description>
</method>
<method name="subarray">
<return type="PackedFloat64Array">
</return>
<argument index="0" name="from" type="int">
</argument>
<argument index="1" name="to" type="int">
</argument>
<description>
</description>
</method>
<method name="to_byte_array">
<return type="PackedByteArray">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>

38
doc/classes/PackedInt32Array.xml
View file

@ -21,9 +21,9 @@
</description>
</method>
<method name="append">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="integer" type="int">
<argument index="0" name="value" type="int">
</argument>
<description>
Appends an element at the end of the array (alias of [method push_back]).
@ -57,9 +57,9 @@
<method name="insert">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="at_index" type="int">
</argument>
<argument index="1" name="integer" type="int">
<argument index="1" name="value" type="int">
</argument>
<description>
Inserts a new integer at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]).
@ -73,9 +73,9 @@
</description>
</method>
<method name="push_back">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="integer" type="int">
<argument index="0" name="value" type="int">
</argument>
<description>
Appends a value to the array.
@ -84,16 +84,16 @@
<method name="remove">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<description>
Removes an element from the array by index.
</description>
</method>
<method name="resize">
<return type="void">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="new_size" type="int">
</argument>
<description>
Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.
@ -102,9 +102,9 @@
<method name="set">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="integer" type="int">
<argument index="1" name="value" type="int">
</argument>
<description>
Changes the integer at the given index.
@ -124,6 +124,22 @@
Sorts the elements of the array in ascending order.
</description>
</method>
<method name="subarray">
<return type="PackedInt32Array">
</return>
<argument index="0" name="from" type="int">
</argument>
<argument index="1" name="to" type="int">
</argument>
<description>
</description>
</method>
<method name="to_byte_array">
<return type="PackedByteArray">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>

38
doc/classes/PackedInt64Array.xml
View file

@ -21,9 +21,9 @@
</description>
</method>
<method name="append">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="integer" type="int">
<argument index="0" name="value" type="int">
</argument>
<description>
Appends an element at the end of the array (alias of [method push_back]).
@ -57,9 +57,9 @@
<method name="insert">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="at_index" type="int">
</argument>
<argument index="1" name="integer" type="int">
<argument index="1" name="value" type="int">
</argument>
<description>
Inserts a new integer at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]).
@ -73,9 +73,9 @@
</description>
</method>
<method name="push_back">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="integer" type="int">
<argument index="0" name="value" type="int">
</argument>
<description>
Appends a value to the array.
@ -84,16 +84,16 @@
<method name="remove">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<description>
Removes an element from the array by index.
</description>
</method>
<method name="resize">
<return type="void">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="new_size" type="int">
</argument>
<description>
Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.
@ -102,9 +102,9 @@
<method name="set">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="integer" type="int">
<argument index="1" name="value" type="int">
</argument>
<description>
Changes the integer at the given index.
@ -124,6 +124,22 @@
Sorts the elements of the array in ascending order.
</description>
</method>
<method name="subarray">
<return type="PackedInt64Array">
</return>
<argument index="0" name="from" type="int">
</argument>
<argument index="1" name="to" type="int">
</argument>
<description>
</description>
</method>
<method name="to_byte_array">
<return type="PackedByteArray">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>

38
doc/classes/PackedStringArray.xml
View file

@ -21,9 +21,9 @@
</description>
</method>
<method name="append">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="string" type="String">
<argument index="0" name="value" type="String">
</argument>
<description>
Appends an element at the end of the array (alias of [method push_back]).
@ -57,9 +57,9 @@
<method name="insert">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="at_index" type="int">
</argument>
<argument index="1" name="string" type="String">
<argument index="1" name="value" type="String">
</argument>
<description>
Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]).
@ -73,9 +73,9 @@
</description>
</method>
<method name="push_back">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="string" type="String">
<argument index="0" name="value" type="String">
</argument>
<description>
Appends a string element at end of the array.
@ -84,16 +84,16 @@
<method name="remove">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<description>
Removes an element from the array by index.
</description>
</method>
<method name="resize">
<return type="void">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="new_size" type="int">
</argument>
<description>
Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.
@ -102,9 +102,9 @@
<method name="set">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="string" type="String">
<argument index="1" name="value" type="String">
</argument>
<description>
Changes the [String] at the given index.
@ -124,6 +124,22 @@
Sorts the elements of the array in ascending order.
</description>
</method>
<method name="subarray">
<return type="PackedStringArray">
</return>
<argument index="0" name="from" type="int">
</argument>
<argument index="1" name="to" type="int">
</argument>
<description>
</description>
</method>
<method name="to_byte_array">
<return type="PackedByteArray">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>

38
doc/classes/PackedVector2Array.xml
View file

@ -21,9 +21,9 @@
</description>
</method>
<method name="append">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="vector2" type="Vector2">
<argument index="0" name="value" type="Vector2">
</argument>
<description>
Appends an element at the end of the array (alias of [method push_back]).
@ -57,9 +57,9 @@
<method name="insert">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="at_index" type="int">
</argument>
<argument index="1" name="vector2" type="Vector2">
<argument index="1" name="value" type="Vector2">
</argument>
<description>
Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]).
@ -73,9 +73,9 @@
</description>
</method>
<method name="push_back">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="vector2" type="Vector2">
<argument index="0" name="value" type="Vector2">
</argument>
<description>
Inserts a [Vector2] at the end.
@ -84,16 +84,16 @@
<method name="remove">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<description>
Removes an element from the array by index.
</description>
</method>
<method name="resize">
<return type="void">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="new_size" type="int">
</argument>
<description>
Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.
@ -102,9 +102,9 @@
<method name="set">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="vector2" type="Vector2">
<argument index="1" name="value" type="Vector2">
</argument>
<description>
Changes the [Vector2] at the given index.
@ -124,6 +124,22 @@
Sorts the elements of the array in ascending order.
</description>
</method>
<method name="subarray">
<return type="PackedVector2Array">
</return>
<argument index="0" name="from" type="int">
</argument>
<argument index="1" name="to" type="int">
</argument>
<description>
</description>
</method>
<method name="to_byte_array">
<return type="PackedByteArray">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>

38
doc/classes/PackedVector3Array.xml
View file

@ -20,9 +20,9 @@
</description>
</method>
<method name="append">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="vector3" type="Vector3">
<argument index="0" name="value" type="Vector3">
</argument>
<description>
Appends an element at the end of the array (alias of [method push_back]).
@ -56,9 +56,9 @@
<method name="insert">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="at_index" type="int">
</argument>
<argument index="1" name="vector3" type="Vector3">
<argument index="1" name="value" type="Vector3">
</argument>
<description>
Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]).
@ -72,9 +72,9 @@
</description>
</method>
<method name="push_back">
<return type="void">
<return type="bool">
</return>
<argument index="0" name="vector3" type="Vector3">
<argument index="0" name="value" type="Vector3">
</argument>
<description>
Inserts a [Vector3] at the end.
@ -83,16 +83,16 @@
<method name="remove">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<description>
Removes an element from the array by index.
</description>
</method>
<method name="resize">
<return type="void">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="new_size" type="int">
</argument>
<description>
Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.
@ -101,9 +101,9 @@
<method name="set">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="vector3" type="Vector3">
<argument index="1" name="value" type="Vector3">
</argument>
<description>
Changes the [Vector3] at the given index.
@ -123,6 +123,22 @@
Sorts the elements of the array in ascending order.
</description>
</method>
<method name="subarray">
<return type="PackedVector3Array">
</return>
<argument index="0" name="from" type="int">
</argument>
<argument index="1" name="to" type="int">
</argument>
<description>
</description>
</method>
<method name="to_byte_array">
<return type="PackedByteArray">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>

14
doc/classes/Plane.xml
View file

@ -77,7 +77,7 @@
</description>
</method>
<method name="intersect_3">
<return type="Vector3">
<return type="Variant">
</return>
<argument index="0" name="b" type="Plane">
</argument>
@ -88,7 +88,7 @@
</description>
</method>
<method name="intersects_ray">
<return type="Vector3">
<return type="Variant">
</return>
<argument index="0" name="from" type="Vector3">
</argument>
@ -99,11 +99,11 @@
</description>
</method>
<method name="intersects_segment">
<return type="Vector3">
<return type="Variant">
</return>
<argument index="0" name="begin" type="Vector3">
<argument index="0" name="from" type="Vector3">
</argument>
<argument index="1" name="end" type="Vector3">
<argument index="1" name="to" type="Vector3">
</argument>
<description>
Returns the intersection point of a segment from position [code]begin[/code] to position [code]end[/code] with this plane. If no intersection is found, [code]null[/code] is returned.
@ -112,7 +112,7 @@
<method name="is_equal_approx">
<return type="bool">
</return>
<argument index="0" name="plane" type="Plane">
<argument index="0" name="to_plane" type="Plane">
</argument>
<description>
Returns [code]true[/code] if this plane and [code]plane[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
@ -121,7 +121,7 @@
<method name="is_point_over">
<return type="bool">
</return>
<argument index="0" name="point" type="Vector3">
<argument index="0" name="plane" type="Vector3">
</argument>
<description>
Returns [code]true[/code] if [code]point[/code] is located above the plane.

27
doc/classes/PointLight2D.xml Normal file
View file

@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PointLight2D" inherits="Light2D" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="height" type="float" setter="set_height" getter="get_height" default="0.0">
The height of the light. Used with 2D normal mapping.
</member>
<member name="offset" type="Vector2" setter="set_texture_offset" getter="get_texture_offset" default="Vector2( 0, 0 )">
The offset of the light's [member texture].
</member>
<member name="texture" type="Texture2D" setter="set_texture" getter="get_texture">
[Texture2D] used for the light's appearance.
</member>
<member name="texture_scale" type="float" setter="set_texture_scale" getter="get_texture_scale" default="1.0">
The [member texture]'s scale factor.
</member>
</members>
<constants>
</constants>
</class>

10
doc/classes/Polygon2D.xml
View file

@ -101,10 +101,6 @@
<member name="invert_enable" type="bool" setter="set_invert" getter="get_invert" default="false">
If [code]true[/code], polygon will be inverted, containing the area outside the defined points and extending to the [code]invert_border[/code].
</member>
<member name="normal_map" type="Texture2D" setter="set_normal_map" getter="get_normal_map">
The normal map gives depth to the Polygon2D.
[b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.
</member>
<member name="offset" type="Vector2" setter="set_offset" getter="get_offset" default="Vector2( 0, 0 )">
The offset applied to each vertex.
</member>
@ -114,14 +110,8 @@
</member>
<member name="polygons" type="Array" setter="set_polygons" getter="get_polygons" default="[ ]">
</member>
<member name="shininess" type="float" setter="set_shininess" getter="get_shininess" default="1.0">
</member>
<member name="skeleton" type="NodePath" setter="set_skeleton" getter="get_skeleton" default="NodePath(&quot;&quot;)">
</member>
<member name="specular_color" type="Color" setter="set_specular_color" getter="get_specular_color" default="Color( 1, 1, 1, 1 )">
</member>
<member name="specular_map" type="Texture2D" setter="set_specular_map" getter="get_specular_map">
</member>
<member name="texture" type="Texture2D" setter="set_texture" getter="get_texture">
The polygon's fill texture. Use [code]uv[/code] to set texture coordinates.
</member>

11
doc/classes/ProjectSettings.xml
View file

@ -818,6 +818,8 @@
<member name="logging/file_logging/max_log_files" type="int" setter="" getter="" default="5">
Specifies the maximum amount of log files allowed (used for rotation).
</member>
<member name="memory/limits/command_queue/multithreading_queue_size_kb" type="int" setter="" getter="" default="256">
</member>
<member name="memory/limits/message_queue/max_size_kb" type="int" setter="" getter="" default="4096">
Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here.
</member>
@ -1004,8 +1006,11 @@
</member>
<member name="rendering/limits/time/time_rollover_secs" type="float" setter="" getter="" default="3600">
</member>
<member name="rendering/quality/2d/use_pixel_snap" type="bool" setter="" getter="" default="false">
If [code]true[/code], forces snapping of polygons to pixels in 2D rendering. May help in some pixel art styles.
<member name="rendering/quality/2d/snap_2d_transforms_to_pixel" type="bool" setter="" getter="" default="false">
</member>
<member name="rendering/quality/2d/snap_2d_vertices_to_pixel" type="bool" setter="" getter="" default="false">
</member>
<member name="rendering/quality/2d_shadow_atlas/size" type="int" setter="" getter="" default="2048">
</member>
<member name="rendering/quality/depth_of_field/depth_of_field_bokeh_quality" type="int" setter="" getter="" default="2">
Sets the quality of the depth of field effect. Higher quality takes more samples, which is slower but looks smoother.
@ -1102,6 +1107,8 @@
</member>
<member name="rendering/quality/screen_filters/screen_space_roughness_limiter_limit" type="float" setter="" getter="" default="0.18">
</member>
<member name="rendering/quality/screen_filters/use_debanding" type="bool" setter="" getter="" default="false">
</member>
<member name="rendering/quality/screen_space_reflection/roughness_quality" type="int" setter="" getter="" default="1">
Sets the quality for rough screen-space reflections. Turning off will make all screen space reflections sharp, while higher values make rough reflections look better.
</member>

71
doc/classes/Quat.xml
View file

@ -16,19 +16,16 @@
<method name="Quat">
<return type="Quat">
</return>
<argument index="0" name="from" type="Basis">
<argument index="0" name="x" type="float">
</argument>
<argument index="1" name="y" type="float">
</argument>
<argument index="2" name="z" type="float">
</argument>
<argument index="3" name="w" type="float">
</argument>
<description>
Constructs a quaternion from the given [Basis].
</description>
</method>
<method name="Quat">
<return type="Quat">
</return>
<argument index="0" name="euler" type="Vector3">
</argument>
<description>
Constructs a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last), given in the vector format as (X angle, Y angle, Z angle).
Constructs a quaternion defined by the given values.
</description>
</method>
<method name="Quat">
@ -45,16 +42,19 @@
<method name="Quat">
<return type="Quat">
</return>
<argument index="0" name="x" type="float">
</argument>
<argument index="1" name="y" type="float">
</argument>
<argument index="2" name="z" type="float">
</argument>
<argument index="3" name="w" type="float">
<argument index="0" name="euler" type="Vector3">
</argument>
<description>
Constructs a quaternion defined by the given values.
Constructs a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last), given in the vector format as (X angle, Y angle, Z angle).
</description>
</method>
<method name="Quat">
<return type="Quat">
</return>
<argument index="0" name="from" type="Basis">
</argument>
<description>
Constructs a quaternion from the given [Basis].
</description>
</method>
<method name="cubic_slerp">
@ -75,7 +75,7 @@
<method name="dot">
<return type="float">
</return>
<argument index="0" name="b" type="Quat">
<argument index="0" name="with" type="Quat">
</argument>
<description>
Returns the dot product of two quaternions.
@ -98,7 +98,7 @@
<method name="is_equal_approx">
<return type="bool">
</return>
<argument index="0" name="quat" type="Quat">
<argument index="0" name="to" type="Quat">
</argument>
<description>
Returns [code]true[/code] if this quaterion and [code]quat[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
@ -132,26 +132,6 @@
Returns a copy of the quaternion, normalized to unit length.
</description>
</method>
<method name="set_axis_angle">
<return type="void">
</return>
<argument index="0" name="axis" type="Vector3">
</argument>
<argument index="1" name="angle" type="float">
</argument>
<description>
Sets the quaternion to a rotation which rotates around axis by the specified angle, in radians. The axis must be a normalized vector.
</description>
</method>
<method name="set_euler">
<return type="void">
</return>
<argument index="0" name="euler" type="Vector3">
</argument>
<description>
Sets the quaternion to a rotation specified by Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last), given in the vector format as (X angle, Y angle, Z angle).
</description>
</method>
<method name="slerp">
<return type="Quat">
</return>
@ -175,15 +155,6 @@
Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code], but without checking if the rotation path is not bigger than 90 degrees.
</description>
</method>
<method name="xform">
<return type="Vector3">
</return>
<argument index="0" name="v" type="Vector3">
</argument>
<description>
Returns a vector transformed (multiplied) by this quaternion.
</description>
</method>
</methods>
<members>
<member name="w" type="float" setter="" getter="" default="1.0">

2
doc/classes/Rect2.xml
View file

@ -108,7 +108,7 @@
</argument>
<argument index="2" name="right" type="float">
</argument>
<argument index="3" name=" bottom" type="float">
<argument index="3" name="bottom" type="float">
</argument>
<description>
Returns a copy of the [Rect2] grown a given amount of units towards each direction individually.

6
doc/classes/Rect2i.xml
View file

@ -15,9 +15,9 @@
<method name="Rect2i">
<return type="Rect2i">
</return>
<argument index="0" name="position" type="Vector2">
<argument index="0" name="position" type="Vector2i">
</argument>
<argument index="1" name="size" type="Vector2">
<argument index="1" name="size" type="Vector2i">
</argument>
<description>
Constructs a [Rect2i] by position and size.
@ -106,7 +106,7 @@
</argument>
<argument index="2" name="right" type="int">
</argument>
<argument index="3" name=" bottom" type="int">
<argument index="3" name="bottom" type="int">
</argument>
<description>
Returns a copy of the [Rect2i] grown a given amount of units towards each direction individually.

68
doc/classes/RenderingServer.xml
View file

@ -404,28 +404,6 @@
The mode of the light, see [enum CanvasLightMode] constants.
</description>
</method>
<method name="canvas_light_set_scale">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="scale" type="float">
</argument>
<description>
Sets the texture's scale factor of the light. Equivalent to [member Light2D.texture_scale].
</description>
</method>
<method name="canvas_light_set_shadow_buffer_size">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="size" type="int">
</argument>
<description>
Sets the width of the shadow buffer, size gets scaled to the next power of two for this.
</description>
</method>
<method name="canvas_light_set_shadow_color">
<return type="void">
</return>
@ -478,7 +456,7 @@
<argument index="1" name="texture" type="RID">
</argument>
<description>
Sets texture to be used by light. Equivalent to [member Light2D.texture].
Sets the texture to be used by a [PointLight2D]. Equivalent to [member PointLight2D.texture].
</description>
</method>
<method name="canvas_light_set_texture_offset">
@ -489,7 +467,18 @@
<argument index="1" name="offset" type="Vector2">
</argument>
<description>
Sets the offset of the light's texture. Equivalent to [member Light2D.offset].
Sets the offset of a [PointLight2D]'s texture. Equivalent to [member PointLight2D.offset].
</description>
</method>
<method name="canvas_light_set_texture_scale">
<return type="void">
</return>
<argument index="0" name="light" type="RID">
</argument>
<argument index="1" name="scale" type="float">
</argument>
<description>
Sets the scale factor of a [PointLight2D]'s texture. Equivalent to [member PointLight2D.texture_scale].
</description>
</method>
<method name="canvas_light_set_transform">
@ -708,6 +697,8 @@
</argument>
<argument index="7" name="height_density" type="float">
</argument>
<argument index="8" name="aerial_perspective" type="float">
</argument>
<description>
</description>
</method>
@ -2965,6 +2956,16 @@
Sets when the viewport should be updated. See [enum ViewportUpdateMode] constants for options.
</description>
</method>
<method name="viewport_set_use_debanding">
<return type="void">
</return>
<argument index="0" name="viewport" type="RID">
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="viewport_set_use_xr">
<return type="void">
</return>
@ -3674,18 +3675,25 @@
<constant name="CANVAS_ITEM_TEXTURE_REPEAT_MAX" value="4" enum="CanvasItemTextureRepeat">
Max value for [enum CanvasItemTextureRepeat] enum.
</constant>
<constant name="CANVAS_LIGHT_MODE_ADD" value="0" enum="CanvasLightMode">
<constant name="CANVAS_GROUP_MODE_DISABLED" value="0" enum="CanvasGroupMode">
</constant>
<constant name="CANVAS_GROUP_MODE_OPAQUE" value="1" enum="CanvasGroupMode">
</constant>
<constant name="CANVAS_GROUP_MODE_TRANSPARENT" value="2" enum="CanvasGroupMode">
</constant>
<constant name="CANVAS_LIGHT_MODE_POINT" value="0" enum="CanvasLightMode">
</constant>
<constant name="CANVAS_LIGHT_MODE_DIRECTIONAL" value="1" enum="CanvasLightMode">
</constant>
<constant name="CANVAS_LIGHT_BLEND_MODE_ADD" value="0" enum="CanvasLightBlendMode">
Adds light color additive to the canvas.
</constant>
<constant name="CANVAS_LIGHT_MODE_SUB" value="1" enum="CanvasLightMode">
<constant name="CANVAS_LIGHT_BLEND_MODE_SUB" value="1" enum="CanvasLightBlendMode">
Adds light color subtractive to the canvas.
</constant>
<constant name="CANVAS_LIGHT_MODE_MIX" value="2" enum="CanvasLightMode">
<constant name="CANVAS_LIGHT_BLEND_MODE_MIX" value="2" enum="CanvasLightBlendMode">
The light adds color depending on transparency.
</constant>
<constant name="CANVAS_LIGHT_MODE_MASK" value="3" enum="CanvasLightMode">
The light adds color depending on mask.
</constant>
<constant name="CANVAS_LIGHT_FILTER_NONE" value="0" enum="CanvasLightShadowFilter">
Do not apply a filter to canvas light shadows.
</constant>

2
doc/classes/Signal.xml
View file

@ -33,7 +33,7 @@
</description>
</method>
<method name="disconnect">
<return type="Variant">
<return type="void">
</return>
<argument index="0" name="callable" type="Callable">
</argument>

13
doc/classes/Sprite2D.xml
View file

@ -53,10 +53,6 @@
<member name="hframes" type="int" setter="set_hframes" getter="get_hframes" default="1">
The number of columns in the sprite sheet.
</member>
<member name="normal_map" type="Texture2D" setter="set_normal_map" getter="get_normal_map">
The normal map gives depth to the Sprite2D.
[b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.
</member>
<member name="offset" type="Vector2" setter="set_offset" getter="get_offset" default="Vector2( 0, 0 )">
The texture's drawing offset.
</member>
@ -69,15 +65,6 @@
<member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect" default="Rect2( 0, 0, 0, 0 )">
The region of the atlas texture to display. [member region_enabled] must be [code]true[/code].
</member>
<member name="shininess" type="float" setter="set_shininess" getter="get_shininess" default="1.0">
Strength of the specular light effect of this [Sprite2D].
</member>
<member name="specular_color" type="Color" setter="set_specular_color" getter="get_specular_color" default="Color( 1, 1, 1, 1 )">
The color of the specular light effect.
</member>
<member name="specular_map" type="Texture2D" setter="set_specular_map" getter="get_specular_map">
The specular map is used for more control on the shininess effect.
</member>
<member name="texture" type="Texture2D" setter="set_texture" getter="get_texture">
[Texture2D] object to draw.
</member>

54
doc/classes/String.xml
View file

@ -314,6 +314,14 @@
Returns the bigrams (pairs of consecutive letters) of this string.
</description>
</method>
<method name="bin_to_int">
<return type="int">
</return>
<argument index="0" name="with_prefix" type="bool" default="true">
</argument>
<description>
</description>
</method>
<method name="c_escape">
<return type="String">
</return>
@ -397,17 +405,6 @@
Returns [code]true[/code] if the string ends with the given string.
</description>
</method>
<method name="erase">
<return type="void">
</return>
<argument index="0" name="position" type="int">
</argument>
<argument index="1" name="chars" type="int">
</argument>
<description>
Erases [code]chars[/code] characters from the string starting from [code]position[/code].
</description>
</method>
<method name="find">
<return type="int">
</return>
@ -485,10 +482,13 @@
<method name="hex_to_int">
<return type="int">
</return>
<argument index="0" name="with_prefix" type="bool" default="true">
</argument>
<description>
Converts a string containing a hexadecimal number into an integer. Hexadecimal strings are expected to be prefixed with "[code]0x[/code]" otherwise [code]0[/code] is returned.
Converts a string containing a hexadecimal number into a decimal integer. If [code]with_prefix[/code] is [code]true[/code], the hexadecimal string should start with the [code]0x[/code] prefix, otherwise [code]0[/code] is returned.
[codeblock]
print("0xff".hex_to_int()) # Print "255"
print("ab".hex_to_int(false)) # Print "171"
[/codeblock]
</description>
</method>
@ -512,20 +512,6 @@
[/codeblock]
</description>
</method>
<method name="humanize_size">
<return type="String">
</return>
<argument index="0" name="size" type="int">
</argument>
<description>
Converts [code]size[/code] represented as number of bytes to human-readable format using internationalized set of data size units, namely: B, KiB, MiB, GiB, TiB, PiB, EiB. Note that the next smallest unit is picked automatically to hold at most 1024 units.
[codeblock]
var bytes = 133790307
var size = String.humanize_size(bytes)
print(size) # prints "127.5 MiB"
[/codeblock]
</description>
</method>
<method name="insert">
<return type="String">
</return>
@ -990,11 +976,11 @@
Returns part of the string from the position [code]from[/code] with length [code]len[/code]. Argument [code]len[/code] is optional and using [code]-1[/code] will return remaining characters from given position.
</description>
</method>
<method name="to_ascii">
<method name="to_ascii_buffer">
<return type="PackedByteArray">
</return>
<description>
Converts the String (which is a character array) to ASCII/Latin-1 encoded [PackedByteArray] (which is an array of bytes). The conversion is faster compared to [method to_utf8], as this method assumes that all the characters in the String are ASCII/Latin-1 characters, unsupported characters are replaced with spaces.
Converts the String (which is a character array) to ASCII/Latin-1 encoded [PackedByteArray] (which is an array of bytes). The conversion is faster compared to [method to_utf8_buffer], as this method assumes that all the characters in the String are ASCII/Latin-1 characters, unsupported characters are replaced with spaces.
</description>
</method>
<method name="to_float">
@ -1025,25 +1011,25 @@
Returns the string converted to uppercase.
</description>
</method>
<method name="to_utf16">
<method name="to_utf16_buffer">
<return type="PackedByteArray">
</return>
<description>
Converts the String (which is an array of characters) to UTF-16 encoded [PackedByteArray] (which is an array of bytes).
</description>
</method>
<method name="to_utf32">
<method name="to_utf32_buffer">
<return type="PackedByteArray">
</return>
<description>
Converts the String (which is an array of characters) to UTF-32 encoded [PackedByteArray] (which is an array of bytes).
</description>
</method>
<method name="to_utf8">
<method name="to_utf8_buffer">
<return type="PackedByteArray">
</return>
<description>
Converts the String (which is an array of characters) to UTF-8 encode [PackedByteArray] (which is an array of bytes). The conversion is a bit slower than [method to_ascii], but supports all UTF-8 characters. Therefore, you should prefer this function over [method to_ascii].
Converts the String (which is an array of characters) to UTF-8 encode [PackedByteArray] (which is an array of bytes). The conversion is a bit slower than [method to_ascii_buffer], but supports all UTF-8 characters. Therefore, you should prefer this function over [method to_ascii_buffer].
</description>
</method>
<method name="trim_prefix">
@ -1067,8 +1053,10 @@
<method name="xml_escape">
<return type="String">
</return>
<argument index="0" name="escape_quotes" type="bool" default="false">
</argument>
<description>
Returns a copy of the string with special characters escaped using the XML standard.
Returns a copy of the string with special characters escaped using the XML standard. If [code]escape_quotes[/code] is [code]true[/code], the single quote ([code]'[/code]) and double quote ([code]"[/code]) characters are also escaped.
</description>
</method>
<method name="xml_unescape">

4
doc/classes/StyleBoxTexture.xml
View file

@ -119,10 +119,6 @@
<member name="modulate_color" type="Color" setter="set_modulate" getter="get_modulate" default="Color( 1, 1, 1, 1 )">
Modulates the color of the texture when this style box is drawn.
</member>
<member name="normal_map" type="Texture2D" setter="set_normal_map" getter="get_normal_map">
The normal map to use when drawing this style box.
[b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.
</member>
<member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect" default="Rect2( 0, 0, 0, 0 )">
Species a sub-region of the texture to use.
This is equivalent to first wrapping the texture in an [AtlasTexture] with the same region.

40
doc/classes/TextEdit.xml
View file

@ -213,6 +213,12 @@
Returns the [PopupMenu] of this [TextEdit]. By default, this menu is displayed when right-clicking on the [TextEdit].
</description>
</method>
<method name="get_selection_column" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_selection_from_column" qualifiers="const">
<return type="int">
</return>
@ -227,6 +233,18 @@
Returns the selection begin line.
</description>
</method>
<method name="get_selection_line" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_selection_mode" qualifiers="const">
<return type="int" enum="TextEdit.SelectionMode">
</return>
<description>
</description>
</method>
<method name="get_selection_text" qualifiers="const">
<return type="String">
</return>
@ -555,6 +573,18 @@
<description>
</description>
</method>
<method name="set_selection_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="TextEdit.SelectionMode">
</argument>
<argument index="1" name="line" type="int" default="-1">
</argument>
<argument index="2" name="column" type="int" default="-1">
</argument>
<description>
</description>
</method>
<method name="toggle_fold_line">
<return type="void">
</return>
@ -732,6 +762,16 @@
<constant name="SEARCH_BACKWARDS" value="4" enum="SearchFlags">
Search from end to beginning.
</constant>
<constant name="SELECTION_MODE_NONE" value="0" enum="SelectionMode">
</constant>
<constant name="SELECTION_MODE_SHIFT" value="1" enum="SelectionMode">
</constant>
<constant name="SELECTION_MODE_POINTER" value="2" enum="SelectionMode">
</constant>
<constant name="SELECTION_MODE_WORD" value="3" enum="SelectionMode">
</constant>
<constant name="SELECTION_MODE_LINE" value="4" enum="SelectionMode">
</constant>
<constant name="GUTTER_TYPE_STRING" value="0" enum="GutterType">
</constant>
<constant name="GUTTER_TPYE_ICON" value="1" enum="GutterType">

32
doc/classes/Texture2D.xml
View file

@ -22,16 +22,6 @@
</argument>
<argument index="3" name="transpose" type="bool" default="false">
</argument>
<argument index="4" name="normal_map" type="Texture2D" default="null">
</argument>
<argument index="5" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="6" name="specular_color_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="7" name="texture_filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" default="0">
</argument>
<argument index="8" name="texture_repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" default="0">
</argument>
<description>
Draws the texture using a [CanvasItem] with the [RenderingServer] API at the specified [code]position[/code].
</description>
@ -49,16 +39,6 @@
</argument>
<argument index="4" name="transpose" type="bool" default="false">
</argument>
<argument index="5" name="normal_map" type="Texture2D" default="null">
</argument>
<argument index="6" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="7" name="specular_color_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="8" name="texture_filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" default="0">
</argument>
<argument index="9" name="texture_repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" default="0">
</argument>
<description>
Draws the texture using a [CanvasItem] with the [RenderingServer] API.
</description>
@ -76,17 +56,7 @@
</argument>
<argument index="4" name="transpose" type="bool" default="false">
</argument>
<argument index="5" name="normal_map" type="Texture2D" default="null">
</argument>
<argument index="6" name="specular_map" type="Texture2D" default="null">
</argument>
<argument index="7" name="specular_color_shininess" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="8" name="texture_filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" default="0">
</argument>
<argument index="9" name="texture_repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" default="0">
</argument>
<argument index="10" name="clip_uv" type="bool" default="true">
<argument index="5" name="clip_uv" type="bool" default="true">
</argument>
<description>
Draws a part of the texture using a [CanvasItem] with the [RenderingServer] API.

21
doc/classes/TileSet.xml
View file

@ -389,15 +389,6 @@
Returns the offset of the tile's navigation polygon.
</description>
</method>
<method name="tile_get_normal_map" qualifiers="const">
<return type="Texture2D">
</return>
<argument index="0" name="id" type="int">
</argument>
<description>
Returns the tile's normal map texture.
</description>
</method>
<method name="tile_get_occluder_offset" qualifiers="const">
<return type="Vector2">
</return>
@ -600,18 +591,6 @@
Sets an offset for the tile's navigation polygon.
</description>
</method>
<method name="tile_set_normal_map">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="normal_map" type="Texture2D">
</argument>
<description>
Sets the tile's normal map texture.
[b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.
</description>
</method>
<method name="tile_set_occluder_offset">
<return type="void">
</return>

22
doc/classes/Transform.xml
View file

@ -79,7 +79,7 @@
<method name="interpolate_with">
<return type="Transform">
</return>
<argument index="0" name="transform" type="Transform">
<argument index="0" name="xform" type="Transform">
</argument>
<argument index="1" name="weight" type="float">
</argument>
@ -97,7 +97,7 @@
<method name="is_equal_approx">
<return type="bool">
</return>
<argument index="0" name="transform" type="Transform">
<argument index="0" name="xform" type="Transform">
</argument>
<description>
Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
@ -153,24 +153,6 @@
Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
</description>
</method>
<method name="xform">
<return type="Variant">
</return>
<argument index="0" name="v" type="Variant">
</argument>
<description>
Transforms the given [Vector3], [Plane], [AABB], or [PackedVector3Array] by this transform.
</description>
</method>
<method name="xform_inv">
<return type="Variant">
</return>
<argument index="0" name="v" type="Variant">
</argument>
<description>
Inverse-transforms the given [Vector3], [Plane], [AABB], or [PackedVector3Array] by this transform.
</description>
</method>
</methods>
<members>
<member name="basis" type="Basis" setter="" getter="" default="Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 )">

36
doc/classes/Transform2D.xml
View file

@ -17,10 +17,12 @@
<method name="Transform2D">
<return type="Transform2D">
</return>
<argument index="0" name="from" type="Transform">
<argument index="0" name="rotation" type="float">
</argument>
<argument index="1" name="position" type="Vector2">
</argument>
<description>
Constructs the transform from a 3D [Transform].
Constructs the transform from a given angle (in radians) and position.
</description>
</method>
<method name="Transform2D">
@ -39,12 +41,10 @@
<method name="Transform2D">
<return type="Transform2D">
</return>
<argument index="0" name="rotation" type="float">
</argument>
<argument index="1" name="position" type="Vector2">
<argument index="0" name="from" type="Transform">
</argument>
<description>
Constructs the transform from a given angle (in radians) and position.
Constructs the transform from a 3D [Transform].
</description>
</method>
<method name="affine_inverse">
@ -98,9 +98,9 @@
<method name="interpolate_with">
<return type="Transform2D">
</return>
<argument index="0" name="transform" type="Transform2D">
<argument index="0" name="xform" type="Transform2D">
</argument>
<argument index="1" name="weight" type="float">
<argument index="1" name="t" type="float">
</argument>
<description>
Returns a transform interpolated between this transform and another by a given weight (on the range of 0.0 to 1.0).
@ -116,7 +116,7 @@
<method name="is_equal_approx">
<return type="bool">
</return>
<argument index="0" name="transform" type="Transform2D">
<argument index="0" name="xform" type="Transform2D">
</argument>
<description>
Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
@ -157,24 +157,6 @@
Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
</description>
</method>
<method name="xform">
<return type="Variant">
</return>
<argument index="0" name="v" type="Variant">
</argument>
<description>
Transforms the given [Vector2], [Rect2], or [PackedVector2Array] by this transform.
</description>
</method>
<method name="xform_inv">
<return type="Variant">
</return>
<argument index="0" name="v" type="Variant">
</argument>
<description>
Inverse-transforms the given [Vector2], [Rect2], or [PackedVector2Array] by this transform.
</description>
</method>
</methods>
<members>
<member name="origin" type="Vector2" setter="" getter="" default="Vector2( 0, 0 )">

6
doc/classes/Vector2.xml
View file

@ -177,7 +177,7 @@
<method name="is_equal_approx">
<return type="bool">
</return>
<argument index="0" name="v" type="Vector2">
<argument index="0" name="to" type="Vector2">
</argument>
<description>
Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
@ -208,7 +208,7 @@
<method name="lerp">
<return type="Vector2">
</return>
<argument index="0" name="b" type="Vector2">
<argument index="0" name="with" type="Vector2">
</argument>
<argument index="1" name="t" type="float">
</argument>
@ -296,7 +296,7 @@
<method name="slerp">
<return type="Vector2">
</return>
<argument index="0" name="b" type="Vector2">
<argument index="0" name="with" type="Vector2">
</argument>
<argument index="1" name="t" type="float">
</argument>

10
doc/classes/Vector3.xml
View file

@ -74,7 +74,7 @@
<method name="cross">
<return type="Vector3">
</return>
<argument index="0" name="b" type="Vector3">
<argument index="0" name="with" type="Vector3">
</argument>
<description>
Returns the cross product of this vector and [code]b[/code].
@ -126,7 +126,7 @@
<method name="dot">
<return type="float">
</return>
<argument index="0" name="b" type="Vector3">
<argument index="0" name="with" type="Vector3">
</argument>
<description>
Returns the dot product of this vector and [code]b[/code]. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player.
@ -152,7 +152,7 @@
<method name="is_equal_approx">
<return type="bool">
</return>
<argument index="0" name="v" type="Vector3">
<argument index="0" name="to" type="Vector3">
</argument>
<description>
Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
@ -226,7 +226,7 @@
<method name="outer">
<return type="Basis">
</return>
<argument index="0" name="b" type="Vector3">
<argument index="0" name="with" type="Vector3">
</argument>
<description>
Returns the outer product with [code]b[/code].
@ -271,7 +271,7 @@
<method name="rotated">
<return type="Vector3">
</return>
<argument index="0" name="axis" type="Vector3">
<argument index="0" name="by_axis" type="Vector3">
</argument>
<argument index="1" name="phi" type="float">
</argument>

6
doc/classes/Vector3i.xml
View file

@ -36,6 +36,12 @@
Constructs a new [Vector3i] from [Vector3]. The floating point coordinates will be truncated.
</description>
</method>
<method name="abs">
<return type="Vector3i">
</return>
<description>
</description>
</method>
<method name="max_axis">
<return type="int">
</return>

6
doc/classes/Viewport.xml
View file

@ -250,9 +250,15 @@
The shadow atlas' resolution (used for omni and spot lights). The value will be rounded up to the nearest power of 2.
[b]Note:[/b] If this is set to 0, shadows won't be visible. Since user-created viewports default to a value of 0, this value must be set above 0 manually.
</member>
<member name="snap_2d_transforms_to_pixel" type="bool" setter="set_snap_2d_transforms_to_pixel" getter="is_snap_2d_transforms_to_pixel_enabled" default="false">
</member>
<member name="snap_2d_vertices_to_pixel" type="bool" setter="set_snap_2d_vertices_to_pixel" getter="is_snap_2d_vertices_to_pixel_enabled" default="false">
</member>
<member name="transparent_bg" type="bool" setter="set_transparent_background" getter="has_transparent_background" default="false">
If [code]true[/code], the viewport should render its background as transparent.
</member>
<member name="use_debanding" type="bool" setter="set_use_debanding" getter="is_using_debanding" default="false">
</member>
<member name="world_2d" type="World2D" setter="set_world_2d" getter="get_world_2d">
The custom [World2D] which can be used as 2D environment source.
</member>

2
modules/visual_script/doc_classes/VisualScriptPropertyGet.xml
View file

@ -31,5 +31,7 @@
</constant>
<constant name="CALL_MODE_INSTANCE" value="2" enum="CallMode">
</constant>
<constant name="CALL_MODE_BASIC_TYPE" value="3" enum="CallMode">
</constant>
</constants>
</class>

8
scene/2d/light_2d.cpp
View file

@ -445,10 +445,6 @@ void PointLight2D::_bind_methods() {
PointLight2D::PointLight2D() {
RS::get_singleton()->canvas_light_set_mode(_get_light(), RS::CANVAS_LIGHT_MODE_POINT);
_scale = 1.0;
}
PointLight2D::~PointLight2D() {
}
//////////
@ -457,6 +453,7 @@ void DirectionalLight2D::set_max_distance(float p_distance) {
max_distance = p_distance;
RS::get_singleton()->canvas_light_set_directional_distance(_get_light(), max_distance);
}
float DirectionalLight2D::get_max_distance() const {
return max_distance;
}
@ -468,7 +465,8 @@ void DirectionalLight2D::_bind_methods() {
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "height", PROPERTY_HINT_RANGE, "0,1,0.01"), "set_height", "get_height");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "max_distance", PROPERTY_HINT_RANGE, "0,16384.0,1.0,or_greater"), "set_max_distance", "get_max_distance");
}
DirectionalLight2D::DirectionalLight2D() {
RS::get_singleton()->canvas_light_set_mode(_get_light(), RS::CANVAS_LIGHT_MODE_DIRECTIONAL);
set_max_distance(10000.0);
set_max_distance(max_distance); // Update RenderingServer.
}

4
scene/2d/light_2d.h
View file

@ -58,7 +58,6 @@ private:
Color color;
Color shadow_color;
float height;
float _scale;
float energy;
int z_min;
int z_max;
@ -139,7 +138,7 @@ class PointLight2D : public Light2D {
GDCLASS(PointLight2D, Light2D);
private:
float _scale;
float _scale = 1.0;
Ref<Texture2D> texture;
Vector2 texture_offset;
@ -172,7 +171,6 @@ public:
String get_configuration_warning() const override;
PointLight2D();
~PointLight2D();
};
class DirectionalLight2D : public Light2D {

7
servers/rendering_server.cpp
View file

@ -2190,6 +2190,13 @@ void RenderingServer::_bind_methods() {
BIND_ENUM_CONSTANT(CANVAS_ITEM_TEXTURE_REPEAT_MIRROR);
BIND_ENUM_CONSTANT(CANVAS_ITEM_TEXTURE_REPEAT_MAX);
BIND_ENUM_CONSTANT(CANVAS_GROUP_MODE_DISABLED);
BIND_ENUM_CONSTANT(CANVAS_GROUP_MODE_OPAQUE);
BIND_ENUM_CONSTANT(CANVAS_GROUP_MODE_TRANSPARENT);
BIND_ENUM_CONSTANT(CANVAS_LIGHT_MODE_POINT);
BIND_ENUM_CONSTANT(CANVAS_LIGHT_MODE_DIRECTIONAL);
BIND_ENUM_CONSTANT(CANVAS_LIGHT_BLEND_MODE_ADD);
BIND_ENUM_CONSTANT(CANVAS_LIGHT_BLEND_MODE_SUB);
BIND_ENUM_CONSTANT(CANVAS_LIGHT_BLEND_MODE_MIX);

1
servers/rendering_server.h
View file

@ -1445,6 +1445,7 @@ VARIANT_ENUM_CAST(RenderingServer::ShadowCastingSetting);
VARIANT_ENUM_CAST(RenderingServer::NinePatchAxisMode);
VARIANT_ENUM_CAST(RenderingServer::CanvasItemTextureFilter);
VARIANT_ENUM_CAST(RenderingServer::CanvasItemTextureRepeat);
VARIANT_ENUM_CAST(RenderingServer::CanvasGroupMode);
VARIANT_ENUM_CAST(RenderingServer::CanvasLightMode);
VARIANT_ENUM_CAST(RenderingServer::CanvasLightBlendMode);
VARIANT_ENUM_CAST(RenderingServer::CanvasLightShadowFilter);