From a7d10a20d9a010c71c347b362a58e83d25b0f5c6 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Thu, 6 Feb 2025 14:42:55 -0800 Subject: [PATCH 01/36] Add GDScript warning pages, with content for `GET_NODE_DEFAULT_WITHOUT_ONREADY` Set up warnings page Add page for each warning, and move content for `GET_NODE_DEFAULT_WITHOUT_ONREADY` --- tutorials/scripting/gdscript/index.rst | 1 + .../gdscript/warnings/ASSERT_ALWAYS_FALSE.rst | 16 +++++ .../gdscript/warnings/ASSERT_ALWAYS_TRUE.rst | 16 +++++ .../CONFUSABLE_CAPTURE_REASSIGNMENT.rst | 16 +++++ .../warnings/CONFUSABLE_IDENTIFIER.rst | 16 +++++ .../warnings/CONFUSABLE_LOCAL_DECLARATION.rst | 16 +++++ .../warnings/CONFUSABLE_LOCAL_USAGE.rst | 16 +++++ .../warnings/CONSTANT_USED_AS_FUNCTION.rst | 16 +++++ .../gdscript/warnings/DEPRECATED_KEYWORD.rst | 16 +++++ .../gdscript/warnings/EMPTY_FILE.rst | 16 +++++ .../ENUM_VARIABLE_WITHOUT_DEFAULT.rst | 16 +++++ .../warnings/FUNCTION_USED_AS_PROPERTY.rst | 16 +++++ .../GET_NODE_DEFAULT_WITHOUT_ONREADY.rst | 41 ++++++++++++ .../warnings/INCOMPATIBLE_TERNARY.rst | 16 +++++ .../warnings/INFERENCE_ON_VARIANT.rst | 16 +++++ .../warnings/INFERRED_DECLARATION.rst | 16 +++++ .../gdscript/warnings/INTEGER_DIVISION.rst | 16 +++++ .../warnings/INT_AS_ENUM_WITHOUT_CAST.rst | 16 +++++ .../warnings/INT_AS_ENUM_WITHOUT_MATCH.rst | 16 +++++ .../gdscript/warnings/MISSING_TOOL.rst | 16 +++++ .../warnings/NARROWING_CONVERSION.rst | 16 +++++ .../warnings/NATIVE_METHOD_OVERRIDE.rst | 16 +++++ .../gdscript/warnings/ONREADY_WITH_EXPORT.rst | 16 +++++ .../warnings/PROPERTY_USED_AS_FUNCTION.rst | 16 +++++ .../gdscript/warnings/REDUNDANT_AWAIT.rst | 16 +++++ .../warnings/REDUNDANT_STATIC_UNLOAD.rst | 16 +++++ .../warnings/RETURN_VALUE_DISCARDED.rst | 16 +++++ .../warnings/SHADOWED_GLOBAL_IDENTIFIER.rst | 16 +++++ .../gdscript/warnings/SHADOWED_VARIABLE.rst | 16 +++++ .../warnings/SHADOWED_VARIABLE_BASE_CLASS.rst | 16 +++++ .../warnings/STANDALONE_EXPRESSION.rst | 16 +++++ .../gdscript/warnings/STANDALONE_TERNARY.rst | 16 +++++ .../warnings/STATIC_CALLED_ON_INSTANCE.rst | 16 +++++ .../gdscript/warnings/UNASSIGNED_VARIABLE.rst | 16 +++++ .../UNASSIGNED_VARIABLE_OP_ASSIGN.rst | 16 +++++ .../gdscript/warnings/UNREACHABLE_CODE.rst | 16 +++++ .../gdscript/warnings/UNREACHABLE_PATTERN.rst | 16 +++++ .../warnings/UNSAFE_CALL_ARGUMENT.rst | 16 +++++ .../gdscript/warnings/UNSAFE_CAST.rst | 16 +++++ .../warnings/UNSAFE_METHOD_ACCESS.rst | 16 +++++ .../warnings/UNSAFE_PROPERTY_ACCESS.rst | 16 +++++ .../gdscript/warnings/UNSAFE_VOID_RETURN.rst | 16 +++++ .../gdscript/warnings/UNTYPED_DECLARATION.rst | 16 +++++ .../warnings/UNUSED_LOCAL_CONSTANT.rst | 16 +++++ .../gdscript/warnings/UNUSED_PARAMETER.rst | 16 +++++ .../UNUSED_PRIVATE_CLASS_VARIABLE.rst | 16 +++++ .../gdscript/warnings/UNUSED_SIGNAL.rst | 16 +++++ .../gdscript/warnings/UNUSED_VARIABLE.rst | 16 +++++ .../scripting/gdscript/warnings/index.rst | 63 +++++++++++++++++++ 49 files changed, 841 insertions(+) create mode 100644 tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst create mode 100644 tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst create mode 100644 tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst create mode 100644 tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst create mode 100644 tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst create mode 100644 tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst create mode 100644 tutorials/scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst create mode 100644 tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst create mode 100644 tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst create mode 100644 tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst create mode 100644 tutorials/scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst create mode 100644 tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst create mode 100644 tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst create mode 100644 tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst create mode 100644 tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst create mode 100644 tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst create mode 100644 tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst create mode 100644 tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst create mode 100644 tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst create mode 100644 tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst create mode 100644 tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst create mode 100644 tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst create mode 100644 tutorials/scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst create mode 100644 tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst create mode 100644 tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst create mode 100644 tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst create mode 100644 tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst create mode 100644 tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst create mode 100644 tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst create mode 100644 tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst create mode 100644 tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst create mode 100644 tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst create mode 100644 tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst create mode 100644 tutorials/scripting/gdscript/warnings/index.rst diff --git a/tutorials/scripting/gdscript/index.rst b/tutorials/scripting/gdscript/index.rst index 8ad213e11a0..b3e1962bd11 100644 --- a/tutorials/scripting/gdscript/index.rst +++ b/tutorials/scripting/gdscript/index.rst @@ -14,6 +14,7 @@ GDScript gdscript_styleguide static_typing warning_system + warnings/index gdscript_format_string .. seealso:: diff --git a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst new file mode 100644 index 00000000000..8c8ecfb03af --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst @@ -0,0 +1,16 @@ +``ASSERT_ALWAYS_FALSE`` +======================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst new file mode 100644 index 00000000000..1302b97420c --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst @@ -0,0 +1,16 @@ +``ASSERT_ALWAYS_TRUE`` +====================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst new file mode 100644 index 00000000000..9419c96e801 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst @@ -0,0 +1,16 @@ +``CONFUSABLE_CAPTURE_REASSIGNMENT`` +=================================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst new file mode 100644 index 00000000000..42f41887981 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst @@ -0,0 +1,16 @@ +``CONFUSABLE_IDENTIFIER`` +========================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst new file mode 100644 index 00000000000..7ff70498838 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst @@ -0,0 +1,16 @@ +``CONFUSABLE_LOCAL_DECLARATION`` +================================ + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst new file mode 100644 index 00000000000..6d6e1bbf0c2 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst @@ -0,0 +1,16 @@ +``CONFUSABLE_LOCAL_USAGE`` +========================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst b/tutorials/scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst new file mode 100644 index 00000000000..78f8f32e481 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst @@ -0,0 +1,16 @@ +``CONSTANT_USED_AS_FUNCTION`` +============================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst b/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst new file mode 100644 index 00000000000..90d1e519245 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst @@ -0,0 +1,16 @@ +``DEPRECATED_KEYWORD`` +====================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst b/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst new file mode 100644 index 00000000000..a3c1b232d48 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst @@ -0,0 +1,16 @@ +``EMPTY_FILE`` +============== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst b/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst new file mode 100644 index 00000000000..e35f9113426 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst @@ -0,0 +1,16 @@ +``ENUM_VARIABLE_WITHOUT_DEFAULT`` +================================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst b/tutorials/scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst new file mode 100644 index 00000000000..610f45e772a --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst @@ -0,0 +1,16 @@ +``FUNCTION_USED_AS_PROPERTY`` +============================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst b/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst new file mode 100644 index 00000000000..ff7e19aced0 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst @@ -0,0 +1,41 @@ +``GET_NODE_DEFAULT_WITHOUT_ONREADY`` +==================================== + +The warning that appears when a node's default value is set to a location in the scene tree without using the ``@onready`` annotation. +The message will say something like: + +.. code-block:: none + + The default value is using "$" which won't return nodes in the scene tree before "_ready()" is called. Use the "@onready" annotation to solve this. + +When this warning occurs +------------------------ +In GDScript, instance variables can be set by declaring them outside of a method. Additionally, they can be given a default value using ``=``:: + + extends Area2D + var my_num = 3 + +This way, the variable ``my_num`` will always start out with a value of ``3`` in each instance of this class. +GDScript also has methods to retrieve specific nodes from the scene tree: namely, the ``get_node`` method, and its shorthand versions ``$`` (and ``%`` for unique nodes). Thus, if you want to have an instance variable default to a child of the node with a script, it may be tempting to write something like the following:: + + extends Area2D + var my_collision_shape = $CollisionShape2D + +However, class instance variables' default values are evaluated and assigned before the scene tree is set up. This means that at the time of assigning the default value, the node may not be in the scene tree, and the variable will be set to ``null`` instead. + +How to fix this warning +----------------------- +The most straightforward solution is to add the ``@onready`` annotation before your variable declaration:: + + extends Area2D + @onready var my_collision_shape = $CollisionShape2D + +Now, the default value of the variable will not be assigned until the scene tree has been initialized, and the target node will be present. + +Alternatively, you can set the value of the variable at the beginning of your ``_ready`` method:: + + extends Area2D + var my_collision_shape + + func _ready(): + my_collision_shape = $CollisionShape2D \ No newline at end of file diff --git a/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst b/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst new file mode 100644 index 00000000000..4b6623415bd --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst @@ -0,0 +1,16 @@ +``INCOMPATIBLE_TERNARY`` +======================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst b/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst new file mode 100644 index 00000000000..da0bb688fe9 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst @@ -0,0 +1,16 @@ +``INFERENCE_ON_VARIANT`` +======================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst new file mode 100644 index 00000000000..623e14ad0e0 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst @@ -0,0 +1,16 @@ +``INFERRED_DECLARATION`` +======================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst b/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst new file mode 100644 index 00000000000..ee9b1e4e896 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst @@ -0,0 +1,16 @@ +``INTEGER_DIVISION`` +==================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst new file mode 100644 index 00000000000..db72d4adbf7 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst @@ -0,0 +1,16 @@ +``INT_AS_ENUM_WITHOUT_CAST`` +============================ + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst new file mode 100644 index 00000000000..40aac415916 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst @@ -0,0 +1,16 @@ +``INT_AS_ENUM_WITHOUT_MATCH`` +============================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst b/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst new file mode 100644 index 00000000000..6f4ac265983 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst @@ -0,0 +1,16 @@ +``MISSING_TOOL`` +================ + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst b/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst new file mode 100644 index 00000000000..99a06c76110 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst @@ -0,0 +1,16 @@ +``NARROWING_CONVERSION`` +======================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst b/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst new file mode 100644 index 00000000000..b6dead0a932 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst @@ -0,0 +1,16 @@ +``NATIVE_METHOD_OVERRIDE`` +========================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst b/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst new file mode 100644 index 00000000000..abdcd756543 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst @@ -0,0 +1,16 @@ +``ONREADY_WITH_EXPORT`` +======================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst b/tutorials/scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst new file mode 100644 index 00000000000..aa53016eed4 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst @@ -0,0 +1,16 @@ +``PROPERTY_USED_AS_FUNCTION`` +============================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst b/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst new file mode 100644 index 00000000000..9e8665bb3a4 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst @@ -0,0 +1,16 @@ +``REDUNDANT_AWAIT`` +=================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst b/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst new file mode 100644 index 00000000000..7a92a7ad572 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst @@ -0,0 +1,16 @@ +``REDUNDANT_STATIC_UNLOAD`` +=========================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst b/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst new file mode 100644 index 00000000000..81e0bcbf4cf --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst @@ -0,0 +1,16 @@ +``RETURN_VALUE_DISCARDED`` +========================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst b/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst new file mode 100644 index 00000000000..be1869afa4e --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst @@ -0,0 +1,16 @@ +``SHADOWED_GLOBAL_IDENTIFIER`` +============================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst new file mode 100644 index 00000000000..f1f9943788a --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst @@ -0,0 +1,16 @@ +``SHADOWED_VARIABLE`` +===================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst new file mode 100644 index 00000000000..f009ffe48ac --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst @@ -0,0 +1,16 @@ +``SHADOWED_VARIABLE_BASE_CLASS`` +================================ + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst b/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst new file mode 100644 index 00000000000..6cd2237f12d --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst @@ -0,0 +1,16 @@ +``STANDALONE_EXPRESSION`` +========================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst b/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst new file mode 100644 index 00000000000..c22b8bf826f --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst @@ -0,0 +1,16 @@ +``STANDALONE_TERNARY`` +====================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst b/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst new file mode 100644 index 00000000000..d7d388f8159 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst @@ -0,0 +1,16 @@ +``STATIC_CALLED_ON_INSTANCE`` +============================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst new file mode 100644 index 00000000000..75e76b313a3 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst @@ -0,0 +1,16 @@ +``UNASSIGNED_VARIABLE`` +======================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst new file mode 100644 index 00000000000..6546e5fc65d --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst @@ -0,0 +1,16 @@ +``UNASSIGNED_VARIABLE_OP_ASSIGN`` +================================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst b/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst new file mode 100644 index 00000000000..7c3ce1da92c --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst @@ -0,0 +1,16 @@ +``UNREACHABLE_CODE`` +==================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst b/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst new file mode 100644 index 00000000000..e16f85047ac --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst @@ -0,0 +1,16 @@ +``UNREACHABLE_PATTERN`` +======================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst new file mode 100644 index 00000000000..d480f12917a --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst @@ -0,0 +1,16 @@ +``UNSAFE_CALL_ARGUMENT`` +======================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst new file mode 100644 index 00000000000..68e3f36779c --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst @@ -0,0 +1,16 @@ +``UNSAFE_CAST`` +=============== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst new file mode 100644 index 00000000000..9414c8d12e2 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst @@ -0,0 +1,16 @@ +``UNSAFE_METHOD_ACCESS`` +======================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst new file mode 100644 index 00000000000..c30152dfba3 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst @@ -0,0 +1,16 @@ +``UNSAFE_PROPERTY_ACCESS`` +========================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst new file mode 100644 index 00000000000..2b21fa047a6 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst @@ -0,0 +1,16 @@ +``UNSAFE_VOID_RETURN`` +====================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst new file mode 100644 index 00000000000..bf81eeb9d0a --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst @@ -0,0 +1,16 @@ +``UNTYPED_DECLARATION`` +======================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst b/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst new file mode 100644 index 00000000000..9c769201abd --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst @@ -0,0 +1,16 @@ +``UNUSED_LOCAL_CONSTANT`` +========================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst b/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst new file mode 100644 index 00000000000..4b0144418d2 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst @@ -0,0 +1,16 @@ +``UNUSED_PARAMETER`` +==================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst new file mode 100644 index 00000000000..08665332b1c --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst @@ -0,0 +1,16 @@ +``UNUSED_PRIVATE_CLASS_VARIABLE`` +================================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst b/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst new file mode 100644 index 00000000000..efdeb4c435f --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst @@ -0,0 +1,16 @@ +``UNUSED_SIGNAL`` +================= + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst new file mode 100644 index 00000000000..93908bf8c87 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst @@ -0,0 +1,16 @@ +``UNUSED_VARIABLE`` +=================== + +When this warning occurs +------------------------ + +TODO + + +How to fix this warning +----------------------- + +TODO + + + diff --git a/tutorials/scripting/gdscript/warnings/index.rst b/tutorials/scripting/gdscript/warnings/index.rst new file mode 100644 index 00000000000..cde1e8a6b81 --- /dev/null +++ b/tutorials/scripting/gdscript/warnings/index.rst @@ -0,0 +1,63 @@ +:allow_comments: False + +.. _doc_gdscript_warnings: + +GDScript warnings +================= + +This is a collection of the warnings that GDScript can emit, and information on how to fix the code that causes them. + +.. rubric:: Warnings + :heading-level: 2 + +.. toctree:: + :maxdepth: 1 + :name: toc-gdscript-warnings + + UNASSIGNED_VARIABLE + UNASSIGNED_VARIABLE_OP_ASSIGN + UNUSED_VARIABLE + UNUSED_LOCAL_CONSTANT + UNUSED_PRIVATE_CLASS_VARIABLE + UNUSED_PARAMETER + UNUSED_SIGNAL + SHADOWED_VARIABLE + SHADOWED_VARIABLE_BASE_CLASS + SHADOWED_GLOBAL_IDENTIFIER + UNREACHABLE_CODE + UNREACHABLE_PATTERN + STANDALONE_EXPRESSION + STANDALONE_TERNARY + INCOMPATIBLE_TERNARY + UNTYPED_DECLARATION + INFERRED_DECLARATION + UNSAFE_PROPERTY_ACCESS + UNSAFE_METHOD_ACCESS + UNSAFE_CAST + UNSAFE_CALL_ARGUMENT + UNSAFE_VOID_RETURN + RETURN_VALUE_DISCARDED + STATIC_CALLED_ON_INSTANCE + MISSING_TOOL + REDUNDANT_STATIC_UNLOAD + REDUNDANT_AWAIT + ASSERT_ALWAYS_TRUE + ASSERT_ALWAYS_FALSE + INTEGER_DIVISION + NARROWING_CONVERSION + INT_AS_ENUM_WITHOUT_CAST + INT_AS_ENUM_WITHOUT_MATCH + ENUM_VARIABLE_WITHOUT_DEFAULT + EMPTY_FILE + DEPRECATED_KEYWORD + CONFUSABLE_IDENTIFIER + CONFUSABLE_LOCAL_DECLARATION + CONFUSABLE_LOCAL_USAGE + CONFUSABLE_CAPTURE_REASSIGNMENT + INFERENCE_ON_VARIANT + NATIVE_METHOD_OVERRIDE + GET_NODE_DEFAULT_WITHOUT_ONREADY + ONREADY_WITH_EXPORT + PROPERTY_USED_AS_FUNCTION + CONSTANT_USED_AS_FUNCTION + FUNCTION_USED_AS_PROPERTY From bac9723beb60880d685a63313b09a3f06c9d4d6b Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Fri, 7 Feb 2025 12:35:37 -0800 Subject: [PATCH 02/36] Apply suggestions from code review Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com> --- .../warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst b/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst index ff7e19aced0..c10f9c39637 100644 --- a/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst +++ b/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst @@ -1,7 +1,7 @@ -``GET_NODE_DEFAULT_WITHOUT_ONREADY`` +GET_NODE_DEFAULT_WITHOUT_ONREADY ==================================== -The warning that appears when a node's default value is set to a location in the scene tree without using the ``@onready`` annotation. +This warning appears when a node's default value is set to a location in the scene tree without using the ``@onready`` annotation. The message will say something like: .. code-block:: none @@ -10,13 +10,14 @@ The message will say something like: When this warning occurs ------------------------ + In GDScript, instance variables can be set by declaring them outside of a method. Additionally, they can be given a default value using ``=``:: extends Area2D var my_num = 3 This way, the variable ``my_num`` will always start out with a value of ``3`` in each instance of this class. -GDScript also has methods to retrieve specific nodes from the scene tree: namely, the ``get_node`` method, and its shorthand versions ``$`` (and ``%`` for unique nodes). Thus, if you want to have an instance variable default to a child of the node with a script, it may be tempting to write something like the following:: +GDScript also has methods to retrieve specific nodes from the scene tree: namely, the :ref:`get_node() ` method, and its shorthand versions ``$`` (and ``%`` for unique nodes). Thus, if you want to have an instance variable default to a child of the node with a script, it may be tempting to write something like the following:: extends Area2D var my_collision_shape = $CollisionShape2D @@ -25,6 +26,7 @@ However, class instance variables' default values are evaluated and assigned bef How to fix this warning ----------------------- + The most straightforward solution is to add the ``@onready`` annotation before your variable declaration:: extends Area2D From 20a444ee3f9859366b4be8885a6dd4e1c9a4a2d4 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Fri, 7 Feb 2025 13:03:42 -0800 Subject: [PATCH 03/36] Remove inline code formatting from page titles --- tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst | 2 +- tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst | 2 +- .../gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst | 2 +- tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst | 2 +- .../gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst | 2 +- .../scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst | 2 +- .../scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst | 2 +- tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst | 2 +- tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst | 2 +- .../gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst | 2 +- .../scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst | 2 +- tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst | 2 +- tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst | 2 +- tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst | 2 +- tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst | 2 +- .../scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst | 2 +- .../scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst | 2 +- tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst | 2 +- tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst | 2 +- .../scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst | 2 +- tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst | 2 +- .../scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst | 2 +- tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst | 2 +- .../scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst | 2 +- .../scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst | 2 +- .../scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst | 2 +- tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst | 2 +- .../gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst | 2 +- tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst | 2 +- tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst | 2 +- .../scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst | 2 +- tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst | 2 +- .../gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst | 2 +- tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst | 2 +- tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst | 2 +- tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst | 2 +- tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst | 2 +- tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst | 2 +- .../scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst | 2 +- tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst | 2 +- tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst | 2 +- tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst | 2 +- tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst | 2 +- .../gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst | 2 +- tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst | 2 +- tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst | 2 +- 46 files changed, 46 insertions(+), 46 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst index 8c8ecfb03af..cd7d6bcea16 100644 --- a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst +++ b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst @@ -1,4 +1,4 @@ -``ASSERT_ALWAYS_FALSE`` +ASSERT_ALWAYS_FALSE ======================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst index 1302b97420c..77659bbd39c 100644 --- a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst +++ b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst @@ -1,4 +1,4 @@ -``ASSERT_ALWAYS_TRUE`` +ASSERT_ALWAYS_TRUE ====================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst index 9419c96e801..091e03bd81a 100644 --- a/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst @@ -1,4 +1,4 @@ -``CONFUSABLE_CAPTURE_REASSIGNMENT`` +CONFUSABLE_CAPTURE_REASSIGNMENT =================================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst index 42f41887981..905a48916ec 100644 --- a/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst @@ -1,4 +1,4 @@ -``CONFUSABLE_IDENTIFIER`` +CONFUSABLE_IDENTIFIER ========================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst index 7ff70498838..06616a7672b 100644 --- a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst @@ -1,4 +1,4 @@ -``CONFUSABLE_LOCAL_DECLARATION`` +CONFUSABLE_LOCAL_DECLARATION ================================ When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst index 6d6e1bbf0c2..fb3b14ed829 100644 --- a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst @@ -1,4 +1,4 @@ -``CONFUSABLE_LOCAL_USAGE`` +CONFUSABLE_LOCAL_USAGE ========================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst b/tutorials/scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst index 78f8f32e481..1a01c406e30 100644 --- a/tutorials/scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst +++ b/tutorials/scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst @@ -1,4 +1,4 @@ -``CONSTANT_USED_AS_FUNCTION`` +CONSTANT_USED_AS_FUNCTION ============================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst b/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst index 90d1e519245..852d37add31 100644 --- a/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst +++ b/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst @@ -1,4 +1,4 @@ -``DEPRECATED_KEYWORD`` +DEPRECATED_KEYWORD ====================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst b/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst index a3c1b232d48..fd02922d2f4 100644 --- a/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst +++ b/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst @@ -1,4 +1,4 @@ -``EMPTY_FILE`` +EMPTY_FILE ============== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst b/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst index e35f9113426..8865cfd0e0a 100644 --- a/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst +++ b/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst @@ -1,4 +1,4 @@ -``ENUM_VARIABLE_WITHOUT_DEFAULT`` +ENUM_VARIABLE_WITHOUT_DEFAULT ================================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst b/tutorials/scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst index 610f45e772a..32e3af72274 100644 --- a/tutorials/scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst +++ b/tutorials/scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst @@ -1,4 +1,4 @@ -``FUNCTION_USED_AS_PROPERTY`` +FUNCTION_USED_AS_PROPERTY ============================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst b/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst index 4b6623415bd..7c972a33315 100644 --- a/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst +++ b/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst @@ -1,4 +1,4 @@ -``INCOMPATIBLE_TERNARY`` +INCOMPATIBLE_TERNARY ======================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst b/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst index da0bb688fe9..93f86e27ff4 100644 --- a/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst +++ b/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst @@ -1,4 +1,4 @@ -``INFERENCE_ON_VARIANT`` +INFERENCE_ON_VARIANT ======================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst index 623e14ad0e0..2b6619bc9bd 100644 --- a/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst +++ b/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst @@ -1,4 +1,4 @@ -``INFERRED_DECLARATION`` +INFERRED_DECLARATION ======================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst b/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst index ee9b1e4e896..362fee71b15 100644 --- a/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst +++ b/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst @@ -1,4 +1,4 @@ -``INTEGER_DIVISION`` +INTEGER_DIVISION ==================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst index db72d4adbf7..e1d9264ef73 100644 --- a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst +++ b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst @@ -1,4 +1,4 @@ -``INT_AS_ENUM_WITHOUT_CAST`` +INT_AS_ENUM_WITHOUT_CAST ============================ When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst index 40aac415916..59f8ca39748 100644 --- a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst +++ b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst @@ -1,4 +1,4 @@ -``INT_AS_ENUM_WITHOUT_MATCH`` +INT_AS_ENUM_WITHOUT_MATCH ============================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst b/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst index 6f4ac265983..a499a8619f1 100644 --- a/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst +++ b/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst @@ -1,4 +1,4 @@ -``MISSING_TOOL`` +MISSING_TOOL ================ When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst b/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst index 99a06c76110..5b2c0885880 100644 --- a/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst +++ b/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst @@ -1,4 +1,4 @@ -``NARROWING_CONVERSION`` +NARROWING_CONVERSION ======================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst b/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst index b6dead0a932..abc3ffc7d74 100644 --- a/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst +++ b/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst @@ -1,4 +1,4 @@ -``NATIVE_METHOD_OVERRIDE`` +NATIVE_METHOD_OVERRIDE ========================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst b/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst index abdcd756543..8ada4460d40 100644 --- a/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst +++ b/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst @@ -1,4 +1,4 @@ -``ONREADY_WITH_EXPORT`` +ONREADY_WITH_EXPORT ======================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst b/tutorials/scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst index aa53016eed4..903dc5490a1 100644 --- a/tutorials/scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst +++ b/tutorials/scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst @@ -1,4 +1,4 @@ -``PROPERTY_USED_AS_FUNCTION`` +PROPERTY_USED_AS_FUNCTION ============================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst b/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst index 9e8665bb3a4..3b9c15f628a 100644 --- a/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst +++ b/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst @@ -1,4 +1,4 @@ -``REDUNDANT_AWAIT`` +REDUNDANT_AWAIT =================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst b/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst index 7a92a7ad572..fa0d428db68 100644 --- a/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst +++ b/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst @@ -1,4 +1,4 @@ -``REDUNDANT_STATIC_UNLOAD`` +REDUNDANT_STATIC_UNLOAD =========================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst b/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst index 81e0bcbf4cf..4cf2480fe4a 100644 --- a/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst +++ b/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst @@ -1,4 +1,4 @@ -``RETURN_VALUE_DISCARDED`` +RETURN_VALUE_DISCARDED ========================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst b/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst index be1869afa4e..d7c85fa088a 100644 --- a/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst +++ b/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst @@ -1,4 +1,4 @@ -``SHADOWED_GLOBAL_IDENTIFIER`` +SHADOWED_GLOBAL_IDENTIFIER ============================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst index f1f9943788a..5dad7e68457 100644 --- a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst +++ b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst @@ -1,4 +1,4 @@ -``SHADOWED_VARIABLE`` +SHADOWED_VARIABLE ===================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst index f009ffe48ac..d24ae04ca49 100644 --- a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst +++ b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst @@ -1,4 +1,4 @@ -``SHADOWED_VARIABLE_BASE_CLASS`` +SHADOWED_VARIABLE_BASE_CLASS ================================ When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst b/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst index 6cd2237f12d..7f27feb2d43 100644 --- a/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst +++ b/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst @@ -1,4 +1,4 @@ -``STANDALONE_EXPRESSION`` +STANDALONE_EXPRESSION ========================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst b/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst index c22b8bf826f..951cdeaef75 100644 --- a/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst +++ b/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst @@ -1,4 +1,4 @@ -``STANDALONE_TERNARY`` +STANDALONE_TERNARY ====================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst b/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst index d7d388f8159..f05482c6a16 100644 --- a/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst +++ b/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst @@ -1,4 +1,4 @@ -``STATIC_CALLED_ON_INSTANCE`` +STATIC_CALLED_ON_INSTANCE ============================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst index 75e76b313a3..15a1eb04db8 100644 --- a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst +++ b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst @@ -1,4 +1,4 @@ -``UNASSIGNED_VARIABLE`` +UNASSIGNED_VARIABLE ======================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst index 6546e5fc65d..25b69b82134 100644 --- a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst +++ b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst @@ -1,4 +1,4 @@ -``UNASSIGNED_VARIABLE_OP_ASSIGN`` +UNASSIGNED_VARIABLE_OP_ASSIGN ================================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst b/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst index 7c3ce1da92c..156c7cb41b9 100644 --- a/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst +++ b/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst @@ -1,4 +1,4 @@ -``UNREACHABLE_CODE`` +UNREACHABLE_CODE ==================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst b/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst index e16f85047ac..133d7feceba 100644 --- a/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst +++ b/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst @@ -1,4 +1,4 @@ -``UNREACHABLE_PATTERN`` +UNREACHABLE_PATTERN ======================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst index d480f12917a..5d9060ac976 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst @@ -1,4 +1,4 @@ -``UNSAFE_CALL_ARGUMENT`` +UNSAFE_CALL_ARGUMENT ======================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst index 68e3f36779c..bd12b72c251 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst @@ -1,4 +1,4 @@ -``UNSAFE_CAST`` +UNSAFE_CAST =============== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst index 9414c8d12e2..b22bc108eed 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst @@ -1,4 +1,4 @@ -``UNSAFE_METHOD_ACCESS`` +UNSAFE_METHOD_ACCESS ======================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst index c30152dfba3..c142129d6c9 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst @@ -1,4 +1,4 @@ -``UNSAFE_PROPERTY_ACCESS`` +UNSAFE_PROPERTY_ACCESS ========================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst index 2b21fa047a6..2d42d871de9 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst @@ -1,4 +1,4 @@ -``UNSAFE_VOID_RETURN`` +UNSAFE_VOID_RETURN ====================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst index bf81eeb9d0a..e98f48c29a3 100644 --- a/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst +++ b/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst @@ -1,4 +1,4 @@ -``UNTYPED_DECLARATION`` +UNTYPED_DECLARATION ======================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst b/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst index 9c769201abd..f05cb1a3a02 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst @@ -1,4 +1,4 @@ -``UNUSED_LOCAL_CONSTANT`` +UNUSED_LOCAL_CONSTANT ========================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst b/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst index 4b0144418d2..bb46eb25d43 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst @@ -1,4 +1,4 @@ -``UNUSED_PARAMETER`` +UNUSED_PARAMETER ==================== When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst index 08665332b1c..fd4315b2b14 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst @@ -1,4 +1,4 @@ -``UNUSED_PRIVATE_CLASS_VARIABLE`` +UNUSED_PRIVATE_CLASS_VARIABLE ================================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst b/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst index efdeb4c435f..e325e8ad2ef 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst @@ -1,4 +1,4 @@ -``UNUSED_SIGNAL`` +UNUSED_SIGNAL ================= When this warning occurs diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst index 93908bf8c87..738fabc82df 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst @@ -1,4 +1,4 @@ -``UNUSED_VARIABLE`` +UNUSED_VARIABLE =================== When this warning occurs From eac8c53ef677672f244d0b7b981916214d8820ab Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Fri, 7 Feb 2025 13:11:01 -0800 Subject: [PATCH 04/36] Improvements to `GET_NODE_DEFAULT_WITHOUT_ONREADY` prototype page --- .../warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst b/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst index c10f9c39637..bb048b45351 100644 --- a/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst +++ b/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst @@ -2,24 +2,31 @@ GET_NODE_DEFAULT_WITHOUT_ONREADY ==================================== This warning appears when a node's default value is set to a location in the scene tree without using the ``@onready`` annotation. -The message will say something like: + +Depending on how you attempt to access the scene tree, the warning message will be one of the following: .. code-block:: none The default value is using "$" which won't return nodes in the scene tree before "_ready()" is called. Use the "@onready" annotation to solve this. + The default value is using "%" which won't return nodes in the scene tree before "_ready()" is called. Use the "@onready" annotation to solve this. + + The default value is using "get_node()" which won't return nodes in the scene tree before "_ready()" is called. Use the "@onready" annotation to solve this. + When this warning occurs ------------------------ In GDScript, instance variables can be set by declaring them outside of a method. Additionally, they can be given a default value using ``=``:: extends Area2D + var my_num = 3 This way, the variable ``my_num`` will always start out with a value of ``3`` in each instance of this class. GDScript also has methods to retrieve specific nodes from the scene tree: namely, the :ref:`get_node() ` method, and its shorthand versions ``$`` (and ``%`` for unique nodes). Thus, if you want to have an instance variable default to a child of the node with a script, it may be tempting to write something like the following:: extends Area2D + var my_collision_shape = $CollisionShape2D However, class instance variables' default values are evaluated and assigned before the scene tree is set up. This means that at the time of assigning the default value, the node may not be in the scene tree, and the variable will be set to ``null`` instead. @@ -30,13 +37,15 @@ How to fix this warning The most straightforward solution is to add the ``@onready`` annotation before your variable declaration:: extends Area2D + @onready var my_collision_shape = $CollisionShape2D Now, the default value of the variable will not be assigned until the scene tree has been initialized, and the target node will be present. -Alternatively, you can set the value of the variable at the beginning of your ``_ready`` method:: +Alternatively, you can set the value of the variable at the beginning of your ``_ready()`` method:: extends Area2D + var my_collision_shape func _ready(): From 524ab62723a98eb3714c61e4ace60156c4bc944d Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Fri, 7 Feb 2025 13:50:49 -0800 Subject: [PATCH 05/36] Add warning messages that display in editor (placeholder %s kept) --- .../scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst | 6 ++++++ .../scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst | 6 ++++++ .../gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst | 6 ++++++ .../scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst | 6 ++++++ .../gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst | 6 ++++++ .../gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst | 6 ++++++ .../scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst | 6 ++++++ tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst | 6 ++++++ .../gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst | 6 ++++++ .../scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst | 6 ++++++ .../scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst | 6 ++++++ .../scripting/gdscript/warnings/INFERRED_DECLARATION.rst | 6 ++++++ .../scripting/gdscript/warnings/INTEGER_DIVISION.rst | 6 ++++++ .../gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst | 6 ++++++ .../gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst | 6 ++++++ tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst | 6 ++++++ .../scripting/gdscript/warnings/NARROWING_CONVERSION.rst | 6 ++++++ .../gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst | 6 ++++++ .../scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst | 6 ++++++ tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst | 6 ++++++ .../gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst | 6 ++++++ .../gdscript/warnings/RETURN_VALUE_DISCARDED.rst | 6 ++++++ .../gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst | 6 ++++++ .../scripting/gdscript/warnings/SHADOWED_VARIABLE.rst | 6 ++++++ .../gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst | 6 ++++++ .../scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst | 6 ++++++ .../scripting/gdscript/warnings/STANDALONE_TERNARY.rst | 6 ++++++ .../gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst | 6 ++++++ .../scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst | 6 ++++++ .../gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst | 6 ++++++ .../scripting/gdscript/warnings/UNREACHABLE_CODE.rst | 6 ++++++ .../scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst | 6 ++++++ .../scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst | 6 ++++++ tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst | 6 ++++++ .../scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst | 6 ++++++ .../gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst | 6 ++++++ .../scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst | 6 ++++++ .../scripting/gdscript/warnings/UNTYPED_DECLARATION.rst | 8 ++++++++ .../scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst | 6 ++++++ .../scripting/gdscript/warnings/UNUSED_PARAMETER.rst | 6 ++++++ .../gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst | 6 ++++++ tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst | 6 ++++++ tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst | 6 ++++++ 43 files changed, 260 insertions(+) diff --git a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst index cd7d6bcea16..318d1130a27 100644 --- a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst +++ b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst @@ -1,6 +1,12 @@ ASSERT_ALWAYS_FALSE ======================= +The warning message is: + +.. code-block:: none + + Assert statement will raise an error because the expression is always false. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst index 77659bbd39c..07497224c96 100644 --- a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst +++ b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst @@ -1,6 +1,12 @@ ASSERT_ALWAYS_TRUE ====================== +The warning message is: + +.. code-block:: none + + Assert statement is redundant because the expression is always true. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst index 091e03bd81a..52d7c888a3c 100644 --- a/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst @@ -1,6 +1,12 @@ CONFUSABLE_CAPTURE_REASSIGNMENT =================================== +The warning message is: + +.. code-block:: none + + Reassigning lambda capture does not modify the outer local variable "%s". + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst index 905a48916ec..4c5cf132fb1 100644 --- a/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst @@ -1,6 +1,12 @@ CONFUSABLE_IDENTIFIER ========================= +The warning message is: + +.. code-block:: none + + The identifier "%s" has misleading characters and might be confused with something else. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst index 06616a7672b..b57cf5d8950 100644 --- a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst @@ -1,6 +1,12 @@ CONFUSABLE_LOCAL_DECLARATION ================================ +The warning message is: + +.. code-block:: none + + The %s "%s" is declared below in the parent block. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst index fb3b14ed829..7112753f245 100644 --- a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst @@ -1,6 +1,12 @@ CONFUSABLE_LOCAL_USAGE ========================== +The warning message is: + +.. code-block:: none + + The identifier "%s" will be shadowed below in the block. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst b/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst index 852d37add31..d99fefa820a 100644 --- a/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst +++ b/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst @@ -1,6 +1,12 @@ DEPRECATED_KEYWORD ====================== +The warning message is: + +.. code-block:: none + + The "%s" keyword is deprecated and will be removed in a future release, please replace its uses by "%s". + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst b/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst index fd02922d2f4..883237ddb5d 100644 --- a/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst +++ b/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst @@ -1,6 +1,12 @@ EMPTY_FILE ============== +The warning message is: + +.. code-block:: none + + Empty script file. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst b/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst index 8865cfd0e0a..9f233fff0b1 100644 --- a/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst +++ b/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst @@ -1,6 +1,12 @@ ENUM_VARIABLE_WITHOUT_DEFAULT ================================= +The warning message is: + +.. code-block:: none + + The variable "%s" has an enum type and does not set an explicit default value. The default will be set to "0". + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst b/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst index 7c972a33315..6e768e8a5fa 100644 --- a/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst +++ b/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst @@ -1,6 +1,12 @@ INCOMPATIBLE_TERNARY ======================== +The warning message is: + +.. code-block:: none + + Values of the ternary operator are not mutually compatible. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst b/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst index 93f86e27ff4..73f088551aa 100644 --- a/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst +++ b/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst @@ -1,6 +1,12 @@ INFERENCE_ON_VARIANT ======================== +The warning message is: + +.. code-block:: none + + The %s type is being inferred from a Variant value, so it will be typed as Variant. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst index 2b6619bc9bd..e28abf2a04d 100644 --- a/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst +++ b/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst @@ -1,6 +1,12 @@ INFERRED_DECLARATION ======================== +The warning message is: + +.. code-block:: none + + %s "%s" has an implicitly inferred static type. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst b/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst index 362fee71b15..58bb8e98ce2 100644 --- a/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst +++ b/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst @@ -1,6 +1,12 @@ INTEGER_DIVISION ==================== +The warning message is: + +.. code-block:: none + + Integer division, decimal part will be discarded. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst index e1d9264ef73..deeea61ee50 100644 --- a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst +++ b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst @@ -1,6 +1,12 @@ INT_AS_ENUM_WITHOUT_CAST ============================ +The warning message is: + +.. code-block:: none + + Integer used when an enum value is expected. If this is intended cast the integer to the enum type. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst index 59f8ca39748..7c548ed4574 100644 --- a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst +++ b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst @@ -1,6 +1,12 @@ INT_AS_ENUM_WITHOUT_MATCH ============================= +The warning message is: + +.. code-block:: none + + Cannot %s %s as Enum "%s": no enum member has matching value. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst b/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst index a499a8619f1..78443292b91 100644 --- a/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst +++ b/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst @@ -1,6 +1,12 @@ MISSING_TOOL ================ +The warning message is: + +.. code-block:: none + + The base class script has the "@tool" annotation, but this script does not have it. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst b/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst index 5b2c0885880..780ea70616c 100644 --- a/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst +++ b/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst @@ -1,6 +1,12 @@ NARROWING_CONVERSION ======================== +The warning message is: + +.. code-block:: none + + Narrowing conversion (float is converted to int and loses precision). + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst b/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst index abc3ffc7d74..78df4491d1f 100644 --- a/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst +++ b/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst @@ -1,6 +1,12 @@ NATIVE_METHOD_OVERRIDE ========================== +The warning message is: + +.. code-block:: none + + The method "%s()" overrides a method from native class "%s". This won't be called by the engine and may not work as expected. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst b/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst index 8ada4460d40..94620d33dd4 100644 --- a/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst +++ b/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst @@ -1,6 +1,12 @@ ONREADY_WITH_EXPORT ======================= +The warning message is: + +.. code-block:: none + + "@onready" will set the default value after "@export" takes effect and will override it. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst b/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst index 3b9c15f628a..0566733ba96 100644 --- a/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst +++ b/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst @@ -1,6 +1,12 @@ REDUNDANT_AWAIT =================== +The warning message is: + +.. code-block:: none + + "await" keyword not needed in this case, because the expression isn't a coroutine nor a signal. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst b/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst index fa0d428db68..4643b42b5ee 100644 --- a/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst +++ b/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst @@ -1,6 +1,12 @@ REDUNDANT_STATIC_UNLOAD =========================== +The warning message is: + +.. code-block:: none + + The "@static_unload" annotation is redundant because the file does not have a class with static variables. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst b/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst index 4cf2480fe4a..38004ce6c2a 100644 --- a/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst +++ b/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst @@ -1,6 +1,12 @@ RETURN_VALUE_DISCARDED ========================== +The warning message is: + +.. code-block:: none + + The function "%s()" returns a value that will be discarded if not used. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst b/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst index d7c85fa088a..f3d3241ee0e 100644 --- a/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst +++ b/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst @@ -1,6 +1,12 @@ SHADOWED_GLOBAL_IDENTIFIER ============================== +The warning message is: + +.. code-block:: none + + The %s "%s" has the same name as a %s. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst index 5dad7e68457..1fa9f026854 100644 --- a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst +++ b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst @@ -1,6 +1,12 @@ SHADOWED_VARIABLE ===================== +The warning message is: + +.. code-block:: none + + The local %s "%s" is shadowing an already-declared %s at line %s in the current class. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst index d24ae04ca49..60105afd38f 100644 --- a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst +++ b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst @@ -1,6 +1,12 @@ SHADOWED_VARIABLE_BASE_CLASS ================================ +The warning message is: + +.. code-block:: none + + The local %s "%s" is shadowing an already-declared %s at line %s in the base class "%s". + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst b/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst index 7f27feb2d43..1489034ff7a 100644 --- a/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst +++ b/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst @@ -1,6 +1,12 @@ STANDALONE_EXPRESSION ========================= +The warning message is: + +.. code-block:: none + + Standalone expression (the line may have no effect). + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst b/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst index 951cdeaef75..e5bc45a3899 100644 --- a/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst +++ b/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst @@ -1,6 +1,12 @@ STANDALONE_TERNARY ====================== +The warning message is: + +.. code-block:: none + + Standalone ternary operator: the return value is being discarded. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst b/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst index f05482c6a16..224fd4c399a 100644 --- a/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst +++ b/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst @@ -1,6 +1,12 @@ STATIC_CALLED_ON_INSTANCE ============================= +The warning message is: + +.. code-block:: none + + The function "%s()" is a static function but was called from an instance. Instead, it should be directly called from the type: "%s.%s()". + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst index 15a1eb04db8..6a3ab85c34d 100644 --- a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst +++ b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst @@ -1,6 +1,12 @@ UNASSIGNED_VARIABLE ======================= +The warning message is: + +.. code-block:: none + + The variable "%s" was used before being assigned a value. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst index 25b69b82134..905d5828678 100644 --- a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst +++ b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst @@ -1,6 +1,12 @@ UNASSIGNED_VARIABLE_OP_ASSIGN ================================= +The warning message is: + +.. code-block:: none + + Using assignment with operation but the variable "%s" was not previously assigned a value. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst b/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst index 156c7cb41b9..582ab1996e8 100644 --- a/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst +++ b/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst @@ -1,6 +1,12 @@ UNREACHABLE_CODE ==================== +The warning message is: + +.. code-block:: none + + Unreachable code (statement after return) in function "%s()". + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst b/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst index 133d7feceba..8e2696385ef 100644 --- a/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst +++ b/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst @@ -1,6 +1,12 @@ UNREACHABLE_PATTERN ======================= +The warning message is: + +.. code-block:: none + + Unreachable pattern (pattern after wildcard or bind). + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst index 5d9060ac976..99f09fe4b55 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst @@ -1,6 +1,12 @@ UNSAFE_CALL_ARGUMENT ======================== +The warning message is: + +.. code-block:: none + + The argument %s of the %s "%s()" requires the subtype "%s" but the supertype "%s" was provided. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst index bd12b72c251..384f8ddf3c8 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst @@ -1,6 +1,12 @@ UNSAFE_CAST =============== +The warning message is: + +.. code-block:: none + + Casting "Variant" to "%s" is unsafe. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst index b22bc108eed..3acaa5f0c5a 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst @@ -1,6 +1,12 @@ UNSAFE_METHOD_ACCESS ======================== +The warning message is: + +.. code-block:: none + + The method "%s()" is not present on the inferred type "%s" (but may be present on a subtype). + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst index c142129d6c9..44b5e06cf38 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst @@ -1,6 +1,12 @@ UNSAFE_PROPERTY_ACCESS ========================== +The warning message is: + +.. code-block:: none + + The property "%s" is not present on the inferred type "%s" (but may be present on a subtype). + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst index 2d42d871de9..f3c64886f79 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst @@ -1,6 +1,12 @@ UNSAFE_VOID_RETURN ====================== +The warning message is: + +.. code-block:: none + + The method "%s()" returns "void" but it's trying to return a call to "%s()" that can't be ensured to also be "void". + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst index e98f48c29a3..231922d85c9 100644 --- a/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst +++ b/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst @@ -1,6 +1,14 @@ UNTYPED_DECLARATION ======================= +The warning message is: + +.. code-block:: none + + %s "%s()" has no static return type. + + %s "%s" has no static type. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst b/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst index f05cb1a3a02..29dcc738269 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst @@ -1,6 +1,12 @@ UNUSED_LOCAL_CONSTANT ========================= +The warning message is: + +.. code-block:: none + + The local constant "%s" is declared but never used in the block. If this is intended, prefix it with an underscore: "_%s". + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst b/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst index bb46eb25d43..76c3e8c26c6 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst @@ -1,6 +1,12 @@ UNUSED_PARAMETER ==================== +The warning message is: + +.. code-block:: none + + The parameter "%s" is never used in the function "%s()". If this is intended, prefix it with an underscore: "_%s". + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst index fd4315b2b14..5cb23e6fcae 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst @@ -1,6 +1,12 @@ UNUSED_PRIVATE_CLASS_VARIABLE ================================= +The warning message is: + +.. code-block:: none + + The class variable "%s" is declared but never used in the class. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst b/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst index e325e8ad2ef..fd4322a44ab 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst @@ -1,6 +1,12 @@ UNUSED_SIGNAL ================= +The warning message is: + +.. code-block:: none + + The signal "%s" is declared but never explicitly used in the class. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst index 738fabc82df..35b587a4177 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst @@ -1,6 +1,12 @@ UNUSED_VARIABLE =================== +The warning message is: + +.. code-block:: none + + The local variable "%s" is declared but never used in the block. If this is intended, prefix it with an underscore: "_%s". + When this warning occurs ------------------------ From d0bdcc7a7ec8bea3b9cd42765f75d9964e9fbdac Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Tue, 11 Feb 2025 21:45:06 -0800 Subject: [PATCH 06/36] Wrote for `ASSERT_ALWAYS_FALSE` and ASSERT_ALWAYS_TRUE` --- .../gdscript/warnings/ASSERT_ALWAYS_FALSE.rst | 18 ++++++++++++++++-- .../gdscript/warnings/ASSERT_ALWAYS_TRUE.rst | 15 +++++++++++++-- 2 files changed, 29 insertions(+), 4 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst index 318d1130a27..48464153fa8 100644 --- a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst +++ b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst @@ -10,13 +10,27 @@ The warning message is: When this warning occurs ------------------------ -TODO +The :ref:`assert() ` keyword can be used to ensure that a given condition is met before allowing code execution to continue. If the first argument passed to it evaluates to ``true``, the rest of the function will run as expected; if it is ``false``, then the project will stop. +If ``assert()`` is passed an expression that is guaranteed to be ``false``, then the ``assert()`` call will always stop the project. + +.. code-block:: + + # The boolean false will always be false, so this assert will always stop + # the program. + assert(false, "False is false") + + # Likewise, 5 will never be 6, so this assert will always stop the program. + assert(5 == 6, "5 isn't equal to 6") + + # This line of code won't be executed in debug builds because the editor + # will have stopped at the assert calls above. + print("Hello, world!") How to fix this warning ----------------------- -TODO +Assuming you want code following the ``assert()`` to run, remove it from your code. If you do want code execution to stop at that point, :ref:`consider using breakpoints instead `. diff --git a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst index 07497224c96..56599a3d5c2 100644 --- a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst +++ b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst @@ -10,13 +10,24 @@ The warning message is: When this warning occurs ------------------------ -TODO +The :ref:`assert() ` keyword can be used to ensure that a given condition is met before allowing code execution to continue. If the first argument passed to it evaluates to ``true``, the rest of the function will run as expected; if it is ``false``, then the project will stop. +If ``assert()`` is passed an expression that is guaranteed to be ``true``, then the ``assert()`` call will never stop the project, thus making it redundant. + +.. code-block:: + + # The boolean true will always be true, so this assert will never stop + # the program. + assert(true, "True is false, somehow?") + + # Likewise, 3 will never be equal to 4, so this assert will never stop + # the program. + assert(3 != 4, "3 is equal to 4") How to fix this warning ----------------------- -TODO +Remove the ``assert()`` statement from your code. From 1d179a13ababd1a4c9d1cc655248a48739c00e06 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Wed, 12 Feb 2025 14:07:56 -0800 Subject: [PATCH 07/36] Improve documentation for `ASSERT_ALWAYS_FALSE` --- .../gdscript/warnings/ASSERT_ALWAYS_FALSE.rst | 34 +++++++++++++------ 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst index 48464153fa8..806b72fc115 100644 --- a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst +++ b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst @@ -10,27 +10,39 @@ The warning message is: When this warning occurs ------------------------ -The :ref:`assert() ` keyword can be used to ensure that a given condition is met before allowing code execution to continue. If the first argument passed to it evaluates to ``true``, the rest of the function will run as expected; if it is ``false``, then the project will stop. +The :ref:`assert() ` keyword can be used to ensure that a given condition is met before allowing code execution to continue. If the first argument passed to it is truthy, the rest of the function will run as expected; if it is falsy, then the project will stop. -If ``assert()`` is passed an expression that is guaranteed to be ``false``, then the ``assert()`` call will always stop the project. +If ``assert()`` is passed something guaranteed to be falsy, then the ``assert()`` call will always stop the project. .. code-block:: - # The boolean false will always be false, so this assert will always stop - # the program. - assert(false, "False is false") + # Zero always evaluates to false. + assert(0, "Zero is falsy") - # Likewise, 5 will never be 6, so this assert will always stop the program. - assert(5 == 6, "5 isn't equal to 6") + # Likewise, an empty string always evaluates to false. + assert("", "An empty string is falsy") - # This line of code won't be executed in debug builds because the editor - # will have stopped at the assert calls above. - print("Hello, world!") +.. note:: + + Godot will *not* raise this warning if a literal falsy boolean is passed: + + .. code-block:: + + # Despite false being passed, this won't raise ASSERT_ALWAYS_FALSE. + assert(false, "False is false") + + # This evaluates to a boolean which is false, so it also won't raise + # the warning. + assert(3 == 4, "3 isn't equal to 4") + + This is because ``assert(false)`` calls are often used in development to forcibly halt program execution and avoid strange errors later on. + + See `issue #58087 `_ for more information. How to fix this warning ----------------------- -Assuming you want code following the ``assert()`` to run, remove it from your code. If you do want code execution to stop at that point, :ref:`consider using breakpoints instead `. +Assuming you want code following the ``assert()`` to run, remove it from your code. If you do want code execution to stop at that point, replace the condition with ``false``, or :ref:`consider using breakpoints instead `. From 375646e9e40b45c48fcbd99cfd94c299fcae49f2 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Wed, 12 Feb 2025 19:18:29 -0800 Subject: [PATCH 08/36] Update tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com> --- tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst index 806b72fc115..458154cdc33 100644 --- a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst +++ b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst @@ -37,7 +37,7 @@ If ``assert()`` is passed something guaranteed to be falsy, then the ``assert()` This is because ``assert(false)`` calls are often used in development to forcibly halt program execution and avoid strange errors later on. - See `issue #58087 `_ for more information. + See `GH-58087 `_ for more information. How to fix this warning ----------------------- From a2a6829c48fd3de20b63917e737b4b6497cb4497 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Sun, 23 Mar 2025 21:51:40 -0700 Subject: [PATCH 09/36] Add default warning levels to pages --- tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst | 2 ++ tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst | 2 ++ .../gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst | 2 ++ tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst | 2 ++ .../gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst | 2 ++ .../scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst | 2 ++ .../scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst | 2 ++ tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst | 2 ++ tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst | 2 ++ .../gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst | 2 ++ .../scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst | 2 ++ .../gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst | 2 ++ tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst | 2 ++ tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst | 2 ++ tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst | 2 ++ tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst | 2 ++ .../scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst | 2 ++ .../scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst | 2 ++ tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst | 2 ++ tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst | 2 ++ .../scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst | 2 ++ tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst | 2 ++ .../scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst | 2 ++ tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst | 2 ++ .../scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst | 2 ++ .../scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst | 2 ++ .../scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst | 2 ++ tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst | 2 ++ .../gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst | 2 ++ tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst | 2 ++ tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst | 2 ++ .../scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst | 2 ++ tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst | 2 ++ .../gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst | 2 ++ tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst | 2 ++ tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst | 2 ++ tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst | 2 ++ tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst | 2 ++ tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst | 2 ++ .../scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst | 2 ++ tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst | 2 ++ tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst | 2 ++ tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst | 2 ++ tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst | 2 ++ .../gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst | 2 ++ tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst | 2 ++ tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst | 2 ++ 47 files changed, 94 insertions(+) diff --git a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst index 458154cdc33..f8ce8205483 100644 --- a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst +++ b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst @@ -7,6 +7,8 @@ The warning message is: Assert statement will raise an error because the expression is always false. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst index 56599a3d5c2..323e0c7217e 100644 --- a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst +++ b/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst @@ -7,6 +7,8 @@ The warning message is: Assert statement is redundant because the expression is always true. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst index 52d7c888a3c..e7f467f6a31 100644 --- a/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst @@ -7,6 +7,8 @@ The warning message is: Reassigning lambda capture does not modify the outer local variable "%s". +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst index 4c5cf132fb1..50c0a127c36 100644 --- a/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst @@ -7,6 +7,8 @@ The warning message is: The identifier "%s" has misleading characters and might be confused with something else. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst index b57cf5d8950..43560b4b5ad 100644 --- a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst @@ -7,6 +7,8 @@ The warning message is: The %s "%s" is declared below in the parent block. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst index 7112753f245..8e2716d86ea 100644 --- a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst @@ -7,6 +7,8 @@ The warning message is: The identifier "%s" will be shadowed below in the block. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst b/tutorials/scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst index 1a01c406e30..b231bfba89e 100644 --- a/tutorials/scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst +++ b/tutorials/scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst @@ -1,6 +1,8 @@ CONSTANT_USED_AS_FUNCTION ============================= +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst b/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst index d99fefa820a..75d6de3bad3 100644 --- a/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst +++ b/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst @@ -7,6 +7,8 @@ The warning message is: The "%s" keyword is deprecated and will be removed in a future release, please replace its uses by "%s". +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst b/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst index 883237ddb5d..5cb2b1f068a 100644 --- a/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst +++ b/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst @@ -7,6 +7,8 @@ The warning message is: Empty script file. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst b/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst index 9f233fff0b1..a75b2271971 100644 --- a/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst +++ b/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst @@ -7,6 +7,8 @@ The warning message is: The variable "%s" has an enum type and does not set an explicit default value. The default will be set to "0". +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst b/tutorials/scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst index 32e3af72274..9ff4340bfb5 100644 --- a/tutorials/scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst +++ b/tutorials/scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst @@ -1,6 +1,8 @@ FUNCTION_USED_AS_PROPERTY ============================= +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst b/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst index bb048b45351..db94cc07efa 100644 --- a/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst +++ b/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst @@ -13,6 +13,8 @@ Depending on how you attempt to access the scene tree, the warning message will The default value is using "get_node()" which won't return nodes in the scene tree before "_ready()" is called. Use the "@onready" annotation to solve this. +The default warning level for this warning is **Error**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst b/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst index 6e768e8a5fa..70d90d79f1d 100644 --- a/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst +++ b/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst @@ -7,6 +7,8 @@ The warning message is: Values of the ternary operator are not mutually compatible. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst b/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst index 73f088551aa..8b29da4d382 100644 --- a/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst +++ b/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst @@ -7,6 +7,8 @@ The warning message is: The %s type is being inferred from a Variant value, so it will be typed as Variant. +The default warning level for this warning is **Error**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst index e28abf2a04d..6fadfbf07fd 100644 --- a/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst +++ b/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst @@ -7,6 +7,8 @@ The warning message is: %s "%s" has an implicitly inferred static type. +The default warning level for this warning is **Ignore**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst b/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst index 58bb8e98ce2..76493804653 100644 --- a/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst +++ b/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst @@ -7,6 +7,8 @@ The warning message is: Integer division, decimal part will be discarded. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst index deeea61ee50..71c5d72fdf9 100644 --- a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst +++ b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst @@ -7,6 +7,8 @@ The warning message is: Integer used when an enum value is expected. If this is intended cast the integer to the enum type. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst index 7c548ed4574..8b18644fc55 100644 --- a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst +++ b/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst @@ -7,6 +7,8 @@ The warning message is: Cannot %s %s as Enum "%s": no enum member has matching value. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst b/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst index 78443292b91..5d005cd0518 100644 --- a/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst +++ b/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst @@ -7,6 +7,8 @@ The warning message is: The base class script has the "@tool" annotation, but this script does not have it. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst b/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst index 780ea70616c..9170b32f17a 100644 --- a/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst +++ b/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst @@ -7,6 +7,8 @@ The warning message is: Narrowing conversion (float is converted to int and loses precision). +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst b/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst index 78df4491d1f..02fcb20789b 100644 --- a/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst +++ b/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst @@ -7,6 +7,8 @@ The warning message is: The method "%s()" overrides a method from native class "%s". This won't be called by the engine and may not work as expected. +The default warning level for this warning is **Error**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst b/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst index 94620d33dd4..efc2e1e5a09 100644 --- a/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst +++ b/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst @@ -7,6 +7,8 @@ The warning message is: "@onready" will set the default value after "@export" takes effect and will override it. +The default warning level for this warning is **Error**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst b/tutorials/scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst index 903dc5490a1..896971819d0 100644 --- a/tutorials/scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst +++ b/tutorials/scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst @@ -1,6 +1,8 @@ PROPERTY_USED_AS_FUNCTION ============================= +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst b/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst index 0566733ba96..4f45dee738d 100644 --- a/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst +++ b/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst @@ -7,6 +7,8 @@ The warning message is: "await" keyword not needed in this case, because the expression isn't a coroutine nor a signal. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst b/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst index 4643b42b5ee..a5f5137eed9 100644 --- a/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst +++ b/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst @@ -7,6 +7,8 @@ The warning message is: The "@static_unload" annotation is redundant because the file does not have a class with static variables. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst b/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst index 38004ce6c2a..08fbe2fd8bb 100644 --- a/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst +++ b/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst @@ -7,6 +7,8 @@ The warning message is: The function "%s()" returns a value that will be discarded if not used. +The default warning level for this warning is **Ignore**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst b/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst index f3d3241ee0e..8bcfd38d168 100644 --- a/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst +++ b/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst @@ -7,6 +7,8 @@ The warning message is: The %s "%s" has the same name as a %s. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst index 1fa9f026854..c8a7ef27b0c 100644 --- a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst +++ b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst @@ -7,6 +7,8 @@ The warning message is: The local %s "%s" is shadowing an already-declared %s at line %s in the current class. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst index 60105afd38f..4024f9bdae9 100644 --- a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst +++ b/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst @@ -7,6 +7,8 @@ The warning message is: The local %s "%s" is shadowing an already-declared %s at line %s in the base class "%s". +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst b/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst index 1489034ff7a..2b50e1d4529 100644 --- a/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst +++ b/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst @@ -7,6 +7,8 @@ The warning message is: Standalone expression (the line may have no effect). +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst b/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst index e5bc45a3899..4184ced2d91 100644 --- a/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst +++ b/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst @@ -7,6 +7,8 @@ The warning message is: Standalone ternary operator: the return value is being discarded. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst b/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst index 224fd4c399a..d47148c66ad 100644 --- a/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst +++ b/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst @@ -7,6 +7,8 @@ The warning message is: The function "%s()" is a static function but was called from an instance. Instead, it should be directly called from the type: "%s.%s()". +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst index 6a3ab85c34d..af0ec9050c5 100644 --- a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst +++ b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst @@ -7,6 +7,8 @@ The warning message is: The variable "%s" was used before being assigned a value. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst index 905d5828678..e2bb855c2df 100644 --- a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst +++ b/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst @@ -7,6 +7,8 @@ The warning message is: Using assignment with operation but the variable "%s" was not previously assigned a value. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst b/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst index 582ab1996e8..3b87c11aaa0 100644 --- a/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst +++ b/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst @@ -7,6 +7,8 @@ The warning message is: Unreachable code (statement after return) in function "%s()". +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst b/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst index 8e2696385ef..1ff400314d1 100644 --- a/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst +++ b/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst @@ -7,6 +7,8 @@ The warning message is: Unreachable pattern (pattern after wildcard or bind). +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst index 99f09fe4b55..45fa5f0b62e 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst @@ -7,6 +7,8 @@ The warning message is: The argument %s of the %s "%s()" requires the subtype "%s" but the supertype "%s" was provided. +The default warning level for this warning is **Ignore**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst index 384f8ddf3c8..5fd4f49869e 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst @@ -7,6 +7,8 @@ The warning message is: Casting "Variant" to "%s" is unsafe. +The default warning level for this warning is **Ignore**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst index 3acaa5f0c5a..149b7697d46 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst @@ -7,6 +7,8 @@ The warning message is: The method "%s()" is not present on the inferred type "%s" (but may be present on a subtype). +The default warning level for this warning is **Ignore**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst index 44b5e06cf38..3bd4ca21afa 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst @@ -7,6 +7,8 @@ The warning message is: The property "%s" is not present on the inferred type "%s" (but may be present on a subtype). +The default warning level for this warning is **Ignore**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst b/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst index f3c64886f79..3c2354ec47d 100644 --- a/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst +++ b/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst @@ -7,6 +7,8 @@ The warning message is: The method "%s()" returns "void" but it's trying to return a call to "%s()" that can't be ensured to also be "void". +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst index 231922d85c9..f72f441cb15 100644 --- a/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst +++ b/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst @@ -9,6 +9,8 @@ The warning message is: %s "%s" has no static type. +The default warning level for this warning is **Ignore**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst b/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst index 29dcc738269..b528e21434b 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst @@ -7,6 +7,8 @@ The warning message is: The local constant "%s" is declared but never used in the block. If this is intended, prefix it with an underscore: "_%s". +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst b/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst index 76c3e8c26c6..97e4cbad95d 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst @@ -7,6 +7,8 @@ The warning message is: The parameter "%s" is never used in the function "%s()". If this is intended, prefix it with an underscore: "_%s". +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst index 5cb23e6fcae..cf3363856ea 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst @@ -7,6 +7,8 @@ The warning message is: The class variable "%s" is declared but never used in the class. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst b/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst index fd4322a44ab..6a5bada2148 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst @@ -7,6 +7,8 @@ The warning message is: The signal "%s" is declared but never explicitly used in the class. +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst index 35b587a4177..551a680cfe0 100644 --- a/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst +++ b/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst @@ -7,6 +7,8 @@ The warning message is: The local variable "%s" is declared but never used in the block. If this is intended, prefix it with an underscore: "_%s". +The default warning level for this warning is **Warn**. + When this warning occurs ------------------------ From 28f1c4844e2090ee6dd36e56cbca296a1bbbfd16 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Wed, 26 Mar 2025 22:11:50 -0700 Subject: [PATCH 10/36] Update a few pages to use placeholder variable names --- .../gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst | 2 +- .../scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst | 2 +- .../gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst index e7f467f6a31..163fd62ed8e 100644 --- a/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - Reassigning lambda capture does not modify the outer local variable "%s". + Reassigning lambda capture does not modify the outer local variable "my_var". The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst index 8e2716d86ea..7404674ed3a 100644 --- a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst +++ b/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The identifier "%s" will be shadowed below in the block. + The identifier "my_var" will be shadowed below in the block. The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst b/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst index a75b2271971..3643f8aeed7 100644 --- a/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst +++ b/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The variable "%s" has an enum type and does not set an explicit default value. The default will be set to "0". + The variable "my_var" has an enum type and does not set an explicit default value. The default will be set to "0". The default warning level for this warning is **Warn**. From 1375d4ff73bd11077cb244261049f195618890ae Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Wed, 26 Mar 2025 22:25:06 -0700 Subject: [PATCH 11/36] Use `snake_case` for page names --- ...WAYS_FALSE.rst => assert_always_false.rst} | 0 ...ALWAYS_TRUE.rst => assert_always_true.rst} | 0 ...st => confusable_capture_reassignment.rst} | 0 ...ENTIFIER.rst => confusable_identifier.rst} | 0 ...N.rst => confusable_local_declaration.rst} | 0 ...L_USAGE.rst => confusable_local_usage.rst} | 0 ...TION.rst => constant_used_as_function.rst} | 0 ...TED_KEYWORD.rst => deprecated_keyword.rst} | 0 .../{EMPTY_FILE.rst => empty_file.rst} | 0 ....rst => enum_variable_without_default.rst} | 0 ...ERTY.rst => function_used_as_property.rst} | 0 ...t => get_node_default_without_onready.rst} | 0 ...E_TERNARY.rst => incompatible_ternary.rst} | 0 .../scripting/gdscript/warnings/index.rst | 94 +++++++++---------- ...N_VARIANT.rst => inference_on_variant.rst} | 0 ...CLARATION.rst => inferred_declaration.rst} | 0 ..._CAST.rst => int_as_enum_without_cast.rst} | 0 ...ATCH.rst => int_as_enum_without_match.rst} | 0 ...EGER_DIVISION.rst => integer_division.rst} | 0 .../{MISSING_TOOL.rst => missing_tool.rst} | 0 ...ONVERSION.rst => narrowing_conversion.rst} | 0 ...VERRIDE.rst => native_method_override.rst} | 0 ...ITH_EXPORT.rst => onready_with_export.rst} | 0 ...TION.rst => property_used_as_function.rst} | 0 ...EDUNDANT_AWAIT.rst => redundant_await.rst} | 0 ...UNLOAD.rst => redundant_static_unload.rst} | 0 ...SCARDED.rst => return_value_discarded.rst} | 0 ...IER.rst => shadowed_global_identifier.rst} | 0 ...WED_VARIABLE.rst => shadowed_variable.rst} | 0 ...S.rst => shadowed_variable_base_class.rst} | 0 ...PRESSION.rst => standalone_expression.rst} | 0 ...ONE_TERNARY.rst => standalone_ternary.rst} | 0 ...ANCE.rst => static_called_on_instance.rst} | 0 ...D_VARIABLE.rst => unassigned_variable.rst} | 0 ....rst => unassigned_variable_op_assign.rst} | 0 ...EACHABLE_CODE.rst => unreachable_code.rst} | 0 ...LE_PATTERN.rst => unreachable_pattern.rst} | 0 ..._ARGUMENT.rst => unsafe_call_argument.rst} | 0 .../{UNSAFE_CAST.rst => unsafe_cast.rst} | 0 ...OD_ACCESS.rst => unsafe_method_access.rst} | 0 ..._ACCESS.rst => unsafe_property_access.rst} | 0 ...VOID_RETURN.rst => unsafe_void_return.rst} | 0 ...ECLARATION.rst => untyped_declaration.rst} | 0 ...CONSTANT.rst => unused_local_constant.rst} | 0 ...SED_PARAMETER.rst => unused_parameter.rst} | 0 ....rst => unused_private_class_variable.rst} | 0 .../{UNUSED_SIGNAL.rst => unused_signal.rst} | 0 ...NUSED_VARIABLE.rst => unused_variable.rst} | 0 48 files changed, 47 insertions(+), 47 deletions(-) rename tutorials/scripting/gdscript/warnings/{ASSERT_ALWAYS_FALSE.rst => assert_always_false.rst} (100%) rename tutorials/scripting/gdscript/warnings/{ASSERT_ALWAYS_TRUE.rst => assert_always_true.rst} (100%) rename tutorials/scripting/gdscript/warnings/{CONFUSABLE_CAPTURE_REASSIGNMENT.rst => confusable_capture_reassignment.rst} (100%) rename tutorials/scripting/gdscript/warnings/{CONFUSABLE_IDENTIFIER.rst => confusable_identifier.rst} (100%) rename tutorials/scripting/gdscript/warnings/{CONFUSABLE_LOCAL_DECLARATION.rst => confusable_local_declaration.rst} (100%) rename tutorials/scripting/gdscript/warnings/{CONFUSABLE_LOCAL_USAGE.rst => confusable_local_usage.rst} (100%) rename tutorials/scripting/gdscript/warnings/{CONSTANT_USED_AS_FUNCTION.rst => constant_used_as_function.rst} (100%) rename tutorials/scripting/gdscript/warnings/{DEPRECATED_KEYWORD.rst => deprecated_keyword.rst} (100%) rename tutorials/scripting/gdscript/warnings/{EMPTY_FILE.rst => empty_file.rst} (100%) rename tutorials/scripting/gdscript/warnings/{ENUM_VARIABLE_WITHOUT_DEFAULT.rst => enum_variable_without_default.rst} (100%) rename tutorials/scripting/gdscript/warnings/{FUNCTION_USED_AS_PROPERTY.rst => function_used_as_property.rst} (100%) rename tutorials/scripting/gdscript/warnings/{GET_NODE_DEFAULT_WITHOUT_ONREADY.rst => get_node_default_without_onready.rst} (100%) rename tutorials/scripting/gdscript/warnings/{INCOMPATIBLE_TERNARY.rst => incompatible_ternary.rst} (100%) rename tutorials/scripting/gdscript/warnings/{INFERENCE_ON_VARIANT.rst => inference_on_variant.rst} (100%) rename tutorials/scripting/gdscript/warnings/{INFERRED_DECLARATION.rst => inferred_declaration.rst} (100%) rename tutorials/scripting/gdscript/warnings/{INT_AS_ENUM_WITHOUT_CAST.rst => int_as_enum_without_cast.rst} (100%) rename tutorials/scripting/gdscript/warnings/{INT_AS_ENUM_WITHOUT_MATCH.rst => int_as_enum_without_match.rst} (100%) rename tutorials/scripting/gdscript/warnings/{INTEGER_DIVISION.rst => integer_division.rst} (100%) rename tutorials/scripting/gdscript/warnings/{MISSING_TOOL.rst => missing_tool.rst} (100%) rename tutorials/scripting/gdscript/warnings/{NARROWING_CONVERSION.rst => narrowing_conversion.rst} (100%) rename tutorials/scripting/gdscript/warnings/{NATIVE_METHOD_OVERRIDE.rst => native_method_override.rst} (100%) rename tutorials/scripting/gdscript/warnings/{ONREADY_WITH_EXPORT.rst => onready_with_export.rst} (100%) rename tutorials/scripting/gdscript/warnings/{PROPERTY_USED_AS_FUNCTION.rst => property_used_as_function.rst} (100%) rename tutorials/scripting/gdscript/warnings/{REDUNDANT_AWAIT.rst => redundant_await.rst} (100%) rename tutorials/scripting/gdscript/warnings/{REDUNDANT_STATIC_UNLOAD.rst => redundant_static_unload.rst} (100%) rename tutorials/scripting/gdscript/warnings/{RETURN_VALUE_DISCARDED.rst => return_value_discarded.rst} (100%) rename tutorials/scripting/gdscript/warnings/{SHADOWED_GLOBAL_IDENTIFIER.rst => shadowed_global_identifier.rst} (100%) rename tutorials/scripting/gdscript/warnings/{SHADOWED_VARIABLE.rst => shadowed_variable.rst} (100%) rename tutorials/scripting/gdscript/warnings/{SHADOWED_VARIABLE_BASE_CLASS.rst => shadowed_variable_base_class.rst} (100%) rename tutorials/scripting/gdscript/warnings/{STANDALONE_EXPRESSION.rst => standalone_expression.rst} (100%) rename tutorials/scripting/gdscript/warnings/{STANDALONE_TERNARY.rst => standalone_ternary.rst} (100%) rename tutorials/scripting/gdscript/warnings/{STATIC_CALLED_ON_INSTANCE.rst => static_called_on_instance.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNASSIGNED_VARIABLE.rst => unassigned_variable.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNASSIGNED_VARIABLE_OP_ASSIGN.rst => unassigned_variable_op_assign.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNREACHABLE_CODE.rst => unreachable_code.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNREACHABLE_PATTERN.rst => unreachable_pattern.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNSAFE_CALL_ARGUMENT.rst => unsafe_call_argument.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNSAFE_CAST.rst => unsafe_cast.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNSAFE_METHOD_ACCESS.rst => unsafe_method_access.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNSAFE_PROPERTY_ACCESS.rst => unsafe_property_access.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNSAFE_VOID_RETURN.rst => unsafe_void_return.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNTYPED_DECLARATION.rst => untyped_declaration.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNUSED_LOCAL_CONSTANT.rst => unused_local_constant.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNUSED_PARAMETER.rst => unused_parameter.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNUSED_PRIVATE_CLASS_VARIABLE.rst => unused_private_class_variable.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNUSED_SIGNAL.rst => unused_signal.rst} (100%) rename tutorials/scripting/gdscript/warnings/{UNUSED_VARIABLE.rst => unused_variable.rst} (100%) diff --git a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst b/tutorials/scripting/gdscript/warnings/assert_always_false.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_FALSE.rst rename to tutorials/scripting/gdscript/warnings/assert_always_false.rst diff --git a/tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst b/tutorials/scripting/gdscript/warnings/assert_always_true.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/ASSERT_ALWAYS_TRUE.rst rename to tutorials/scripting/gdscript/warnings/assert_always_true.rst diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst b/tutorials/scripting/gdscript/warnings/confusable_capture_reassignment.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/CONFUSABLE_CAPTURE_REASSIGNMENT.rst rename to tutorials/scripting/gdscript/warnings/confusable_capture_reassignment.rst diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst b/tutorials/scripting/gdscript/warnings/confusable_identifier.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/CONFUSABLE_IDENTIFIER.rst rename to tutorials/scripting/gdscript/warnings/confusable_identifier.rst diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/confusable_local_declaration.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_DECLARATION.rst rename to tutorials/scripting/gdscript/warnings/confusable_local_declaration.rst diff --git a/tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst b/tutorials/scripting/gdscript/warnings/confusable_local_usage.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/CONFUSABLE_LOCAL_USAGE.rst rename to tutorials/scripting/gdscript/warnings/confusable_local_usage.rst diff --git a/tutorials/scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst b/tutorials/scripting/gdscript/warnings/constant_used_as_function.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/CONSTANT_USED_AS_FUNCTION.rst rename to tutorials/scripting/gdscript/warnings/constant_used_as_function.rst diff --git a/tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst b/tutorials/scripting/gdscript/warnings/deprecated_keyword.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/DEPRECATED_KEYWORD.rst rename to tutorials/scripting/gdscript/warnings/deprecated_keyword.rst diff --git a/tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst b/tutorials/scripting/gdscript/warnings/empty_file.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/EMPTY_FILE.rst rename to tutorials/scripting/gdscript/warnings/empty_file.rst diff --git a/tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst b/tutorials/scripting/gdscript/warnings/enum_variable_without_default.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/ENUM_VARIABLE_WITHOUT_DEFAULT.rst rename to tutorials/scripting/gdscript/warnings/enum_variable_without_default.rst diff --git a/tutorials/scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst b/tutorials/scripting/gdscript/warnings/function_used_as_property.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/FUNCTION_USED_AS_PROPERTY.rst rename to tutorials/scripting/gdscript/warnings/function_used_as_property.rst diff --git a/tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst b/tutorials/scripting/gdscript/warnings/get_node_default_without_onready.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/GET_NODE_DEFAULT_WITHOUT_ONREADY.rst rename to tutorials/scripting/gdscript/warnings/get_node_default_without_onready.rst diff --git a/tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst b/tutorials/scripting/gdscript/warnings/incompatible_ternary.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/INCOMPATIBLE_TERNARY.rst rename to tutorials/scripting/gdscript/warnings/incompatible_ternary.rst diff --git a/tutorials/scripting/gdscript/warnings/index.rst b/tutorials/scripting/gdscript/warnings/index.rst index cde1e8a6b81..2e99ec318cd 100644 --- a/tutorials/scripting/gdscript/warnings/index.rst +++ b/tutorials/scripting/gdscript/warnings/index.rst @@ -14,50 +14,50 @@ This is a collection of the warnings that GDScript can emit, and information on :maxdepth: 1 :name: toc-gdscript-warnings - UNASSIGNED_VARIABLE - UNASSIGNED_VARIABLE_OP_ASSIGN - UNUSED_VARIABLE - UNUSED_LOCAL_CONSTANT - UNUSED_PRIVATE_CLASS_VARIABLE - UNUSED_PARAMETER - UNUSED_SIGNAL - SHADOWED_VARIABLE - SHADOWED_VARIABLE_BASE_CLASS - SHADOWED_GLOBAL_IDENTIFIER - UNREACHABLE_CODE - UNREACHABLE_PATTERN - STANDALONE_EXPRESSION - STANDALONE_TERNARY - INCOMPATIBLE_TERNARY - UNTYPED_DECLARATION - INFERRED_DECLARATION - UNSAFE_PROPERTY_ACCESS - UNSAFE_METHOD_ACCESS - UNSAFE_CAST - UNSAFE_CALL_ARGUMENT - UNSAFE_VOID_RETURN - RETURN_VALUE_DISCARDED - STATIC_CALLED_ON_INSTANCE - MISSING_TOOL - REDUNDANT_STATIC_UNLOAD - REDUNDANT_AWAIT - ASSERT_ALWAYS_TRUE - ASSERT_ALWAYS_FALSE - INTEGER_DIVISION - NARROWING_CONVERSION - INT_AS_ENUM_WITHOUT_CAST - INT_AS_ENUM_WITHOUT_MATCH - ENUM_VARIABLE_WITHOUT_DEFAULT - EMPTY_FILE - DEPRECATED_KEYWORD - CONFUSABLE_IDENTIFIER - CONFUSABLE_LOCAL_DECLARATION - CONFUSABLE_LOCAL_USAGE - CONFUSABLE_CAPTURE_REASSIGNMENT - INFERENCE_ON_VARIANT - NATIVE_METHOD_OVERRIDE - GET_NODE_DEFAULT_WITHOUT_ONREADY - ONREADY_WITH_EXPORT - PROPERTY_USED_AS_FUNCTION - CONSTANT_USED_AS_FUNCTION - FUNCTION_USED_AS_PROPERTY + unassigned_variable + unassigned_variable_op_assign + unused_variable + unused_local_constant + unused_private_class_variable + unused_parameter + unused_signal + shadowed_variable + shadowed_variable_base_class + shadowed_global_identifier + unreachable_code + unreachable_pattern + standalone_expression + standalone_ternary + incompatible_ternary + untyped_declaration + inferred_declaration + unsafe_property_access + unsafe_method_access + unsafe_cast + unsafe_call_argument + unsafe_void_return + return_value_discarded + static_called_on_instance + missing_tool + redundant_static_unload + redundant_await + assert_always_true + assert_always_false + integer_division + narrowing_conversion + int_as_enum_without_cast + int_as_enum_without_match + enum_variable_without_default + empty_file + deprecated_keyword + confusable_identifier + confusable_local_declaration + confusable_local_usage + confusable_capture_reassignment + inference_on_variant + native_method_override + get_node_default_without_onready + onready_with_export + property_used_as_function + constant_used_as_function + function_used_as_property diff --git a/tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst b/tutorials/scripting/gdscript/warnings/inference_on_variant.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/INFERENCE_ON_VARIANT.rst rename to tutorials/scripting/gdscript/warnings/inference_on_variant.rst diff --git a/tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/inferred_declaration.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/INFERRED_DECLARATION.rst rename to tutorials/scripting/gdscript/warnings/inferred_declaration.rst diff --git a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst b/tutorials/scripting/gdscript/warnings/int_as_enum_without_cast.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_CAST.rst rename to tutorials/scripting/gdscript/warnings/int_as_enum_without_cast.rst diff --git a/tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst b/tutorials/scripting/gdscript/warnings/int_as_enum_without_match.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/INT_AS_ENUM_WITHOUT_MATCH.rst rename to tutorials/scripting/gdscript/warnings/int_as_enum_without_match.rst diff --git a/tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst b/tutorials/scripting/gdscript/warnings/integer_division.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/INTEGER_DIVISION.rst rename to tutorials/scripting/gdscript/warnings/integer_division.rst diff --git a/tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst b/tutorials/scripting/gdscript/warnings/missing_tool.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/MISSING_TOOL.rst rename to tutorials/scripting/gdscript/warnings/missing_tool.rst diff --git a/tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst b/tutorials/scripting/gdscript/warnings/narrowing_conversion.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/NARROWING_CONVERSION.rst rename to tutorials/scripting/gdscript/warnings/narrowing_conversion.rst diff --git a/tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst b/tutorials/scripting/gdscript/warnings/native_method_override.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/NATIVE_METHOD_OVERRIDE.rst rename to tutorials/scripting/gdscript/warnings/native_method_override.rst diff --git a/tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst b/tutorials/scripting/gdscript/warnings/onready_with_export.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/ONREADY_WITH_EXPORT.rst rename to tutorials/scripting/gdscript/warnings/onready_with_export.rst diff --git a/tutorials/scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst b/tutorials/scripting/gdscript/warnings/property_used_as_function.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/PROPERTY_USED_AS_FUNCTION.rst rename to tutorials/scripting/gdscript/warnings/property_used_as_function.rst diff --git a/tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst b/tutorials/scripting/gdscript/warnings/redundant_await.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/REDUNDANT_AWAIT.rst rename to tutorials/scripting/gdscript/warnings/redundant_await.rst diff --git a/tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst b/tutorials/scripting/gdscript/warnings/redundant_static_unload.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/REDUNDANT_STATIC_UNLOAD.rst rename to tutorials/scripting/gdscript/warnings/redundant_static_unload.rst diff --git a/tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst b/tutorials/scripting/gdscript/warnings/return_value_discarded.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/RETURN_VALUE_DISCARDED.rst rename to tutorials/scripting/gdscript/warnings/return_value_discarded.rst diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst b/tutorials/scripting/gdscript/warnings/shadowed_global_identifier.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/SHADOWED_GLOBAL_IDENTIFIER.rst rename to tutorials/scripting/gdscript/warnings/shadowed_global_identifier.rst diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/shadowed_variable.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE.rst rename to tutorials/scripting/gdscript/warnings/shadowed_variable.rst diff --git a/tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst b/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/SHADOWED_VARIABLE_BASE_CLASS.rst rename to tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst diff --git a/tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst b/tutorials/scripting/gdscript/warnings/standalone_expression.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/STANDALONE_EXPRESSION.rst rename to tutorials/scripting/gdscript/warnings/standalone_expression.rst diff --git a/tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst b/tutorials/scripting/gdscript/warnings/standalone_ternary.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/STANDALONE_TERNARY.rst rename to tutorials/scripting/gdscript/warnings/standalone_ternary.rst diff --git a/tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst b/tutorials/scripting/gdscript/warnings/static_called_on_instance.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/STATIC_CALLED_ON_INSTANCE.rst rename to tutorials/scripting/gdscript/warnings/static_called_on_instance.rst diff --git a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/unassigned_variable.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE.rst rename to tutorials/scripting/gdscript/warnings/unassigned_variable.rst diff --git a/tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst b/tutorials/scripting/gdscript/warnings/unassigned_variable_op_assign.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNASSIGNED_VARIABLE_OP_ASSIGN.rst rename to tutorials/scripting/gdscript/warnings/unassigned_variable_op_assign.rst diff --git a/tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst b/tutorials/scripting/gdscript/warnings/unreachable_code.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNREACHABLE_CODE.rst rename to tutorials/scripting/gdscript/warnings/unreachable_code.rst diff --git a/tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst b/tutorials/scripting/gdscript/warnings/unreachable_pattern.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNREACHABLE_PATTERN.rst rename to tutorials/scripting/gdscript/warnings/unreachable_pattern.rst diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst b/tutorials/scripting/gdscript/warnings/unsafe_call_argument.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNSAFE_CALL_ARGUMENT.rst rename to tutorials/scripting/gdscript/warnings/unsafe_call_argument.rst diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst b/tutorials/scripting/gdscript/warnings/unsafe_cast.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNSAFE_CAST.rst rename to tutorials/scripting/gdscript/warnings/unsafe_cast.rst diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst b/tutorials/scripting/gdscript/warnings/unsafe_method_access.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNSAFE_METHOD_ACCESS.rst rename to tutorials/scripting/gdscript/warnings/unsafe_method_access.rst diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst b/tutorials/scripting/gdscript/warnings/unsafe_property_access.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNSAFE_PROPERTY_ACCESS.rst rename to tutorials/scripting/gdscript/warnings/unsafe_property_access.rst diff --git a/tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst b/tutorials/scripting/gdscript/warnings/unsafe_void_return.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNSAFE_VOID_RETURN.rst rename to tutorials/scripting/gdscript/warnings/unsafe_void_return.rst diff --git a/tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst b/tutorials/scripting/gdscript/warnings/untyped_declaration.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNTYPED_DECLARATION.rst rename to tutorials/scripting/gdscript/warnings/untyped_declaration.rst diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst b/tutorials/scripting/gdscript/warnings/unused_local_constant.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNUSED_LOCAL_CONSTANT.rst rename to tutorials/scripting/gdscript/warnings/unused_local_constant.rst diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst b/tutorials/scripting/gdscript/warnings/unused_parameter.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNUSED_PARAMETER.rst rename to tutorials/scripting/gdscript/warnings/unused_parameter.rst diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/unused_private_class_variable.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNUSED_PRIVATE_CLASS_VARIABLE.rst rename to tutorials/scripting/gdscript/warnings/unused_private_class_variable.rst diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst b/tutorials/scripting/gdscript/warnings/unused_signal.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNUSED_SIGNAL.rst rename to tutorials/scripting/gdscript/warnings/unused_signal.rst diff --git a/tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst b/tutorials/scripting/gdscript/warnings/unused_variable.rst similarity index 100% rename from tutorials/scripting/gdscript/warnings/UNUSED_VARIABLE.rst rename to tutorials/scripting/gdscript/warnings/unused_variable.rst From fde83c46daf6c584ae1253c4d0e10a4a340a74d9 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Thu, 27 Mar 2025 22:47:20 -0700 Subject: [PATCH 12/36] Replace `%s` in warnings with example strings --- .../scripting/gdscript/warnings/confusable_identifier.rst | 2 +- .../gdscript/warnings/confusable_local_declaration.rst | 2 +- .../scripting/gdscript/warnings/inference_on_variant.rst | 2 +- .../scripting/gdscript/warnings/int_as_enum_without_match.rst | 2 +- .../scripting/gdscript/warnings/native_method_override.rst | 2 +- .../scripting/gdscript/warnings/return_value_discarded.rst | 2 +- .../gdscript/warnings/shadowed_global_identifier.rst | 2 +- tutorials/scripting/gdscript/warnings/shadowed_variable.rst | 2 +- .../gdscript/warnings/shadowed_variable_base_class.rst | 2 +- .../scripting/gdscript/warnings/static_called_on_instance.rst | 2 +- tutorials/scripting/gdscript/warnings/unassigned_variable.rst | 2 +- .../gdscript/warnings/unassigned_variable_op_assign.rst | 2 +- tutorials/scripting/gdscript/warnings/unreachable_code.rst | 2 +- .../scripting/gdscript/warnings/unsafe_call_argument.rst | 2 +- .../scripting/gdscript/warnings/unsafe_method_access.rst | 2 +- .../scripting/gdscript/warnings/unsafe_property_access.rst | 2 +- tutorials/scripting/gdscript/warnings/unsafe_void_return.rst | 2 +- tutorials/scripting/gdscript/warnings/untyped_declaration.rst | 4 ++-- .../scripting/gdscript/warnings/unused_local_constant.rst | 2 +- tutorials/scripting/gdscript/warnings/unused_parameter.rst | 2 +- .../gdscript/warnings/unused_private_class_variable.rst | 2 +- tutorials/scripting/gdscript/warnings/unused_signal.rst | 2 +- tutorials/scripting/gdscript/warnings/unused_variable.rst | 2 +- 23 files changed, 24 insertions(+), 24 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/confusable_identifier.rst b/tutorials/scripting/gdscript/warnings/confusable_identifier.rst index 50c0a127c36..353a30f30de 100644 --- a/tutorials/scripting/gdscript/warnings/confusable_identifier.rst +++ b/tutorials/scripting/gdscript/warnings/confusable_identifier.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The identifier "%s" has misleading characters and might be confused with something else. + The identifier "my_vАr" has misleading characters and might be confused with something else. The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/confusable_local_declaration.rst b/tutorials/scripting/gdscript/warnings/confusable_local_declaration.rst index 43560b4b5ad..fa3d0f46aef 100644 --- a/tutorials/scripting/gdscript/warnings/confusable_local_declaration.rst +++ b/tutorials/scripting/gdscript/warnings/confusable_local_declaration.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The %s "%s" is declared below in the parent block. + The variable "my_param" is declared below in the parent block. The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/inference_on_variant.rst b/tutorials/scripting/gdscript/warnings/inference_on_variant.rst index 8b29da4d382..ca531f8baac 100644 --- a/tutorials/scripting/gdscript/warnings/inference_on_variant.rst +++ b/tutorials/scripting/gdscript/warnings/inference_on_variant.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The %s type is being inferred from a Variant value, so it will be typed as Variant. + The variable type is being inferred from a Variant value, so it will be typed as Variant. The default warning level for this warning is **Error**. diff --git a/tutorials/scripting/gdscript/warnings/int_as_enum_without_match.rst b/tutorials/scripting/gdscript/warnings/int_as_enum_without_match.rst index 8b18644fc55..f615540dfe0 100644 --- a/tutorials/scripting/gdscript/warnings/int_as_enum_without_match.rst +++ b/tutorials/scripting/gdscript/warnings/int_as_enum_without_match.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - Cannot %s %s as Enum "%s": no enum member has matching value. + Cannot cast 3 as Enum "MyClass.MyEnum": no enum member has matching value. The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/native_method_override.rst b/tutorials/scripting/gdscript/warnings/native_method_override.rst index 02fcb20789b..d2815ed01f0 100644 --- a/tutorials/scripting/gdscript/warnings/native_method_override.rst +++ b/tutorials/scripting/gdscript/warnings/native_method_override.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The method "%s()" overrides a method from native class "%s". This won't be called by the engine and may not work as expected. + The method "get_class()" overrides a method from native class "Object". This won't be called by the engine and may not work as expected. The default warning level for this warning is **Error**. diff --git a/tutorials/scripting/gdscript/warnings/return_value_discarded.rst b/tutorials/scripting/gdscript/warnings/return_value_discarded.rst index 08fbe2fd8bb..0b3edf6a1fb 100644 --- a/tutorials/scripting/gdscript/warnings/return_value_discarded.rst +++ b/tutorials/scripting/gdscript/warnings/return_value_discarded.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The function "%s()" returns a value that will be discarded if not used. + The function "get_number()" returns a value that will be discarded if not used. The default warning level for this warning is **Ignore**. diff --git a/tutorials/scripting/gdscript/warnings/shadowed_global_identifier.rst b/tutorials/scripting/gdscript/warnings/shadowed_global_identifier.rst index 8bcfd38d168..7045efea656 100644 --- a/tutorials/scripting/gdscript/warnings/shadowed_global_identifier.rst +++ b/tutorials/scripting/gdscript/warnings/shadowed_global_identifier.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The %s "%s" has the same name as a %s. + The variable "str" has the same name as a built-in function. The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/shadowed_variable.rst b/tutorials/scripting/gdscript/warnings/shadowed_variable.rst index c8a7ef27b0c..7aba03507fa 100644 --- a/tutorials/scripting/gdscript/warnings/shadowed_variable.rst +++ b/tutorials/scripting/gdscript/warnings/shadowed_variable.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The local %s "%s" is shadowing an already-declared %s at line %s in the current class. + The local variable "level" is shadowing an already-declared variable at line 3 in the current class. The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst b/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst index 4024f9bdae9..0fb61bbbe65 100644 --- a/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst +++ b/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The local %s "%s" is shadowing an already-declared %s at line %s in the base class "%s". + The local variable "name" is shadowing an already-declared property in the base class "Node". The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/static_called_on_instance.rst b/tutorials/scripting/gdscript/warnings/static_called_on_instance.rst index d47148c66ad..8c1b01e6552 100644 --- a/tutorials/scripting/gdscript/warnings/static_called_on_instance.rst +++ b/tutorials/scripting/gdscript/warnings/static_called_on_instance.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The function "%s()" is a static function but was called from an instance. Instead, it should be directly called from the type: "%s.%s()". + The function "do_static_thing()" is a static function but was called from an instance. Instead, it should be directly called from the type: "MyClass.do_static_thing()". The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/unassigned_variable.rst b/tutorials/scripting/gdscript/warnings/unassigned_variable.rst index af0ec9050c5..152feaa6a9f 100644 --- a/tutorials/scripting/gdscript/warnings/unassigned_variable.rst +++ b/tutorials/scripting/gdscript/warnings/unassigned_variable.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The variable "%s" was used before being assigned a value. + The variable "my_var" was used before being assigned a value. The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/unassigned_variable_op_assign.rst b/tutorials/scripting/gdscript/warnings/unassigned_variable_op_assign.rst index e2bb855c2df..1f3d75e8826 100644 --- a/tutorials/scripting/gdscript/warnings/unassigned_variable_op_assign.rst +++ b/tutorials/scripting/gdscript/warnings/unassigned_variable_op_assign.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - Using assignment with operation but the variable "%s" was not previously assigned a value. + Using assignment with operation but the variable "my_counter" was not previously assigned a value. The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/unreachable_code.rst b/tutorials/scripting/gdscript/warnings/unreachable_code.rst index 3b87c11aaa0..798060421b5 100644 --- a/tutorials/scripting/gdscript/warnings/unreachable_code.rst +++ b/tutorials/scripting/gdscript/warnings/unreachable_code.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - Unreachable code (statement after return) in function "%s()". + Unreachable code (statement after return) in function "_ready()". The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/unsafe_call_argument.rst b/tutorials/scripting/gdscript/warnings/unsafe_call_argument.rst index 45fa5f0b62e..08dadc40727 100644 --- a/tutorials/scripting/gdscript/warnings/unsafe_call_argument.rst +++ b/tutorials/scripting/gdscript/warnings/unsafe_call_argument.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The argument %s of the %s "%s()" requires the subtype "%s" but the supertype "%s" was provided. + The argument 1 of the function "set_health()" requires the subtype "int" but the supertype "Variant" was provided. The default warning level for this warning is **Ignore**. diff --git a/tutorials/scripting/gdscript/warnings/unsafe_method_access.rst b/tutorials/scripting/gdscript/warnings/unsafe_method_access.rst index 149b7697d46..6b763058d23 100644 --- a/tutorials/scripting/gdscript/warnings/unsafe_method_access.rst +++ b/tutorials/scripting/gdscript/warnings/unsafe_method_access.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The method "%s()" is not present on the inferred type "%s" (but may be present on a subtype). + The method "do_thing()" is not present on the inferred type "Node" (but may be present on a subtype). The default warning level for this warning is **Ignore**. diff --git a/tutorials/scripting/gdscript/warnings/unsafe_property_access.rst b/tutorials/scripting/gdscript/warnings/unsafe_property_access.rst index 3bd4ca21afa..98e9551efea 100644 --- a/tutorials/scripting/gdscript/warnings/unsafe_property_access.rst +++ b/tutorials/scripting/gdscript/warnings/unsafe_property_access.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The property "%s" is not present on the inferred type "%s" (but may be present on a subtype). + The property "health" is not present on the inferred type "Node" (but may be present on a subtype). The default warning level for this warning is **Ignore**. diff --git a/tutorials/scripting/gdscript/warnings/unsafe_void_return.rst b/tutorials/scripting/gdscript/warnings/unsafe_void_return.rst index 3c2354ec47d..8d79645269e 100644 --- a/tutorials/scripting/gdscript/warnings/unsafe_void_return.rst +++ b/tutorials/scripting/gdscript/warnings/unsafe_void_return.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The method "%s()" returns "void" but it's trying to return a call to "%s()" that can't be ensured to also be "void". + The method "do_thing()" returns "void" but it's trying to return a call to "do_other_thing()" that can't be ensured to also be "void". The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/untyped_declaration.rst b/tutorials/scripting/gdscript/warnings/untyped_declaration.rst index f72f441cb15..9b735be298a 100644 --- a/tutorials/scripting/gdscript/warnings/untyped_declaration.rst +++ b/tutorials/scripting/gdscript/warnings/untyped_declaration.rst @@ -5,9 +5,9 @@ The warning message is: .. code-block:: none - %s "%s()" has no static return type. + Function "_ready()" has no static return type. - %s "%s" has no static type. + Variable "my_age" has no static type. The default warning level for this warning is **Ignore**. diff --git a/tutorials/scripting/gdscript/warnings/unused_local_constant.rst b/tutorials/scripting/gdscript/warnings/unused_local_constant.rst index b528e21434b..7b4932a7613 100644 --- a/tutorials/scripting/gdscript/warnings/unused_local_constant.rst +++ b/tutorials/scripting/gdscript/warnings/unused_local_constant.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The local constant "%s" is declared but never used in the block. If this is intended, prefix it with an underscore: "_%s". + The local constant "MAX_VALUE" is declared but never used in the block. If this is intended, prefix it with an underscore: "_MAX_VALUE". The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/unused_parameter.rst b/tutorials/scripting/gdscript/warnings/unused_parameter.rst index 97e4cbad95d..d2447247e9a 100644 --- a/tutorials/scripting/gdscript/warnings/unused_parameter.rst +++ b/tutorials/scripting/gdscript/warnings/unused_parameter.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The parameter "%s" is never used in the function "%s()". If this is intended, prefix it with an underscore: "_%s". + The parameter "delta" is never used in the function "_process()". If this is intended, prefix it with an underscore: "_delta". The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/unused_private_class_variable.rst b/tutorials/scripting/gdscript/warnings/unused_private_class_variable.rst index cf3363856ea..ed13c8e0a9b 100644 --- a/tutorials/scripting/gdscript/warnings/unused_private_class_variable.rst +++ b/tutorials/scripting/gdscript/warnings/unused_private_class_variable.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The class variable "%s" is declared but never used in the class. + The class variable "_health" is declared but never used in the class. The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/unused_signal.rst b/tutorials/scripting/gdscript/warnings/unused_signal.rst index 6a5bada2148..b77d0efa2d9 100644 --- a/tutorials/scripting/gdscript/warnings/unused_signal.rst +++ b/tutorials/scripting/gdscript/warnings/unused_signal.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The signal "%s" is declared but never explicitly used in the class. + The signal "defeated" is declared but never explicitly used in the class. The default warning level for this warning is **Warn**. diff --git a/tutorials/scripting/gdscript/warnings/unused_variable.rst b/tutorials/scripting/gdscript/warnings/unused_variable.rst index 551a680cfe0..de2aef145cb 100644 --- a/tutorials/scripting/gdscript/warnings/unused_variable.rst +++ b/tutorials/scripting/gdscript/warnings/unused_variable.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The local variable "%s" is declared but never used in the block. If this is intended, prefix it with an underscore: "_%s". + The local variable "counter" is declared but never used in the block. If this is intended, prefix it with an underscore: "_counter". The default warning level for this warning is **Warn**. From 4956a9ebf710b0e32015cff0daaa3e10e3500772 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Thu, 27 Mar 2025 22:49:00 -0700 Subject: [PATCH 13/36] Remove unused warnings --- .../warnings/constant_used_as_function.rst | 18 ------------------ .../warnings/function_used_as_property.rst | 18 ------------------ .../scripting/gdscript/warnings/index.rst | 3 --- .../warnings/property_used_as_function.rst | 18 ------------------ 4 files changed, 57 deletions(-) delete mode 100644 tutorials/scripting/gdscript/warnings/constant_used_as_function.rst delete mode 100644 tutorials/scripting/gdscript/warnings/function_used_as_property.rst delete mode 100644 tutorials/scripting/gdscript/warnings/property_used_as_function.rst diff --git a/tutorials/scripting/gdscript/warnings/constant_used_as_function.rst b/tutorials/scripting/gdscript/warnings/constant_used_as_function.rst deleted file mode 100644 index b231bfba89e..00000000000 --- a/tutorials/scripting/gdscript/warnings/constant_used_as_function.rst +++ /dev/null @@ -1,18 +0,0 @@ -CONSTANT_USED_AS_FUNCTION -============================= - -The default warning level for this warning is **Warn**. - -When this warning occurs ------------------------- - -TODO - - -How to fix this warning ------------------------ - -TODO - - - diff --git a/tutorials/scripting/gdscript/warnings/function_used_as_property.rst b/tutorials/scripting/gdscript/warnings/function_used_as_property.rst deleted file mode 100644 index 9ff4340bfb5..00000000000 --- a/tutorials/scripting/gdscript/warnings/function_used_as_property.rst +++ /dev/null @@ -1,18 +0,0 @@ -FUNCTION_USED_AS_PROPERTY -============================= - -The default warning level for this warning is **Warn**. - -When this warning occurs ------------------------- - -TODO - - -How to fix this warning ------------------------ - -TODO - - - diff --git a/tutorials/scripting/gdscript/warnings/index.rst b/tutorials/scripting/gdscript/warnings/index.rst index 2e99ec318cd..ae7cc94e5b5 100644 --- a/tutorials/scripting/gdscript/warnings/index.rst +++ b/tutorials/scripting/gdscript/warnings/index.rst @@ -58,6 +58,3 @@ This is a collection of the warnings that GDScript can emit, and information on native_method_override get_node_default_without_onready onready_with_export - property_used_as_function - constant_used_as_function - function_used_as_property diff --git a/tutorials/scripting/gdscript/warnings/property_used_as_function.rst b/tutorials/scripting/gdscript/warnings/property_used_as_function.rst deleted file mode 100644 index 896971819d0..00000000000 --- a/tutorials/scripting/gdscript/warnings/property_used_as_function.rst +++ /dev/null @@ -1,18 +0,0 @@ -PROPERTY_USED_AS_FUNCTION -============================= - -The default warning level for this warning is **Warn**. - -When this warning occurs ------------------------- - -TODO - - -How to fix this warning ------------------------ - -TODO - - - From 957c22458e3ddcdfbd7ddfbce8bdab87f967914a Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Thu, 27 Mar 2025 22:54:06 -0700 Subject: [PATCH 14/36] Improve example message for `INFERRED_DECLARATION` --- tutorials/scripting/gdscript/warnings/inferred_declaration.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/scripting/gdscript/warnings/inferred_declaration.rst b/tutorials/scripting/gdscript/warnings/inferred_declaration.rst index 6fadfbf07fd..496fa4320a6 100644 --- a/tutorials/scripting/gdscript/warnings/inferred_declaration.rst +++ b/tutorials/scripting/gdscript/warnings/inferred_declaration.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - %s "%s" has an implicitly inferred static type. + "for" iterator variable "i" has an implicitly inferred static type. The default warning level for this warning is **Ignore**. From 02d7162305da717b24abafdf3a5e022fe346785e Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Sat, 29 Mar 2025 21:14:22 -0700 Subject: [PATCH 15/36] Change `DEPRECATED_KEYWORD` page to clarify that the warning should never appear --- .../scripting/gdscript/warnings/deprecated_keyword.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/deprecated_keyword.rst b/tutorials/scripting/gdscript/warnings/deprecated_keyword.rst index 75d6de3bad3..96029a4998a 100644 --- a/tutorials/scripting/gdscript/warnings/deprecated_keyword.rst +++ b/tutorials/scripting/gdscript/warnings/deprecated_keyword.rst @@ -5,20 +5,20 @@ The warning message is: .. code-block:: none - The "%s" keyword is deprecated and will be removed in a future release, please replace its uses by "%s". + The "..." keyword is deprecated and will be removed in a future release, please replace its uses by "...". The default warning level for this warning is **Warn**. When this warning occurs ------------------------ -TODO +There are currently no deprecated keywords in GDScript; as such, this warning should never appear. How to fix this warning ----------------------- -TODO +Follow instructions on the Godot Docs for how to use the alternative keyword. From e98a2c21d17a08124803c305dcde67a7459a12dd Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Sat, 29 Mar 2025 21:53:44 -0700 Subject: [PATCH 16/36] Add links to ProjectSettings's configuration variables for warning levels --- tutorials/scripting/gdscript/warnings/assert_always_false.rst | 1 + tutorials/scripting/gdscript/warnings/assert_always_true.rst | 1 + .../gdscript/warnings/confusable_capture_reassignment.rst | 1 + tutorials/scripting/gdscript/warnings/confusable_identifier.rst | 1 + .../scripting/gdscript/warnings/confusable_local_declaration.rst | 1 + tutorials/scripting/gdscript/warnings/confusable_local_usage.rst | 1 + tutorials/scripting/gdscript/warnings/deprecated_keyword.rst | 1 + tutorials/scripting/gdscript/warnings/empty_file.rst | 1 + .../gdscript/warnings/enum_variable_without_default.rst | 1 + .../gdscript/warnings/get_node_default_without_onready.rst | 1 + tutorials/scripting/gdscript/warnings/incompatible_ternary.rst | 1 + tutorials/scripting/gdscript/warnings/inference_on_variant.rst | 1 + tutorials/scripting/gdscript/warnings/inferred_declaration.rst | 1 + .../scripting/gdscript/warnings/int_as_enum_without_cast.rst | 1 + .../scripting/gdscript/warnings/int_as_enum_without_match.rst | 1 + tutorials/scripting/gdscript/warnings/integer_division.rst | 1 + tutorials/scripting/gdscript/warnings/missing_tool.rst | 1 + tutorials/scripting/gdscript/warnings/narrowing_conversion.rst | 1 + tutorials/scripting/gdscript/warnings/native_method_override.rst | 1 + tutorials/scripting/gdscript/warnings/onready_with_export.rst | 1 + tutorials/scripting/gdscript/warnings/redundant_await.rst | 1 + .../scripting/gdscript/warnings/redundant_static_unload.rst | 1 + tutorials/scripting/gdscript/warnings/return_value_discarded.rst | 1 + .../scripting/gdscript/warnings/shadowed_global_identifier.rst | 1 + tutorials/scripting/gdscript/warnings/shadowed_variable.rst | 1 + .../scripting/gdscript/warnings/shadowed_variable_base_class.rst | 1 + tutorials/scripting/gdscript/warnings/standalone_expression.rst | 1 + tutorials/scripting/gdscript/warnings/standalone_ternary.rst | 1 + .../scripting/gdscript/warnings/static_called_on_instance.rst | 1 + tutorials/scripting/gdscript/warnings/unassigned_variable.rst | 1 + .../gdscript/warnings/unassigned_variable_op_assign.rst | 1 + tutorials/scripting/gdscript/warnings/unreachable_code.rst | 1 + tutorials/scripting/gdscript/warnings/unreachable_pattern.rst | 1 + tutorials/scripting/gdscript/warnings/unsafe_call_argument.rst | 1 + tutorials/scripting/gdscript/warnings/unsafe_cast.rst | 1 + tutorials/scripting/gdscript/warnings/unsafe_method_access.rst | 1 + tutorials/scripting/gdscript/warnings/unsafe_property_access.rst | 1 + tutorials/scripting/gdscript/warnings/unsafe_void_return.rst | 1 + tutorials/scripting/gdscript/warnings/untyped_declaration.rst | 1 + tutorials/scripting/gdscript/warnings/unused_local_constant.rst | 1 + tutorials/scripting/gdscript/warnings/unused_parameter.rst | 1 + .../gdscript/warnings/unused_private_class_variable.rst | 1 + tutorials/scripting/gdscript/warnings/unused_signal.rst | 1 + tutorials/scripting/gdscript/warnings/unused_variable.rst | 1 + 44 files changed, 44 insertions(+) diff --git a/tutorials/scripting/gdscript/warnings/assert_always_false.rst b/tutorials/scripting/gdscript/warnings/assert_always_false.rst index f8ce8205483..de56911770b 100644 --- a/tutorials/scripting/gdscript/warnings/assert_always_false.rst +++ b/tutorials/scripting/gdscript/warnings/assert_always_false.rst @@ -8,6 +8,7 @@ The warning message is: Assert statement will raise an error because the expression is always false. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/assert_always_false`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/assert_always_true.rst b/tutorials/scripting/gdscript/warnings/assert_always_true.rst index 323e0c7217e..27c61001859 100644 --- a/tutorials/scripting/gdscript/warnings/assert_always_true.rst +++ b/tutorials/scripting/gdscript/warnings/assert_always_true.rst @@ -8,6 +8,7 @@ The warning message is: Assert statement is redundant because the expression is always true. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/assert_always_true`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/confusable_capture_reassignment.rst b/tutorials/scripting/gdscript/warnings/confusable_capture_reassignment.rst index 163fd62ed8e..e383ef2495d 100644 --- a/tutorials/scripting/gdscript/warnings/confusable_capture_reassignment.rst +++ b/tutorials/scripting/gdscript/warnings/confusable_capture_reassignment.rst @@ -8,6 +8,7 @@ The warning message is: Reassigning lambda capture does not modify the outer local variable "my_var". The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/confusable_capture_assignment`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/confusable_identifier.rst b/tutorials/scripting/gdscript/warnings/confusable_identifier.rst index 353a30f30de..3ea8bbf5ecd 100644 --- a/tutorials/scripting/gdscript/warnings/confusable_identifier.rst +++ b/tutorials/scripting/gdscript/warnings/confusable_identifier.rst @@ -8,6 +8,7 @@ The warning message is: The identifier "my_vАr" has misleading characters and might be confused with something else. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/confusable_identifier`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/confusable_local_declaration.rst b/tutorials/scripting/gdscript/warnings/confusable_local_declaration.rst index fa3d0f46aef..803f9125eb1 100644 --- a/tutorials/scripting/gdscript/warnings/confusable_local_declaration.rst +++ b/tutorials/scripting/gdscript/warnings/confusable_local_declaration.rst @@ -8,6 +8,7 @@ The warning message is: The variable "my_param" is declared below in the parent block. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/confusable_local_declaration`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/confusable_local_usage.rst b/tutorials/scripting/gdscript/warnings/confusable_local_usage.rst index 7404674ed3a..e1f34034724 100644 --- a/tutorials/scripting/gdscript/warnings/confusable_local_usage.rst +++ b/tutorials/scripting/gdscript/warnings/confusable_local_usage.rst @@ -8,6 +8,7 @@ The warning message is: The identifier "my_var" will be shadowed below in the block. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/confusable_local_usage`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/deprecated_keyword.rst b/tutorials/scripting/gdscript/warnings/deprecated_keyword.rst index 96029a4998a..697fa2a1bd7 100644 --- a/tutorials/scripting/gdscript/warnings/deprecated_keyword.rst +++ b/tutorials/scripting/gdscript/warnings/deprecated_keyword.rst @@ -8,6 +8,7 @@ The warning message is: The "..." keyword is deprecated and will be removed in a future release, please replace its uses by "...". The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/deprecated_keyword`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/empty_file.rst b/tutorials/scripting/gdscript/warnings/empty_file.rst index 5cb2b1f068a..843ff0ec0f9 100644 --- a/tutorials/scripting/gdscript/warnings/empty_file.rst +++ b/tutorials/scripting/gdscript/warnings/empty_file.rst @@ -8,6 +8,7 @@ The warning message is: Empty script file. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/empty_file`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/enum_variable_without_default.rst b/tutorials/scripting/gdscript/warnings/enum_variable_without_default.rst index 3643f8aeed7..23fe1bc948c 100644 --- a/tutorials/scripting/gdscript/warnings/enum_variable_without_default.rst +++ b/tutorials/scripting/gdscript/warnings/enum_variable_without_default.rst @@ -8,6 +8,7 @@ The warning message is: The variable "my_var" has an enum type and does not set an explicit default value. The default will be set to "0". The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/enum_variable_without_default`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/get_node_default_without_onready.rst b/tutorials/scripting/gdscript/warnings/get_node_default_without_onready.rst index db94cc07efa..183d20edc48 100644 --- a/tutorials/scripting/gdscript/warnings/get_node_default_without_onready.rst +++ b/tutorials/scripting/gdscript/warnings/get_node_default_without_onready.rst @@ -14,6 +14,7 @@ Depending on how you attempt to access the scene tree, the warning message will The default value is using "get_node()" which won't return nodes in the scene tree before "_ready()" is called. Use the "@onready" annotation to solve this. The default warning level for this warning is **Error**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/get_node_default_without_onready`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/incompatible_ternary.rst b/tutorials/scripting/gdscript/warnings/incompatible_ternary.rst index 70d90d79f1d..48a807b75cc 100644 --- a/tutorials/scripting/gdscript/warnings/incompatible_ternary.rst +++ b/tutorials/scripting/gdscript/warnings/incompatible_ternary.rst @@ -8,6 +8,7 @@ The warning message is: Values of the ternary operator are not mutually compatible. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/incompatible_ternary`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/inference_on_variant.rst b/tutorials/scripting/gdscript/warnings/inference_on_variant.rst index ca531f8baac..5cfb7652a93 100644 --- a/tutorials/scripting/gdscript/warnings/inference_on_variant.rst +++ b/tutorials/scripting/gdscript/warnings/inference_on_variant.rst @@ -8,6 +8,7 @@ The warning message is: The variable type is being inferred from a Variant value, so it will be typed as Variant. The default warning level for this warning is **Error**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/inference_on_variant`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/inferred_declaration.rst b/tutorials/scripting/gdscript/warnings/inferred_declaration.rst index 496fa4320a6..ec11b90f91f 100644 --- a/tutorials/scripting/gdscript/warnings/inferred_declaration.rst +++ b/tutorials/scripting/gdscript/warnings/inferred_declaration.rst @@ -8,6 +8,7 @@ The warning message is: "for" iterator variable "i" has an implicitly inferred static type. The default warning level for this warning is **Ignore**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/inferred_declaration`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/int_as_enum_without_cast.rst b/tutorials/scripting/gdscript/warnings/int_as_enum_without_cast.rst index 71c5d72fdf9..a9c70e1e461 100644 --- a/tutorials/scripting/gdscript/warnings/int_as_enum_without_cast.rst +++ b/tutorials/scripting/gdscript/warnings/int_as_enum_without_cast.rst @@ -8,6 +8,7 @@ The warning message is: Integer used when an enum value is expected. If this is intended cast the integer to the enum type. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/int_as_enum_without_cast`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/int_as_enum_without_match.rst b/tutorials/scripting/gdscript/warnings/int_as_enum_without_match.rst index f615540dfe0..bcff65e0e7e 100644 --- a/tutorials/scripting/gdscript/warnings/int_as_enum_without_match.rst +++ b/tutorials/scripting/gdscript/warnings/int_as_enum_without_match.rst @@ -8,6 +8,7 @@ The warning message is: Cannot cast 3 as Enum "MyClass.MyEnum": no enum member has matching value. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/int_as_enum_without_match`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/integer_division.rst b/tutorials/scripting/gdscript/warnings/integer_division.rst index 76493804653..e42866a87d4 100644 --- a/tutorials/scripting/gdscript/warnings/integer_division.rst +++ b/tutorials/scripting/gdscript/warnings/integer_division.rst @@ -8,6 +8,7 @@ The warning message is: Integer division, decimal part will be discarded. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/integer_division`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/missing_tool.rst b/tutorials/scripting/gdscript/warnings/missing_tool.rst index 5d005cd0518..1ac202dd991 100644 --- a/tutorials/scripting/gdscript/warnings/missing_tool.rst +++ b/tutorials/scripting/gdscript/warnings/missing_tool.rst @@ -8,6 +8,7 @@ The warning message is: The base class script has the "@tool" annotation, but this script does not have it. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/missing_tool`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/narrowing_conversion.rst b/tutorials/scripting/gdscript/warnings/narrowing_conversion.rst index 9170b32f17a..1e6251fe9c4 100644 --- a/tutorials/scripting/gdscript/warnings/narrowing_conversion.rst +++ b/tutorials/scripting/gdscript/warnings/narrowing_conversion.rst @@ -8,6 +8,7 @@ The warning message is: Narrowing conversion (float is converted to int and loses precision). The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/narrowing_conversion`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/native_method_override.rst b/tutorials/scripting/gdscript/warnings/native_method_override.rst index d2815ed01f0..d91eddc5718 100644 --- a/tutorials/scripting/gdscript/warnings/native_method_override.rst +++ b/tutorials/scripting/gdscript/warnings/native_method_override.rst @@ -8,6 +8,7 @@ The warning message is: The method "get_class()" overrides a method from native class "Object". This won't be called by the engine and may not work as expected. The default warning level for this warning is **Error**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/native_method_override`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/onready_with_export.rst b/tutorials/scripting/gdscript/warnings/onready_with_export.rst index efc2e1e5a09..a1b1c3589f5 100644 --- a/tutorials/scripting/gdscript/warnings/onready_with_export.rst +++ b/tutorials/scripting/gdscript/warnings/onready_with_export.rst @@ -8,6 +8,7 @@ The warning message is: "@onready" will set the default value after "@export" takes effect and will override it. The default warning level for this warning is **Error**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/onready_with_export`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/redundant_await.rst b/tutorials/scripting/gdscript/warnings/redundant_await.rst index 4f45dee738d..0d7cebe227a 100644 --- a/tutorials/scripting/gdscript/warnings/redundant_await.rst +++ b/tutorials/scripting/gdscript/warnings/redundant_await.rst @@ -8,6 +8,7 @@ The warning message is: "await" keyword not needed in this case, because the expression isn't a coroutine nor a signal. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/redundant_await`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/redundant_static_unload.rst b/tutorials/scripting/gdscript/warnings/redundant_static_unload.rst index a5f5137eed9..c22639adddd 100644 --- a/tutorials/scripting/gdscript/warnings/redundant_static_unload.rst +++ b/tutorials/scripting/gdscript/warnings/redundant_static_unload.rst @@ -8,6 +8,7 @@ The warning message is: The "@static_unload" annotation is redundant because the file does not have a class with static variables. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/redundant_static_unload`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/return_value_discarded.rst b/tutorials/scripting/gdscript/warnings/return_value_discarded.rst index 0b3edf6a1fb..22889a5dd50 100644 --- a/tutorials/scripting/gdscript/warnings/return_value_discarded.rst +++ b/tutorials/scripting/gdscript/warnings/return_value_discarded.rst @@ -8,6 +8,7 @@ The warning message is: The function "get_number()" returns a value that will be discarded if not used. The default warning level for this warning is **Ignore**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/return_value_discarded`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/shadowed_global_identifier.rst b/tutorials/scripting/gdscript/warnings/shadowed_global_identifier.rst index 7045efea656..a8fa6e79b5b 100644 --- a/tutorials/scripting/gdscript/warnings/shadowed_global_identifier.rst +++ b/tutorials/scripting/gdscript/warnings/shadowed_global_identifier.rst @@ -8,6 +8,7 @@ The warning message is: The variable "str" has the same name as a built-in function. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/shadowed_global_identifier`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/shadowed_variable.rst b/tutorials/scripting/gdscript/warnings/shadowed_variable.rst index 7aba03507fa..3e8a4e25b5f 100644 --- a/tutorials/scripting/gdscript/warnings/shadowed_variable.rst +++ b/tutorials/scripting/gdscript/warnings/shadowed_variable.rst @@ -8,6 +8,7 @@ The warning message is: The local variable "level" is shadowing an already-declared variable at line 3 in the current class. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/shadowed_variable`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst b/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst index 0fb61bbbe65..6b639a23cdd 100644 --- a/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst +++ b/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst @@ -8,6 +8,7 @@ The warning message is: The local variable "name" is shadowing an already-declared property in the base class "Node". The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/shadowed_variable_base_class`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/standalone_expression.rst b/tutorials/scripting/gdscript/warnings/standalone_expression.rst index 2b50e1d4529..1b80dfd5a11 100644 --- a/tutorials/scripting/gdscript/warnings/standalone_expression.rst +++ b/tutorials/scripting/gdscript/warnings/standalone_expression.rst @@ -8,6 +8,7 @@ The warning message is: Standalone expression (the line may have no effect). The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/standalone_expression`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/standalone_ternary.rst b/tutorials/scripting/gdscript/warnings/standalone_ternary.rst index 4184ced2d91..9e8513edefe 100644 --- a/tutorials/scripting/gdscript/warnings/standalone_ternary.rst +++ b/tutorials/scripting/gdscript/warnings/standalone_ternary.rst @@ -8,6 +8,7 @@ The warning message is: Standalone ternary operator: the return value is being discarded. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/standalone_ternary`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/static_called_on_instance.rst b/tutorials/scripting/gdscript/warnings/static_called_on_instance.rst index 8c1b01e6552..1358b5d3be1 100644 --- a/tutorials/scripting/gdscript/warnings/static_called_on_instance.rst +++ b/tutorials/scripting/gdscript/warnings/static_called_on_instance.rst @@ -8,6 +8,7 @@ The warning message is: The function "do_static_thing()" is a static function but was called from an instance. Instead, it should be directly called from the type: "MyClass.do_static_thing()". The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/static_called_on_instance`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/unassigned_variable.rst b/tutorials/scripting/gdscript/warnings/unassigned_variable.rst index 152feaa6a9f..bccdb3b9311 100644 --- a/tutorials/scripting/gdscript/warnings/unassigned_variable.rst +++ b/tutorials/scripting/gdscript/warnings/unassigned_variable.rst @@ -8,6 +8,7 @@ The warning message is: The variable "my_var" was used before being assigned a value. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unassigned_variable`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/unassigned_variable_op_assign.rst b/tutorials/scripting/gdscript/warnings/unassigned_variable_op_assign.rst index 1f3d75e8826..048ca068d45 100644 --- a/tutorials/scripting/gdscript/warnings/unassigned_variable_op_assign.rst +++ b/tutorials/scripting/gdscript/warnings/unassigned_variable_op_assign.rst @@ -8,6 +8,7 @@ The warning message is: Using assignment with operation but the variable "my_counter" was not previously assigned a value. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unassigned_variable_op_assign`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/unreachable_code.rst b/tutorials/scripting/gdscript/warnings/unreachable_code.rst index 798060421b5..cb020cf8a08 100644 --- a/tutorials/scripting/gdscript/warnings/unreachable_code.rst +++ b/tutorials/scripting/gdscript/warnings/unreachable_code.rst @@ -8,6 +8,7 @@ The warning message is: Unreachable code (statement after return) in function "_ready()". The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unreachable_code`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/unreachable_pattern.rst b/tutorials/scripting/gdscript/warnings/unreachable_pattern.rst index 1ff400314d1..382d59047ee 100644 --- a/tutorials/scripting/gdscript/warnings/unreachable_pattern.rst +++ b/tutorials/scripting/gdscript/warnings/unreachable_pattern.rst @@ -8,6 +8,7 @@ The warning message is: Unreachable pattern (pattern after wildcard or bind). The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unreachable_pattern`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/unsafe_call_argument.rst b/tutorials/scripting/gdscript/warnings/unsafe_call_argument.rst index 08dadc40727..9508d6cde9d 100644 --- a/tutorials/scripting/gdscript/warnings/unsafe_call_argument.rst +++ b/tutorials/scripting/gdscript/warnings/unsafe_call_argument.rst @@ -8,6 +8,7 @@ The warning message is: The argument 1 of the function "set_health()" requires the subtype "int" but the supertype "Variant" was provided. The default warning level for this warning is **Ignore**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unsafe_call_argument`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/unsafe_cast.rst b/tutorials/scripting/gdscript/warnings/unsafe_cast.rst index 5fd4f49869e..dcb4ae3b1ed 100644 --- a/tutorials/scripting/gdscript/warnings/unsafe_cast.rst +++ b/tutorials/scripting/gdscript/warnings/unsafe_cast.rst @@ -8,6 +8,7 @@ The warning message is: Casting "Variant" to "%s" is unsafe. The default warning level for this warning is **Ignore**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unsafe_cast`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/unsafe_method_access.rst b/tutorials/scripting/gdscript/warnings/unsafe_method_access.rst index 6b763058d23..6a5499c7628 100644 --- a/tutorials/scripting/gdscript/warnings/unsafe_method_access.rst +++ b/tutorials/scripting/gdscript/warnings/unsafe_method_access.rst @@ -8,6 +8,7 @@ The warning message is: The method "do_thing()" is not present on the inferred type "Node" (but may be present on a subtype). The default warning level for this warning is **Ignore**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unsafe_method_access`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/unsafe_property_access.rst b/tutorials/scripting/gdscript/warnings/unsafe_property_access.rst index 98e9551efea..3e045fb05f4 100644 --- a/tutorials/scripting/gdscript/warnings/unsafe_property_access.rst +++ b/tutorials/scripting/gdscript/warnings/unsafe_property_access.rst @@ -8,6 +8,7 @@ The warning message is: The property "health" is not present on the inferred type "Node" (but may be present on a subtype). The default warning level for this warning is **Ignore**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unsafe_property_access`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/unsafe_void_return.rst b/tutorials/scripting/gdscript/warnings/unsafe_void_return.rst index 8d79645269e..3203ba96a48 100644 --- a/tutorials/scripting/gdscript/warnings/unsafe_void_return.rst +++ b/tutorials/scripting/gdscript/warnings/unsafe_void_return.rst @@ -8,6 +8,7 @@ The warning message is: The method "do_thing()" returns "void" but it's trying to return a call to "do_other_thing()" that can't be ensured to also be "void". The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unsafe_void_return`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/untyped_declaration.rst b/tutorials/scripting/gdscript/warnings/untyped_declaration.rst index 9b735be298a..5ea18dfa24c 100644 --- a/tutorials/scripting/gdscript/warnings/untyped_declaration.rst +++ b/tutorials/scripting/gdscript/warnings/untyped_declaration.rst @@ -10,6 +10,7 @@ The warning message is: Variable "my_age" has no static type. The default warning level for this warning is **Ignore**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/untyped_declaration`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/unused_local_constant.rst b/tutorials/scripting/gdscript/warnings/unused_local_constant.rst index 7b4932a7613..c6f50c89f0b 100644 --- a/tutorials/scripting/gdscript/warnings/unused_local_constant.rst +++ b/tutorials/scripting/gdscript/warnings/unused_local_constant.rst @@ -8,6 +8,7 @@ The warning message is: The local constant "MAX_VALUE" is declared but never used in the block. If this is intended, prefix it with an underscore: "_MAX_VALUE". The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unused_local_constant`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/unused_parameter.rst b/tutorials/scripting/gdscript/warnings/unused_parameter.rst index d2447247e9a..d3dd0fab01f 100644 --- a/tutorials/scripting/gdscript/warnings/unused_parameter.rst +++ b/tutorials/scripting/gdscript/warnings/unused_parameter.rst @@ -8,6 +8,7 @@ The warning message is: The parameter "delta" is never used in the function "_process()". If this is intended, prefix it with an underscore: "_delta". The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unused_parameter`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/unused_private_class_variable.rst b/tutorials/scripting/gdscript/warnings/unused_private_class_variable.rst index ed13c8e0a9b..44aa4487306 100644 --- a/tutorials/scripting/gdscript/warnings/unused_private_class_variable.rst +++ b/tutorials/scripting/gdscript/warnings/unused_private_class_variable.rst @@ -8,6 +8,7 @@ The warning message is: The class variable "_health" is declared but never used in the class. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unused_private_class_variable`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/unused_signal.rst b/tutorials/scripting/gdscript/warnings/unused_signal.rst index b77d0efa2d9..04beeaf990e 100644 --- a/tutorials/scripting/gdscript/warnings/unused_signal.rst +++ b/tutorials/scripting/gdscript/warnings/unused_signal.rst @@ -8,6 +8,7 @@ The warning message is: The signal "defeated" is declared but never explicitly used in the class. The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unused_signal`. When this warning occurs ------------------------ diff --git a/tutorials/scripting/gdscript/warnings/unused_variable.rst b/tutorials/scripting/gdscript/warnings/unused_variable.rst index de2aef145cb..f98a417cbd5 100644 --- a/tutorials/scripting/gdscript/warnings/unused_variable.rst +++ b/tutorials/scripting/gdscript/warnings/unused_variable.rst @@ -8,6 +8,7 @@ The warning message is: The local variable "counter" is declared but never used in the block. If this is intended, prefix it with an underscore: "_counter". The default warning level for this warning is **Warn**. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unused_variable`. When this warning occurs ------------------------ From dae7b58da66c0ed910448e4195ac4dbf54243e8a Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Mon, 31 Mar 2025 21:27:22 -0700 Subject: [PATCH 17/36] Fix typo --- .../gdscript/warnings/confusable_capture_reassignment.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/scripting/gdscript/warnings/confusable_capture_reassignment.rst b/tutorials/scripting/gdscript/warnings/confusable_capture_reassignment.rst index e383ef2495d..657c6d7b5ac 100644 --- a/tutorials/scripting/gdscript/warnings/confusable_capture_reassignment.rst +++ b/tutorials/scripting/gdscript/warnings/confusable_capture_reassignment.rst @@ -8,7 +8,7 @@ The warning message is: Reassigning lambda capture does not modify the outer local variable "my_var". The default warning level for this warning is **Warn**. -To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/confusable_capture_assignment`. +To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/confusable_capture_reassignment`. When this warning occurs ------------------------ From 5ae07d2117a7d889f3a8619913cd8bee2f3f0cf7 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Sat, 26 Apr 2025 22:44:02 -0700 Subject: [PATCH 18/36] Add doc for CONFUSABLE_IDENTIFIER --- .../gdscript/warnings/confusable_identifier.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/confusable_identifier.rst b/tutorials/scripting/gdscript/warnings/confusable_identifier.rst index 3ea8bbf5ecd..bca81d3ed53 100644 --- a/tutorials/scripting/gdscript/warnings/confusable_identifier.rst +++ b/tutorials/scripting/gdscript/warnings/confusable_identifier.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The identifier "my_vАr" has misleading characters and might be confused with something else. + The identifier "my_vаr" has misleading characters and might be confused with something else. The default warning level for this warning is **Warn**. To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/confusable_identifier`. @@ -13,13 +13,19 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/confusable_ident When this warning occurs ------------------------ -TODO +Some alphabets such as Cyrillic have characters that look like Latin (i.e., English, Spanish, etc.) characters, but are actually different. +.. code-block:: + + var engine_nаme = "Godot" + print(engine_name) + +In this code snippet, the ``print`` statement would fail, because ``engine_name`` is actually not defined. The identifier in the ``print`` statement uses the Latin character "a" (U+0061), while the identifier in the variable declaration above uses the Cyrillic character "а" (U+0430). How to fix this warning ----------------------- -TODO +Avoid using Cyrillic or other alphabets' characters that are visually similar to Latin ones. A good rule of thumb is to always use the Latin alphabet for program identifiers. From 40b1dc82a2a2da3a80ccbad368edf8f67d27d497 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Wed, 7 May 2025 21:08:49 -0700 Subject: [PATCH 19/36] Add doc for EMPTY_FILE --- tutorials/scripting/gdscript/warnings/empty_file.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/empty_file.rst b/tutorials/scripting/gdscript/warnings/empty_file.rst index 843ff0ec0f9..163e7ba031f 100644 --- a/tutorials/scripting/gdscript/warnings/empty_file.rst +++ b/tutorials/scripting/gdscript/warnings/empty_file.rst @@ -13,13 +13,12 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/empty_file Date: Wed, 7 May 2025 21:20:18 -0700 Subject: [PATCH 20/36] Add doc for ENUM_VARIABLE_WITHOUT_DEFAULT --- .../enum_variable_without_default.rst | 34 +++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/enum_variable_without_default.rst b/tutorials/scripting/gdscript/warnings/enum_variable_without_default.rst index 23fe1bc948c..d8308c12294 100644 --- a/tutorials/scripting/gdscript/warnings/enum_variable_without_default.rst +++ b/tutorials/scripting/gdscript/warnings/enum_variable_without_default.rst @@ -13,13 +13,43 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/enum_variable_wi When this warning occurs ------------------------ -TODO +This warning may appear when declaring a variable whose type is an enum with values assigned to its members, but the variable is not assigned a value. +.. code-block:: + + enum MyEnum { + A = 1, + B = 2, + C = 3 + } + + func _ready(): + var my_var: MyEnum # Will give warning ENUM_VARIABLE_WITHOUT_DEFAULT. + +Godot will usually default an enum-typed variable to the integer 0. However, if the enum does not have a member that corresponds to 0, Godot will be confused on how to assign it. How to fix this warning ----------------------- -TODO +Provide the variable with a default value, like so: + +.. code-block:: + + var my_var: MyEnum = MyEnum.A + +Alternatively, if the enum has a member with a value of 0, Godot will use that as the default value. + +.. code-block:: + + enum MyEnum { + Z = 0, # Will be used as the default value. + A = 1, + B = 2, + C = 3 + } + + func _ready(): + var my_var: MyEnum # Will default to MyEnum.Z. From 062a349e5e42a3cd5aef511598698e807f49a63b Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Wed, 7 May 2025 21:24:38 -0700 Subject: [PATCH 21/36] Add doc for INFERRED_DECLARATION --- .../gdscript/warnings/inferred_declaration.rst | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/inferred_declaration.rst b/tutorials/scripting/gdscript/warnings/inferred_declaration.rst index ec11b90f91f..c56fdc64a0d 100644 --- a/tutorials/scripting/gdscript/warnings/inferred_declaration.rst +++ b/tutorials/scripting/gdscript/warnings/inferred_declaration.rst @@ -13,13 +13,21 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/inferred_declara When this warning occurs ------------------------ -TODO +This warning may appear when creating a variable for a particular scope, such as a ``for`` loop, without specifying its type explicitly: +.. code-block:: + + for i in 10: # Will give warning INFERRED_DECLARATION. + print(i) + +In this example, the variable ``i`` did not have its type specified. It is implied to be an ``int``, but not outright stated in the code. How to fix this warning ----------------------- -TODO - +Provide a type specifier for the variable, like so: +.. code-block:: + for i: int in 10: # Will not give a warning. + print(i) From 9ace5a485134cb7332f25915a96daa0bd9634971 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Thu, 8 May 2025 15:56:53 -0700 Subject: [PATCH 22/36] Add doc for INFERENCE_ON_VARIANT --- .../gdscript/warnings/inference_on_variant.rst | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/inference_on_variant.rst b/tutorials/scripting/gdscript/warnings/inference_on_variant.rst index 5cfb7652a93..57bf3e34a23 100644 --- a/tutorials/scripting/gdscript/warnings/inference_on_variant.rst +++ b/tutorials/scripting/gdscript/warnings/inference_on_variant.rst @@ -13,13 +13,24 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/inference_on_var When this warning occurs ------------------------ -TODO +This warning may appear when using the ``:=`` operator to declare a variable with an inferred type, when the inferred type is Variant. +.. code-block:: + + func _ready(): + var my_var := get_value() # Will give warning INFERENCE_ON_VARIANT. + + func get_value(): + return 3 + +Because the return type of ``get_value()`` isn't explicitly stated to be ``int``, Godot won't assume that it only returns an ``int``, and thus will consider its return type to be ``Variant``. The ``:=`` operator will then only be able to set the type of ``my_var`` to ``Variant``, which is effectively the same as not setting a type for ``my_var`` at all. How to fix this warning ----------------------- -TODO - +If initializing a variable based on the return value of a function (like in the example above), give the function an explicit return type: +.. code-block:: + func get_value() -> int: + return 3 From e52297a622e9f1cef3734b63e9451d8c691232a4 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Thu, 8 May 2025 20:05:17 -0700 Subject: [PATCH 23/36] Add docs for INT_AS_ENUM_WITHOUT_CAST, INT_AS_ENUM_WITHOUT_MATCH, and INTEGER_DIVISION --- .../warnings/int_as_enum_without_cast.rst | 13 ++++--- .../warnings/int_as_enum_without_match.rst | 34 +++++++++++++++++-- .../gdscript/warnings/integer_division.rst | 20 +++++++++-- 3 files changed, 59 insertions(+), 8 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/int_as_enum_without_cast.rst b/tutorials/scripting/gdscript/warnings/int_as_enum_without_cast.rst index a9c70e1e461..157df45ef06 100644 --- a/tutorials/scripting/gdscript/warnings/int_as_enum_without_cast.rst +++ b/tutorials/scripting/gdscript/warnings/int_as_enum_without_cast.rst @@ -13,13 +13,18 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/int_as_enum_with When this warning occurs ------------------------ -TODO +This warning may appear when attempting to use an integer value in place of an enum value: +.. code-block:: + + var my_var: MyEnum + my_var = 1 # Will give warning INT_AS_ENUM_WITHOUT_CAST. How to fix this warning ----------------------- -TODO - - +Cast the integer value to the enum type. +.. code-block:: + var my_var: MyEnum + my_var = 1 as MyEnum diff --git a/tutorials/scripting/gdscript/warnings/int_as_enum_without_match.rst b/tutorials/scripting/gdscript/warnings/int_as_enum_without_match.rst index bcff65e0e7e..68b18fadbba 100644 --- a/tutorials/scripting/gdscript/warnings/int_as_enum_without_match.rst +++ b/tutorials/scripting/gdscript/warnings/int_as_enum_without_match.rst @@ -13,13 +13,43 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/int_as_enum_with When this warning occurs ------------------------ -TODO +This warning may appear when attempting to cast an integer value to an enum type, but the enum type doesn't have a member with a corresponding value. +.. code-block:: + + enum MyEnum { ZERO, ONE, TWO } + + func _ready(): + var my_var = 3 as MyEnum # Will give warning INT_AS_ENUM_WITHOUT_MATCH. + +The purpose of the enum is to keep track of a pre-determined number of possible values. In most cases, there is no reason to assign a value outside of those pre-determined ones, so it is considered to be likely a mistake. How to fix this warning ----------------------- -TODO +Provide a value for the enum that corresponds to the intended integer value. + +.. code-block:: + + enum MyEnum { ZERO, ONE, TWO, THREE } + + func _ready(): + var my_var = 3 as MyEnum # Will now correspond to MyEnum.THREE. + +Remember that while Godot will assign integer values to enum members by default, you can also explicitly define their corresponding values: + +.. code-block:: + + enum MyEnum { ZERO, ONE, TWO, TEN_THOUSAND = 10000 } + + func _ready(): + var my_var = 10000 as MyEnum # Will correspond to MyEnum.TEN_THOUSAND. + +Alternatively, you may just need to change the integer number you're attempting to cast as an enum value to be within the range of valid values. +.. code-block:: + enum MyEnum { ZERO, ONE, TWO } + func _ready(): + var my_var = 2 as MyEnum # Will correspond to MyEnum.TWO diff --git a/tutorials/scripting/gdscript/warnings/integer_division.rst b/tutorials/scripting/gdscript/warnings/integer_division.rst index e42866a87d4..0a132a942cc 100644 --- a/tutorials/scripting/gdscript/warnings/integer_division.rst +++ b/tutorials/scripting/gdscript/warnings/integer_division.rst @@ -13,13 +13,29 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/integer_division When this warning occurs ------------------------ -TODO +This warning may appear when attempting to divide two integers: + +.. code-block:: + + var result = 5 / 3 # Will give warning INTEGER_DIVISION. + +Because both operands are integers, the result will be an integer as well. Integers can't store fractional parts of numbers, so the result must be a whole number. Godot discards anything after the decimal point in the mathematical result to obtain the integer result. **Note that the number is not rounded to the nearest whole number.** How to fix this warning ----------------------- -TODO +Use floating-point numbers (``float``s) for the division operation: + +.. code-block:: + + var result = 5.0 / 3.0 + +If the integers being divided are variables, cast them to ``float``: +.. code-block:: + var a: int = 5 + var b: int = 3 + var result = float(a) / float(b) From e8d9d5c5ad28746fdeefb41f2955aa03d9430a84 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Thu, 8 May 2025 20:11:45 -0700 Subject: [PATCH 24/36] Add doc for NATIVE_METHOD_OVERRIDE --- .../gdscript/warnings/native_method_override.rst | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/native_method_override.rst b/tutorials/scripting/gdscript/warnings/native_method_override.rst index d91eddc5718..cc35b10ba76 100644 --- a/tutorials/scripting/gdscript/warnings/native_method_override.rst +++ b/tutorials/scripting/gdscript/warnings/native_method_override.rst @@ -13,13 +13,25 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/native_method_ov When this warning occurs ------------------------ -TODO +This warning may appear if you try to define a method in a script that has the name as a native class's method: +.. code-block:: + + extends Node + + func get_class(): # Will give warning NATIVE_METHOD_OVERRIDE. + return "MyCoolClass" + +Here, ``get_class()`` is a method on ``Object``. When Godot tries to call this class's ``get_class()`` method for internal purposes, it will use the already-existing definition, not the one the user has defined here. How to fix this warning ----------------------- -TODO +Name the function something else: +.. code-block:: + func get_class_name(): # Will not give a warning. + return "MyCoolClass" +(Note that doing this still won't override the behavior of a native method.) From 216981876a6107ac9c5c9e06960cbc627855efcd Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Thu, 8 May 2025 20:17:58 -0700 Subject: [PATCH 25/36] Add doc for RETURN_VALUE_DISCARDED --- .../warnings/return_value_discarded.rst | 20 +++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/return_value_discarded.rst b/tutorials/scripting/gdscript/warnings/return_value_discarded.rst index 22889a5dd50..36f37b66129 100644 --- a/tutorials/scripting/gdscript/warnings/return_value_discarded.rst +++ b/tutorials/scripting/gdscript/warnings/return_value_discarded.rst @@ -13,13 +13,29 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/return_value_dis When this warning occurs ------------------------ -TODO +This warning may appear if a method returns a value, but that value is not used in an expression or assigned to a variable: +.. code-block:: + + func _ready(): + print("About to get a number...") + get_number() # Will give warning RETURN_VALUE_DISCARDED. + print("Got a number!") + + func get_number() -> int: + return 5 How to fix this warning ----------------------- -TODO +Assign the returned value to a variable for use later. +.. code-block:: + + func _ready(): + print("About to get a number...") + var num = get_number() + print("Got a number! It's %s" % num) +However, some methods in Godot's APIs return values that are not necessary to store. As such, depending on the situation it may make more sense to ignore this warning. From 23fd72b26badaec1403ea2455566f860f39c02ae Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Sun, 11 May 2025 21:01:38 -0700 Subject: [PATCH 26/36] Add doc for SHADOWED_GLOBAL_IDENTIFIER --- .../warnings/shadowed_global_identifier.rst | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/shadowed_global_identifier.rst b/tutorials/scripting/gdscript/warnings/shadowed_global_identifier.rst index a8fa6e79b5b..b4651fb8d54 100644 --- a/tutorials/scripting/gdscript/warnings/shadowed_global_identifier.rst +++ b/tutorials/scripting/gdscript/warnings/shadowed_global_identifier.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The variable "str" has the same name as a built-in function. + The variable "char" has the same name as a built-in function. The default warning level for this warning is **Warn**. To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/shadowed_global_identifier`. @@ -13,13 +13,26 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/shadowed_global_ When this warning occurs ------------------------ -TODO +This warning may appear when using a name for something that is already being used for an existing: + +* built-in function (like ``char`` or ``convert``), +* native class (like ``Node`` or ``Area2D``), +* global class defined in another script file, +* or built-in type (like ``int`` or ``String``). + +When something is *shadowed*, its name is taken by something else, and as such, it can't be accessed any more within that scope. For example, if you used the code: + +.. code-block:: + + var char = "A" + +and later within this block of code, you wanted to convert an ``int`` ASCII/Unicode character point into a ``String`` (i.e., what the ``char()`` function does), you would be out of luck. How to fix this warning ----------------------- -TODO +Change the name of the identifier to something else that isn't the same as a global identifier. From e8cb120c97026a4d8efdd580c9ca2608b4105ccf Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Sun, 11 May 2025 21:12:05 -0700 Subject: [PATCH 27/36] Add doc for SHADOWED_VARIABLE_BASE_CLASS --- .../warnings/shadowed_variable_base_class.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst b/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst index 6b639a23cdd..65bb91f2baf 100644 --- a/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst +++ b/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst @@ -13,13 +13,23 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/shadowed_variabl When this warning occurs ------------------------ -TODO +This warning may appear when using a name for something that the script's base class already uses for something else. + +.. code-block:: + + extends Node + + func _ready(): + var name = "Bob" + print("Hi, my name is %s" % name) + +In this example, the ``Node`` class already defines ``name`` as the name associated with the node itself in the scene tree and editor. Before the ``var name`` declaration, writing ``name = "MyNode"`` would have set the node's name. After the declaration, though, the same line of code would not change it. In fact, after the ``var name``, the node's name can no longer be accessed within the ``_ready()`` function. This is called *shadowing*. How to fix this warning ----------------------- -TODO +Change the name to something that isn't being used by the base class. For example, if receiving a warning about using the identifier ``name``, consider using something more descriptive like ``char_name`` or ``item_name``. From 9b55aa1e241ed4cfd099f9c4090bcd152ff4da6a Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Sun, 11 May 2025 21:49:20 -0700 Subject: [PATCH 28/36] Add doc for SHADOWED_VARIABLE --- .../gdscript/warnings/shadowed_variable.rst | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/shadowed_variable.rst b/tutorials/scripting/gdscript/warnings/shadowed_variable.rst index 3e8a4e25b5f..3afafe4b94e 100644 --- a/tutorials/scripting/gdscript/warnings/shadowed_variable.rst +++ b/tutorials/scripting/gdscript/warnings/shadowed_variable.rst @@ -13,13 +13,25 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/shadowed_variabl When this warning occurs ------------------------ -TODO +This warning may appear when giving something the same name as a variable previously defined in the class. + +.. code-block:: + + extends Node + + var level = 3 + + func _ready(): + var level = 1 + print("Time for level %s" % level) + +In this example, the script class has a property ``level`` which can be accessed from its functions. However, at the first line of ``_ready()``, a new ``level`` variable is declared for that function specifically. After this declaration, any references to ``level`` will go to that version and not the shared variable for the class. This is called *shadowing*. How to fix this warning ----------------------- -TODO +Change the name to something that isn't being used by the class. For example, if receiving a warning about using the identifier ``level``, consider using something more descriptive like ``new_level``. From 5b7843c82fa319d006b2396db38274c5868884de Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Sun, 11 May 2025 21:57:51 -0700 Subject: [PATCH 29/36] Make formatting fixes --- .../warnings/get_node_default_without_onready.rst | 8 ++++++++ .../scripting/gdscript/warnings/inference_on_variant.rst | 1 + .../gdscript/warnings/int_as_enum_without_cast.rst | 1 + .../scripting/gdscript/warnings/integer_division.rst | 2 +- 4 files changed, 11 insertions(+), 1 deletion(-) diff --git a/tutorials/scripting/gdscript/warnings/get_node_default_without_onready.rst b/tutorials/scripting/gdscript/warnings/get_node_default_without_onready.rst index 183d20edc48..f678db6b4db 100644 --- a/tutorials/scripting/gdscript/warnings/get_node_default_without_onready.rst +++ b/tutorials/scripting/gdscript/warnings/get_node_default_without_onready.rst @@ -21,6 +21,8 @@ When this warning occurs In GDScript, instance variables can be set by declaring them outside of a method. Additionally, they can be given a default value using ``=``:: +.. code-block:: + extends Area2D var my_num = 3 @@ -28,6 +30,8 @@ In GDScript, instance variables can be set by declaring them outside of a method This way, the variable ``my_num`` will always start out with a value of ``3`` in each instance of this class. GDScript also has methods to retrieve specific nodes from the scene tree: namely, the :ref:`get_node() ` method, and its shorthand versions ``$`` (and ``%`` for unique nodes). Thus, if you want to have an instance variable default to a child of the node with a script, it may be tempting to write something like the following:: +.. code-block:: + extends Area2D var my_collision_shape = $CollisionShape2D @@ -39,6 +43,8 @@ How to fix this warning The most straightforward solution is to add the ``@onready`` annotation before your variable declaration:: +.. code-block:: + extends Area2D @onready var my_collision_shape = $CollisionShape2D @@ -47,6 +53,8 @@ Now, the default value of the variable will not be assigned until the scene tree Alternatively, you can set the value of the variable at the beginning of your ``_ready()`` method:: +.. code-block:: + extends Area2D var my_collision_shape diff --git a/tutorials/scripting/gdscript/warnings/inference_on_variant.rst b/tutorials/scripting/gdscript/warnings/inference_on_variant.rst index 57bf3e34a23..78059d26c74 100644 --- a/tutorials/scripting/gdscript/warnings/inference_on_variant.rst +++ b/tutorials/scripting/gdscript/warnings/inference_on_variant.rst @@ -31,6 +31,7 @@ How to fix this warning If initializing a variable based on the return value of a function (like in the example above), give the function an explicit return type: .. code-block:: + func get_value() -> int: return 3 diff --git a/tutorials/scripting/gdscript/warnings/int_as_enum_without_cast.rst b/tutorials/scripting/gdscript/warnings/int_as_enum_without_cast.rst index 157df45ef06..bc9c98c9f11 100644 --- a/tutorials/scripting/gdscript/warnings/int_as_enum_without_cast.rst +++ b/tutorials/scripting/gdscript/warnings/int_as_enum_without_cast.rst @@ -26,5 +26,6 @@ How to fix this warning Cast the integer value to the enum type. .. code-block:: + var my_var: MyEnum my_var = 1 as MyEnum diff --git a/tutorials/scripting/gdscript/warnings/integer_division.rst b/tutorials/scripting/gdscript/warnings/integer_division.rst index 0a132a942cc..1f57f6379d1 100644 --- a/tutorials/scripting/gdscript/warnings/integer_division.rst +++ b/tutorials/scripting/gdscript/warnings/integer_division.rst @@ -25,7 +25,7 @@ Because both operands are integers, the result will be an integer as well. Integ How to fix this warning ----------------------- -Use floating-point numbers (``float``s) for the division operation: +Use floating-point numbers (``float``) for the division operation: .. code-block:: From 0a5913d3e61aad8d5b873bd4a0b69d38dbca32ae Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Tue, 13 May 2025 11:16:41 -0700 Subject: [PATCH 30/36] Add doc for STANDALONE_EXPRESSION --- .../warnings/standalone_expression.rst | 30 +++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/standalone_expression.rst b/tutorials/scripting/gdscript/warnings/standalone_expression.rst index 1b80dfd5a11..8cacd73655a 100644 --- a/tutorials/scripting/gdscript/warnings/standalone_expression.rst +++ b/tutorials/scripting/gdscript/warnings/standalone_expression.rst @@ -13,13 +13,39 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/standalone_expre When this warning occurs ------------------------ -TODO +This warning may appear when writing an expression (a combination of values) that aren't assigned to anything or passed to a function: +.. code-block:: + + # Will give warning STANDALONE_EXPRESSION. + (5 * 3) + 2 + +This expression evaluates to the integer value ``17``, but after that, nothing happens to or with it. + +Note that the warning states the expression *may* have no effect, not that it *won't* have an effect. If the expression includes a function call that ends up doing more than just returning a value, the line itself ultimately will have an effect. + +.. code-block:: + + extends Node + + var counter = 0 + + func _ready(): + # Will give warning STANDALONE_EXPRESSION. + (5 * 3) + 2 * add_to_val(3) + + func add_to_val(val) -> int: + counter += 1 + return val + 2 + +Here, the line in ``_ready()`` receives the ``STANDALONE_EXPRESSION`` warning, even though the call to ``add_to_val()`` changes the ``counter`` property. (The other math calculations still won't have any effect, though.) How to fix this warning ----------------------- -TODO +If you've written an expression in your code, it's likely because you intended to use it for something. Make sure you're assigning it to a variable or passing it to a function if so. + +If you're certain that you don't need the expression for anything, remove it. Make sure to keep function calls that may have side effects (such as the ``add_to_val()`` call in the example above). From ef9c5cd99c563feda221eb6965e975c3c08e5560 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Tue, 13 May 2025 11:29:34 -0700 Subject: [PATCH 31/36] Add doc for STANDALONE_TERNARY --- .../gdscript/warnings/standalone_ternary.rst | 32 +++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/standalone_ternary.rst b/tutorials/scripting/gdscript/warnings/standalone_ternary.rst index 9e8513edefe..d2b2e25d4c6 100644 --- a/tutorials/scripting/gdscript/warnings/standalone_ternary.rst +++ b/tutorials/scripting/gdscript/warnings/standalone_ternary.rst @@ -13,13 +13,41 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/standalone_terna When this warning occurs ------------------------ -TODO +This warning may appear when writing a ternary expression that is not being assigned to anything or passed into a function: + +.. code-block:: + + # Will give warning STANDALONE_TERNARY. + 3 if visible else 0 + +This ternary expression will return either ``3`` or ``0``, but that value won't carry over to anything or have any effect on the program. + +The warning may also appear when using a ternary operator to call different functions based on a condition: + +.. code-block:: + + # Will give warning STANDALONE_TERNARY. + chase_player() if can_see_player() else be_idle() + How to fix this warning ----------------------- -TODO +If the possible return values from the ternary expression are important, assign them to a variable so they aren't lost: + +.. code-block:: + + var number = 3 if visible else 0 + +For calling different functions as seen in the second example, consider splitting it into an if-else statement. While it takes a few more lines, they will be shorter and easier to read. + +.. code-block:: + + if can_see_player(): + chase_player() + else: + be_idle() From 6d56e7471518df21406039b4cfc16be73f1ade0e Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Tue, 13 May 2025 12:02:38 -0700 Subject: [PATCH 32/36] Add doc for STATIC_CALLED_ON_INSTANCE --- .../warnings/static_called_on_instance.rst | 24 +++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/static_called_on_instance.rst b/tutorials/scripting/gdscript/warnings/static_called_on_instance.rst index 1358b5d3be1..e500ee71d22 100644 --- a/tutorials/scripting/gdscript/warnings/static_called_on_instance.rst +++ b/tutorials/scripting/gdscript/warnings/static_called_on_instance.rst @@ -13,13 +13,33 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/static_called_on When this warning occurs ------------------------ -TODO +.. + It's been a problem with other pages too, but I worry this is getting a bit repetitive with the original warning message. +This warning may appear when attempting to call a static function on an instance. + +.. code-block:: + + class MathFuncs: + static func subtract_two(val): + return val - 2 + + func _ready(): + var my_math_funcs = MathFuncs.new() + + # Will give warning STATIC_CALLED_ON_INSTANCE. + var result = my_math_funcs.subtract_two(5) + +When a function is *static*, it belongs to the class as a whole, not any one specific instance of the class. This can be quite handy for writing functions that you want to access from anywhere, without needing a class instance. How to fix this warning ----------------------- -TODO +Don't use an instance of the class to access the function. Instead, use the class name itself: + +.. code-block:: + + var result = MathFuncs.subtract_two(5) From 4e73a26a8df856832365215f10fe08512b4b2c26 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Tue, 13 May 2025 12:02:50 -0700 Subject: [PATCH 33/36] Add comments to some GDScript snippets --- tutorials/scripting/gdscript/warnings/shadowed_variable.rst | 1 + .../scripting/gdscript/warnings/shadowed_variable_base_class.rst | 1 + 2 files changed, 2 insertions(+) diff --git a/tutorials/scripting/gdscript/warnings/shadowed_variable.rst b/tutorials/scripting/gdscript/warnings/shadowed_variable.rst index 3afafe4b94e..f87b0292a46 100644 --- a/tutorials/scripting/gdscript/warnings/shadowed_variable.rst +++ b/tutorials/scripting/gdscript/warnings/shadowed_variable.rst @@ -22,6 +22,7 @@ This warning may appear when giving something the same name as a variable previo var level = 3 func _ready(): + # Will give warning SHADOWED_VARIABLE. var level = 1 print("Time for level %s" % level) diff --git a/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst b/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst index 65bb91f2baf..29566d2cf8f 100644 --- a/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst +++ b/tutorials/scripting/gdscript/warnings/shadowed_variable_base_class.rst @@ -20,6 +20,7 @@ This warning may appear when using a name for something that the script's base c extends Node func _ready(): + # Will give warning SHADOWED_VARIABLE_BASE_CLASS. var name = "Bob" print("Hi, my name is %s" % name) From 6ed918bbe7597f8f88138b275cf63f3fb337b076 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Wed, 14 May 2025 17:45:21 -0700 Subject: [PATCH 34/36] Add doc for `UNASSIGNED_VARIABLE_OP_ASSIGN` --- .../unassigned_variable_op_assign.rst | 24 ++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/unassigned_variable_op_assign.rst b/tutorials/scripting/gdscript/warnings/unassigned_variable_op_assign.rst index 048ca068d45..eb4e2ee477b 100644 --- a/tutorials/scripting/gdscript/warnings/unassigned_variable_op_assign.rst +++ b/tutorials/scripting/gdscript/warnings/unassigned_variable_op_assign.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - Using assignment with operation but the variable "my_counter" was not previously assigned a value. + The variable "my_counter" is modified with the compound-assignment operator "+=" but was not previously initialized. The default warning level for this warning is **Warn**. To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unassigned_variable_op_assign`. @@ -13,13 +13,31 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unassigned_varia When this warning occurs ------------------------ -TODO +This warning may appear when attempting to use one of the compound-assignment operators, like ``+=``, ``-=``, ``*=``, or ``/=``, on a variable that hasn't had a value assigned to it yet. +.. code-block:: + + var my_counter: int + my_counter += 1 + +Compound-assignment operators are shorthand for performing a binary math operation and an assignment operation. The above example is equivalent to: + +.. code-block:: + + var my_counter: int + my_counter = my_counter + 1 + +Here, the variable ``my_counter`` hasn't been given a value at the time that the code attempts to use the value from ``my_counter`` in order to calculate the new value for it. How to fix this warning ----------------------- -TODO +Assign an initial value to the variable before attempting to use a compound-assignment operator with it: + +.. code-block:: + + var my_counter: int = 0 + my_counter += 1 From cdfdde6b63f87ce6d5e32d5dcb9315a1e77886a5 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Wed, 14 May 2025 17:51:50 -0700 Subject: [PATCH 35/36] Add doc for UNASSIGNED_VARIABLE --- .../gdscript/warnings/unassigned_variable.rst | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/unassigned_variable.rst b/tutorials/scripting/gdscript/warnings/unassigned_variable.rst index bccdb3b9311..fd021d23316 100644 --- a/tutorials/scripting/gdscript/warnings/unassigned_variable.rst +++ b/tutorials/scripting/gdscript/warnings/unassigned_variable.rst @@ -5,7 +5,7 @@ The warning message is: .. code-block:: none - The variable "my_var" was used before being assigned a value. + The variable "my_var" is used before being assigned a value. The default warning level for this warning is **Warn**. To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unassigned_variable`. @@ -13,13 +13,24 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unassigned_varia When this warning occurs ------------------------ -TODO +This warning may appear when attempting to use a variable that hasn't had a value assigned to it yet. +.. code-block:: + + var my_var + print(my_var) + +Without having a value assigned to the variable, Godot may not know what to do with it. How to fix this warning ----------------------- -TODO +Assign a value to the variable before including it in an expression or function call: + +.. code-block:: + + var my_var = 5 + print(my_var) From 944931ff7f6a94293614ebe250c797fbb4370263 Mon Sep 17 00:00:00 2001 From: Malcolm Anderson Date: Wed, 14 May 2025 18:11:07 -0700 Subject: [PATCH 36/36] Add doc for UNREACHABLE_CODE --- .../gdscript/warnings/unreachable_code.rst | 41 ++++++++++++++++++- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/tutorials/scripting/gdscript/warnings/unreachable_code.rst b/tutorials/scripting/gdscript/warnings/unreachable_code.rst index cb020cf8a08..0c4ea7d8800 100644 --- a/tutorials/scripting/gdscript/warnings/unreachable_code.rst +++ b/tutorials/scripting/gdscript/warnings/unreachable_code.rst @@ -13,13 +13,50 @@ To modify it, see :ref:`ProjectSettings.debug/gdscript/warnings/unreachable_code When this warning occurs ------------------------ -TODO +This warning may appear there is code in a function that can never be reached because all possible code paths before it would hit a ``return`` statement and leave the function: +.. code-block:: + + func calculate_num(a): + if a > 5: + return 10 + else: + return 3 + + print("Returning zero") + return 0 + +In this function, there are only two ways the code can be run: + +* If ``a`` is greater than ``5``, the function will return ``10``, and the print statement will not be reached. +* If ``a`` is equal to or less than ``5``, the function will return ``3``, and again the print statement will not be reached. + +There is no way for code execution to get past the if-else block and to the print statement. How to fix this warning ----------------------- -TODO +If you want the code marked with the warning to be run, modify your function's logic so that there is a path to that code. + +.. code-block:: + + func calculate_num(a): + if a > 5: + return 10 + elif a > 2: # Now this condition can be false, and the print statement can be reached. + return 3 + + print("Returning zero") + return 0 + +If the code with the warning isn't important, then remove it. + +.. code-block:: + func calculate_num(a): + if a > 5: + return 10 + else: + return 3