StarOpenSource/CORE
StarOpenSource/CORE
2
0
Fork 0
Code Issues Pull requests Releases 1 Activity

Update class descriptions

Browse source
This commit is contained in:
JeremyStar™ 2024-03-31 17:59:11 +02:00
parent 5e9ef226d6
commit 6c8fc29c28
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
4 changed files with 11 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/classes/basemodule.gd
View file

@ -15,9 +15,9 @@
# You should have received a copy of the GNU Affero General Public License # You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>. # along with this program. If not, see <https://www.gnu.org/licenses/>.
## Template for CORE modules. ## Template for CORE modules.[br]
## ## [br]
## Provides a basic template and a common foundation for building CORE modules. ## Provides a basic template and a common foundation for building CORE modules.[br]
## It provides common functions and variables used in all CORE modules. ## It provides common functions and variables used in all CORE modules.
extends Node extends Node
class_name CoreBaseModule class_name CoreBaseModule

4
src/classes/config.gd
View file

@ -2,9 +2,7 @@
# Copyright (c) 2024 The StarOpenSource Project & Contributors # Copyright (c) 2024 The StarOpenSource Project & Contributors
# Licensed in the Public Domain # Licensed in the Public Domain
## The default configuration file for the CORE Framework. ## The [code]CoreConfiguration[/code] class holds the Framework's settings.[br]
##
## The [code]CoreConfiguration[/code] class holds the Framework's settings.
## The default configuration is designed to be usable without any modification. ## The default configuration is designed to be usable without any modification.
extends Node extends Node
class_name CoreConfiguration class_name CoreConfiguration

10
src/classes/loggerinstance.gd
View file

@ -15,11 +15,11 @@
# You should have received a copy of the GNU Affero General Public License # You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>. # along with this program. If not, see <https://www.gnu.org/licenses/>.
## Passes [code]origin[/code] for you. ## Passes [code]origin[/code] for you.[br]
## ## [br]
## Pretty much a wrapper around CORE's logging implementation. ## Pretty much a wrapper around CORE's logging implementation.[br]
## CoreLoggerInstance's only job is to save you some effort aka. ## CoreLoggerInstance's only job is to save you some effort aka.[br]
## you not needing to pass the [code]origin[/code] argument to each ## you not needing to pass the [code]origin[/code] argument to each[br]
## and every log call, which is extremely annoying. Thank us later ;) ## and every log call, which is extremely annoying. Thank us later ;)
extends Node extends Node
class_name CoreLoggerInstance class_name CoreLoggerInstance

6
src/classes/types.gd
View file

@ -15,15 +15,13 @@
# You should have received a copy of the GNU Affero General Public License # You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>. # along with this program. If not, see <https://www.gnu.org/licenses/>.
## Types and enums for the CORE Framework.
##
## Contains enums and types shared across the CORE Framework. ## Contains enums and types shared across the CORE Framework.
extends Node extends Node
class_name CoreTypes class_name CoreTypes
## Available version types, following the StarOpenSource Versioning Specification (SOSVS) v1 ## 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) v1 ## Available log levels, followingthe StarOpenSource Logging Specification (SOSLS) version 1
enum LoggerLevel { NONE, ERROR, WARN, INFO, VERB, DIAG } enum LoggerLevel { NONE, 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 }