Browse Source

Add note in 'load()' docs that the path must be absolute

Michael Alexsander 5 years ago
parent
commit
6cc3bb2d9b
1 changed files with 3 additions and 2 deletions
  1. 3 2
      modules/gdscript/doc_classes/@GDScript.xml

+ 3 - 2
modules/gdscript/doc_classes/@GDScript.xml

@@ -616,9 +616,10 @@
 				Loads a resource from the filesystem located at [code]path[/code].
 				Loads a resource from the filesystem located at [code]path[/code].
 				[b]Note:[/b] Resource paths can be obtained by right-clicking on a resource in the FileSystem dock and choosing [b]Copy Path[/b].
 				[b]Note:[/b] Resource paths can be obtained by right-clicking on a resource in the FileSystem dock and choosing [b]Copy Path[/b].
 				[codeblock]
 				[codeblock]
-				# Load a scene called main located in the root of the project directory
+				# Load a scene called main located in the root of the project directory.
 				var main = load("res://main.tscn")
 				var main = load("res://main.tscn")
 				[/codeblock]
 				[/codeblock]
+				[b]Important:[/b] The path must be absolute, a local path will just return [code]null[/code].
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="log">
 		<method name="log">
@@ -786,7 +787,7 @@
 				Returns a resource from the filesystem that is loaded during script parsing.
 				Returns a resource from the filesystem that is loaded during script parsing.
 				[b]Note:[/b] Resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path".
 				[b]Note:[/b] Resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path".
 				[codeblock]
 				[codeblock]
-				# Load a scene called main located in the root of the project directory
+				# Load a scene called main located in the root of the project directory.
 				var main = preload("res://main.tscn")
 				var main = preload("res://main.tscn")
 				[/codeblock]
 				[/codeblock]
 			</description>
 			</description>