summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorTimo Schwarzer <me@timoschwarzer.com>2019-01-06 13:57:23 +0100
committerTimo Schwarzer <me@timoschwarzer.com>2019-01-06 14:35:40 +0100
commit5c71d433025fc3239dc69a2bc363684a5c8a86be (patch)
tree07001a935fc3e43956f62f33e4496c47ee6fedc9 /doc/classes
parent53516d7a9ec7119b3a23e5fc3fd1c61dc1e3074c (diff)
Add missing documentation for @GDScript
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/@GDScript.xml21
1 files changed, 19 insertions, 2 deletions
diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml
index 2bdfc56c44..601b1385ae 100644
--- a/doc/classes/@GDScript.xml
+++ b/doc/classes/@GDScript.xml
@@ -415,6 +415,21 @@
<return type="Array">
</return>
<description>
+ Returns an array of dictionaries representing the current call stack.
+ [codeblock]
+ func _ready():
+ foo()
+
+ func foo():
+ bar()
+
+ func bar():
+ print(get_stack())
+ [/codeblock]
+ would print
+ [codeblock]
+ [{function:bar, line:12, source:res://script.gd}, {function:foo, line:9, source:res://script.gd}, {function:_ready, line:6, source:res://script.gd}]
+ [/codeblock]
</description>
</method>
<method name="hash">
@@ -488,7 +503,7 @@
<argument index="0" name="s" type="float">
</argument>
<description>
- Returns True/False whether [code]s[/code] is an infinity value (either positive infinity or negative infinity).
+ Returns whether [code]s[/code] is an infinity value (either positive infinity or negative infinity).
</description>
</method>
<method name="is_instance_valid">
@@ -497,6 +512,7 @@
<argument index="0" name="instance" type="Object">
</argument>
<description>
+ Returns whether [code]instance[/code] is a valid object (e.g. has not been deleted from memory).
</description>
</method>
<method name="is_nan">
@@ -505,7 +521,7 @@
<argument index="0" name="s" type="float">
</argument>
<description>
- Returns True/False whether [code]s[/code] is a NaN (Not-A-Number) value.
+ Returns whether [code]s[/code] is a NaN (Not-A-Number) value.
</description>
</method>
<method name="len">
@@ -690,6 +706,7 @@
<return type="void">
</return>
<description>
+ Like [method print], but prints only when used in debug mode.
</description>
</method>
<method name="print_stack">