summaryrefslogtreecommitdiffhomepage
path: root/lib/felflame.rb
diff options
context:
space:
mode:
author_Tradam <[email protected]>2021-12-30 07:33:12 -0500
committerGitHub <[email protected]>2021-12-30 07:33:12 -0500
commit5ef652300e71b572ca58b061610d606840ce19a9 (patch)
treeb82c99051b378c18ad4a8af98292681869dfa5a7 /lib/felflame.rb
parentac8888f6682c68d74bfb362789fb43044e1c0961 (diff)
downloadFelECS-5ef652300e71b572ca58b061610d606840ce19a9.tar.gz
FelECS-5ef652300e71b572ca58b061610d606840ce19a9.zip
Major 4.0 update (#12)
Check the changelog
Diffstat (limited to 'lib/felflame.rb')
-rw-r--r--lib/felflame.rb18
1 files changed, 9 insertions, 9 deletions
diff --git a/lib/felflame.rb b/lib/felflame.rb
index cf58990..54084bf 100644
--- a/lib/felflame.rb
+++ b/lib/felflame.rb
@@ -4,10 +4,10 @@ require_relative 'felflame/system_manager'
require_relative 'felflame/scene_manager'
require_relative 'felflame/stage_manager'
-require_relative "felflame/version"
+require_relative 'felflame/version'
# The FelFlame namespace where all its functionality resides under.
-class FelFlame
+module FelFlame
class <<self
# :nocov:
@@ -18,26 +18,26 @@ class FelFlame
# :nocov:
end
- # Creates and manages Entities. Allows accessing Entities using their {FelFlame::Entities#id ID}. Entities are just collections of Components.
+ # Creates and manages Entities. Allows iterating or accessing Entities using array methods directly on the class. Entities are just collections of Components.
class Entities; end
- # Creates component managers and allows accessing them them under the {FelFlame::Components} namespace as Constants
+ # 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::ComponentManager} documentation.
- class Components; end
+ module Components; end
- # Creates an manages Systems. Systems are the logic of the game and do not contain any data within them.
+ # Creates an manages Systems. Systems are the logic of the game and do not contain any data within them. Any systems you create are accessable under the {FelFlame::Systems} namespace as Constants.
#
# TODO: Improve Systems overview
class Systems; end
- # Creates and manages Scenes. Scenes are collections of Systems, and execute all the Systems when called upon.
+ # Creates and manages Scenes. Scenes are collections of Systems, and execute all the Systems when called upon. Any scenes you create are accessable under the {FelFlame::Scenes} namespace as Constants.
#
# TODO: Improve Scenes overview
class Scenes; end
- # Stores Scenes which you want to execute on each frame. When called upon will execute all Systems in the Scenes in the Stage and will execute them according to their priority order.
- class Stage; end
+ # Stores Scenes you add to it which you want to execute on each frame. When called upon will execute all Systems in the Scenes in the Stage and will execute them according to their priority order.
+ module Stage; end
end
# An alias for {FelFlame}