summaryrefslogtreecommitdiffhomepage
path: root/felflame.rb
diff options
context:
space:
mode:
Diffstat (limited to 'felflame.rb')
-rw-r--r--felflame.rb72
1 files changed, 31 insertions, 41 deletions
diff --git a/felflame.rb b/felflame.rb
index 89c7f70..981211d 100644
--- a/felflame.rb
+++ b/felflame.rb
@@ -4,48 +4,38 @@ require_relative './system_manager.rb'
require_relative './scene_manager.rb'
require_relative './stage_manager.rb'
-class FelFlame
- class <<self
- def dump
- end
-
- def load
- end
-
- def Ent
- FelFlame::Entities
- end
-
- def Cmp
- FelFlame::Components
- end
-
- def Sys
- FelFlame::Systems
- end
-
- def Scn
- FelFlame::Scene
- end
+require_relative './helpers/00_tileset.rb'
+require_relative './helpers/01_component.rb'
- def Stg
- FelFlame::Stage
- end
-
- def const_missing(name)
- FelFlame.send name.to_s
- end
-
- def method_missing(name)
- if name[0] == name[0].upcase
- # TODO throw NameError
- super
- else
- super
- end
- end
+class FelFlame
+ # Creates and manages Entities. Allows accessing Entities using their {FelFlame::Entities#id ID}
+ #
+ # TODO: Improve Entity overview
+ class Entities
+ end
+ # Creates component managers and allows accessing them them under the {FelFlame::Components} namespace as Constants
+ #
+ # To see how component managers are used please look at the {FelFlame::Helper::ComponentManagerTemplate} documentation.
+ #
+ # TODO: Improve Component overview
+ class Components
+ end
+ # Creates an manages Systems.
+ #
+ # TODO: Improve System overview
+ class Systems
end
end
-FF = FelFlame # TODO Maybe find better solution?
-
+# An alias for {FelFlame}
+FF = FelFlame
+# An alias for {FelFlame::Entities}
+FF::Ent = FelFlame::Entities
+# An alias for {FelFlame::Components}
+FF::Cmp = FelFlame::Components
+# An alias for {FelFlame::Systems}
+FF::Sys = FelFlame::Systems
+# An alias for {FelFlame::Scenes}
+#FF::Sce = FelFlame::Scenes
+# An alias for {FelFlame::Stage}
+#FF::Stg = FelFlame::Stage