godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update engine.startGame's docs.

Browse Source
This commit is contained in:
Relintai
2020-02-12 23:59:00 +01:00
parent 2f5f2e0ffd
commit f8d4b358f4
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
tutorials/platform/customizing_html5_shell.rst
View File

@@ -185,20 +185,20 @@ then the ``engine`` instance must be initialized and finally started.
:returns: Promise that resolves once the engine started.
.. js:function:: engine.startGame(mainPack)
.. js:function:: engine.startGame(execName, mainPack)
Initializes the engine if not yet initialized and starts the game with the
main pack loaded from the passed URL.
Initializes the engine if not yet initialized, loads the executable,
and starts the game with the main pack loaded from the passed URL.
If the engine isn't loaded yet, the base path of the passed URL will be
used to load the engine.
If the engine isn't loaded yet, the base path of the passed executable name
will be used to load the engine.
This function ignores overrides of filenames and their extensions to start
only the main pack passed as argument.
:param string execName:
Executable's name (URL) to start. Also used as base path to load the
engine if not loaded already. Should not contain the file's extension.
:param string mainPack:
Path to the main pack to start. Also used as base path to load the
engine if not loaded already.
Path (URL) to the main pack to start.
:returns: Promise that resolves once the game started.