Compare commits

..

3 commits

Author SHA1 Message Date
fdf09f8c8e
Update CoreTypes online documentation 2024-05-04 12:39:19 +02:00
dd0274ef0b
Update docusaurus config 2024-05-04 12:39:09 +02:00
4a57edff95
Fix typo 2024-05-04 12:38:49 +02:00
4 changed files with 59 additions and 23 deletions

View file

@ -1,20 +0,0 @@
---
sidebar_position: 2
description: Contains various enums.
---
# `CoreTypes`
Contains globaly accessible custom enums and types used throughout the CORE Framework's source code.
## Enums
### <u>VersionType</u>{ RELEASE, RELEASECANDIDATE, BETA, ALPHA }
Available version types, following the StarOpenSource Versioning Specification (SOSVS) version 1.
### <u>LoggerLevel</u>{ NONE, ERROR, WARN, INFO, VERB, DIAG }
Available log levels, followingthe StarOpenSource Logging Specification (SOSLS) version 1.
### <u>SceneType</u>{ NONE, DEBUG, CUTSCENE, MENU, MAIN, BACKGROUND }
Available scene types.
### <u>BlockadeLevel</u>{ IGNORE, WARN, BLOCK }
To what degree *something* should be blocked.
### <u>ValidationType</u>{ MATCHES_TYPE, MATCHES_CLASS, IN_RANGE, HAS_MINIMUM, HAS_MAXIMUM, HAS_VALUES, CONTAINS, MATCHES_REGEX, IS_NOT_EMPTY, IS_NOT_NULL, IS_NORMALIZED, IS_ORTHONORMALIZED }
All validation rules some data can be checked against.

View file

@ -0,0 +1,56 @@
---
sidebar_position: 2
description: Contains various enums.
---
# `CoreTypes`
Contains globaly accessible custom enums and types used throughout the CORE Framework's source code.
## Enums
### <u>VersionType</u>
Available version types, following the StarOpenSource Versioning Specification (SOSVS) version 1.
#### Available values
- RELEASE
- RELEASECANDIDATE
- BETA
- ALPHA
### <u>LoggerLevel</u>
Available log levels, following the StarOpenSource Logging Specification (SOSLS) version 1.
#### Available values
- NONE
- ERROR
- WARN
- INFO
- VERB
- DIAG
### <u>SceneType</u>
Available scene types.
### Available values
- NONE
- DEBUG
- CUTSCENE
- MENU
- MAIN
- BACKGROUND
### <u>BlockadeLevel</u>
To what degree *something* should be blocked.
#### Available values
- IGNORE
- WARN
- BLOCK
### <u>ValidationType</u>
All validation rules some data can be checked against.
#### Available values
- MATCHES_TYPE
- MATCHES_CLASS
- IN_RANGE
- HAS_MINIMUM
- HAS_MAXIMUM
- HAS_VALUES
- CONTAINS
- MATCHES_REGEX
- IS_NOT_EMPTY
- IS_NOT_NULL
- IS_NORMALIZED
- IS_ORTHONORMALIZED

View file

@ -11,7 +11,7 @@ const config: Config = {
trailingSlash: true, trailingSlash: true,
i18n: { i18n: {
defaultLocale: "en", defaultLocale: "en",
locales: ["en"], locales: [ "en" ],
}, },
noIndex: false, noIndex: false,
onBrokenLinks: "throw", onBrokenLinks: "throw",
@ -24,7 +24,7 @@ const config: Config = {
onBrokenMarkdownLinks: "ignore", onBrokenMarkdownLinks: "ignore",
onDuplicateRoutes: "ignore", onDuplicateRoutes: "ignore",
*/ */
tagline: "// TODO", tagline: "Simplifying Godot development since 2023.",
themeConfig: { themeConfig: {
docs: { docs: {

View file

@ -23,7 +23,7 @@ class_name CoreTypes
## Available version types, following the StarOpenSource Versioning Specification (SOSVS) version 1. ## Available version types, following the StarOpenSource Versioning Specification (SOSVS) version 1.
enum VersionType { RELEASE, RELEASECANDIDATE, BETA, ALPHA } enum VersionType { RELEASE, RELEASECANDIDATE, BETA, ALPHA }
## Available log levels, followingthe StarOpenSource Logging Specification (SOSLS) version 1. ## Available log levels, following the StarOpenSource Logging Specification (SOSLS) version 1.
enum LoggerLevel { NONE, SPECIAL, ERROR, WARN, INFO, VERB, DIAG } enum LoggerLevel { NONE, SPECIAL, ERROR, WARN, INFO, VERB, DIAG }
## Available scene types. ## Available scene types.
enum SceneType { NONE, DEBUG, CUTSCENE, MENU, MAIN, BACKGROUND } enum SceneType { NONE, DEBUG, CUTSCENE, MENU, MAIN, BACKGROUND }