novelate.core

Members

Enums

LayerType enum LayerType: Enumeration of layer types. There are 10 available layers ranging from 0 - 9 as indexes. 7 is the largest named frame.
Screen enum Screen: Enumeration of screens.

Functions

changeResolution void changeResolution(size_t width, size_t height, bool fullScreen): Changes the resolution of the game. This should preferebly only be of the following resolutions: 800x600, 1024x768 or 1280x720. However any resolutions are acceptable but may have side-effects attached such as invalid rendering etc. All set resolutions are saved to a res.ini file in the data folder allowing for resolutions to be kept across instances of the game.
changeScreen void changeScreen(string screen, string[] data): Changes the screen.
clearAllLayersButBackground void clearAllLayersButBackground(): Clears all layers for their components except for the background layer as that should usually be cleared by fading-in and fading-out when adding a new background. This adds smoothness to the game.
clearTempLayers void clearTempLayers(): Clears the temp layers.
getLayer Layer getLayer(size_t index): Gets a layer by its index. It retrieves it from the current selected layers whether it's the main layers or the temp layers.
initialize void initialize(): Initializes the game.
loadCreditsVideo void loadCreditsVideo(): Loads the credits video. Currently does nothing.
run void run(): Runs the game/event/UI loop.
setTempLayers void setTempLayers(): Sets the temp layers.

Meta

Source

See Source File

License

MIT (https://github.com/Novelate/NovelateEngine/blob/master/LICENSE)

Authors

Jacob Jensen (bausshf) Website: https://novelate.com/

Novelate is a free and open-source visual novel engine and framework written in the D programming language.
It can be used freely for both personal and commercial projects.

Module Description: The core module for Novelate exposes misc. core functionality of the engine.