JeremyStarTM 83ea84b9ab Documentation/website release and more

This commit added:
- A website and documentation (two in one) containing a install guide and code references
- Character counting script (count_characters.sh)
- Godot development project support (making a temporary godot project)
- Makefile

2023-07-09 00:16:15 +02:00

1.4 KiB

Raw Blame History

hide

navigation

Splash Screen (core.splash)

The splash screen component allows you to display a "loading screen" whilst hiding log output (COREBackground).

Variables

image

type String
default value <splash_image config variable>
description Path to a image, displayed in the center of the splash screen.

image_size

type float
default value <splash_image_size config variable>
description The size of your image. Used for both the x and y coordinates.

color

type String
default value <splash_color config variable>
description The background color.
format AARRGGBB or RRGGBB (AA = alpha, RR = red, GG = green and BB = blue)

Methods

apply_config()

returns void
description Applies the variables "image", "image_size" and "color" to the scene.

display()

returns void
description Makes the splash screen visible.

dissolve()

returns void
description Makes the splash screen invisible.

Internal variables

Do not touch or you will cause breakage.

enabled

type bool
default value `<splash_enabled config variable>
description If the splash screen module should be displayed at CORE startup or not.

Internal methods

Do not execute or you will cause breakage.

_ready()

returns void
description Executes apply_config() and executes display() if "enabled" is true.

1.4 KiB Raw Blame History