diff options
author | Danil Alexeev <danil@alexeev.xyz> | 2024-03-14 17:51:41 +0300 |
---|---|---|
committer | Danil Alexeev <danil@alexeev.xyz> | 2024-03-14 17:51:41 +0300 |
commit | 0c48845247903ac5a8fe0477d31e262e58c91f1b (patch) | |
tree | 0323dff6d1f7a8d2a7a430a45fc5772b7772bf5d | |
parent | da945ce6266ce27ba63b6b08dc0eb2414594f7cb (diff) | |
download | redot-engine-0c48845247903ac5a8fe0477d31e262e58c91f1b.tar.gz |
Update `@GDScript` documentation
-rw-r--r-- | modules/gdscript/doc_classes/@GDScript.xml | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml index d98580b771..4869573972 100644 --- a/modules/gdscript/doc_classes/@GDScript.xml +++ b/modules/gdscript/doc_classes/@GDScript.xml @@ -43,6 +43,7 @@ assert(speed >= 0 and speed < 20) # You can also combine the two conditional statements in one check. assert(speed < 20, "the speed limit is 20") # Show a message. [/codeblock] + [b]Note:[/b] [method assert] is a keyword, not a function. So you cannot access it as a [Callable] or use it inside expressions. </description> </method> <method name="char"> @@ -131,7 +132,7 @@ - A constant from the [enum Variant.Type] enumeration, for example [constant TYPE_INT]. - An [Object]-derived class which exists in [ClassDB], for example [Node]. - A [Script] (you can use any class, including inner one). - Unlike the right operand of the [code]is[/code] operator, [param type] can be a non-constant value. The [code]is[/code] operator supports more features (such as typed arrays) and is more performant. Use the operator instead of this method if you do not need dynamic type checking. + Unlike the right operand of the [code]is[/code] operator, [param type] can be a non-constant value. The [code]is[/code] operator supports more features (such as typed arrays). Use the operator instead of this method if you do not need dynamic type checking. Examples: [codeblock] print(is_instance_of(a, TYPE_INT)) @@ -183,6 +184,7 @@ # Create instance of a scene. var diamond = preload("res://diamond.tscn").instantiate() [/codeblock] + [b]Note:[/b] [method preload] is a keyword, not a function. So you cannot access it as a [Callable]. </description> </method> <method name="print_debug" qualifiers="vararg"> @@ -717,6 +719,8 @@ <return type="void" /> <description> Make a script with static variables to not persist after all references are lost. If the script is loaded again the static variables will revert to their default values. + [b]Note:[/b] As annotations describe their subject, the [annotation @static_unload] annotation must be placed before the class definition and inheritance. + [b]Warning:[/b] Currently, due to a bug, scripts are never freed, even if [annotation @static_unload] annotation is used. </description> </annotation> <annotation name="@tool"> |