From bef23c0ed4cfd9c7b614743bd2774f4c17dbea15 Mon Sep 17 00:00:00 2001 From: Kayne Ruse Date: Mon, 31 Jul 2023 12:07:42 +1000 Subject: [PATCH] Added box version info library --- game-engine/box-version-info-library.md | 32 +++++++++++++++++++++++++ index.md | 1 + 2 files changed, 33 insertions(+) create mode 100644 game-engine/box-version-info-library.md diff --git a/game-engine/box-version-info-library.md b/game-engine/box-version-info-library.md new file mode 100644 index 0000000..692db10 --- /dev/null +++ b/game-engine/box-version-info-library.md @@ -0,0 +1,32 @@ +# Box Version Info Library + +The box_version_info library simply provides version info about the current build of Box. + +The box_version_info library can usually be accessed with the `import` keyword: + +``` +import box_version_info; +import box_version_info as box_version_info; //can be aliased +``` + +## Defined Variables + +### major + +This variable is the major version number of Box at the time of compilation. + +### minor + +This variable is the minor version number of Box at the time of compilation. + +### patch + +This variable is the patch version number of Box at the time of compilation. + +### build + +This variable is a string representing the date and time that the engine was compiled. + +### author + +This variable contains the name of Box's lead author, and his game studio. diff --git a/index.md b/index.md index 10b45ab..f1cf6ea 100644 --- a/index.md +++ b/index.md @@ -83,6 +83,7 @@ print tally(); //3 Note: This section is WIP. * [Game Engine](game-engine/game-engine.md) +* [Box Version Info Library](game-engine/box-version-info-library.md) * Engine Library * Node Library * Input Library