krgamestudios/Toy
1
0
Fork 0
mirror of https://github.com/krgamestudios/Toy.git synced 2026-04-15 23:04:08 +10:00
Code Issues Packages Projects Releases Wiki Activity

Stopping to add a feature

Browse Source
This commit is contained in:
Kayne Ruse
2023-03-03 00:02:47 +11:00
committed by GitHub
parent 50db8e5bf6
commit 3e52ae7d61
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
getting-started/game-engine.md
View File

@@ -87,10 +87,22 @@ These may change or expand as more input devices are added, and the engine matur
A series of libraries are provided to allow Toy to interface and control the engine. In addition, the libraries stored within Toy's `repl/` directory are also available (see the main page for the list). A series of libraries are provided to allow Toy to interface and control the engine. In addition, the libraries stored within Toy's `repl/` directory are also available (see the main page for the list).
During startup, the script named `init.toy` in the root of the scripts directory is executed. This file can be used to configure input mappings, as well as initializing the window and node tree.
# Engine API # Engine API
The engine API is for controlling the core of the engine directly. The engine API is for controlling the core of the engine directly.
## initWindow(caption: string, width: int, height: int, fullscreen: bool)
This function initializes the game's window, as well as specifying it's dimensions and properties. There is only one window - calling this multiple times is a fatal error. Also, the game's loop will simply not run if the window hasn't been initialized.
## loadRootNode(fname: string)
TODO
## getRootNode(): opaque
TODO TODO
# Node API # Node API