asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document print_stack() and get_stack() requiring a debugger connection

Browse source 
(cherry picked from commit 530e31d4a3)
This commit is contained in:
Hugo Locurcio 2022-09-28 08:30:53 +02:00 committed by Haoyu Qiu
parent 0873cf0656
commit 5e0ef339ff
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
modules/gdscript/doc_classes/@GDScript.xml
View file

@ -359,7 +359,7 @@
<method name="get_stack">
<return type="Array" />
<description>
Returns an array of dictionaries representing the current call stack.
Returns an array of dictionaries representing the current call stack. See also [method print_stack].
[codeblock]
func _ready():
foo()
@ -374,6 +374,7 @@
[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]
[b]Note:[/b] [method get_stack] only works if the running instance is connected to a debugging server (i.e. an editor instance). [method get_stack] will not work in projects exported in release mode, or in projects exported in debug mode if not connected to a debugging server.
</description>
</method>
<method name="hash">
@ -727,11 +728,12 @@
<method name="print_stack">
<return type="void" />
<description>
Prints a stack track at code location, only works when running with debugger turned on.
Prints a stack trace at the current code location. See also [method get_stack].
Output in the console would look something like this:
[codeblock]
Frame 0 - res://test.gd:16 in function '_process'
[/codeblock]
[b]Note:[/b] [method print_stack] only works if the running instance is connected to a debugging server (i.e. an editor instance). [method print_stack] will not work in projects exported in release mode, or in projects exported in debug mode if not connected to a debugging server.
</description>
</method>
<method name="printerr" qualifiers="vararg">