Update CoreTypes online documentation
This commit is contained in:
parent
dd0274ef0b
commit
fdf09f8c8e
2 changed files with 56 additions and 20 deletions
|
@ -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.
|
|
56
docs/docs/reference/types.md
Normal file
56
docs/docs/reference/types.md
Normal 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
|
Loading…
Reference in a new issue