aboutsummaryrefslogtreecommitdiff
path: root/lib/factories/global.js
diff options
context:
space:
mode:
authorRuben Beltran del Rio <git@r.bdr.sh>2024-05-08 18:37:48 +0200
committerRuben Beltran del Rio <git@r.bdr.sh>2024-05-08 18:37:48 +0200
commit32e2eed2a003c9be98f344ae70248139162b6969 (patch)
tree7883586f5b106a569c58bc74c3fa17f780176f27 /lib/factories/global.js
parent2b9badac1345c865c34097bc5d1699329b53fdc8 (diff)
Add a few commentsHEADmain
Diffstat (limited to 'lib/factories/global.js')
-rw-r--r--lib/factories/global.js12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/factories/global.js b/lib/factories/global.js
index bf0360d..4f36a8e 100644
--- a/lib/factories/global.js
+++ b/lib/factories/global.js
@@ -6,6 +6,15 @@ import Radius from '../components/radius';
import Up from '../components/up';
import Configuration from '../components/configuration';
+/**
+ * This file is a factory for global objects. It doesn't enforce it, but
+ * there should be only one of these entities in the engine at a given
+ * time.
+ */
+
+/**
+ * Creates a data entity that holds the configuration.
+ */
export function configuration() {
const entity = new Entity();
@@ -14,6 +23,9 @@ export function configuration() {
return entity;
}
+/**
+ * Creates a camera, used to modify the 3D view.
+ */
export function camera() {
const entity = new Entity();