RubyGems - felflame - Versions diffs - 1.0.0 - Mend

felflame 1.0.0

Files changed (70) hide show

checksums.yaml +7 -0
data/.byebug_history +20 -0
data/.gitignore +17 -0
data/.inch.yml +11 -0
data/.rspec +1 -0
data/.rubocop.yml +13 -0
data/.yardopts +13 -0
data/CHANGELOG.md +5 -0
data/Gemfile +11 -0
data/Gemfile.lock +87 -0
data/LICENSE +21 -0
data/LICENSE.txt +21 -0
data/README.mdown +410 -0
data/Rakefile +45 -0
data/bin/console +15 -0
data/bin/setup +8 -0
data/codeclimate/export-coverage.rb +16 -0
data/deprecated/components/00_renderable.rb +19 -0
data/deprecated/components/01_sprite.rb +57 -0
data/deprecated/components/02_label.rb +32 -0
data/deprecated/components/03_player_control.rb +26 -0
data/deprecated/components/04_map.rb +21 -0
data/deprecated/components/05_interactable.rb +16 -0
data/deprecated/components/06_collidable.rb +22 -0
data/deprecated/components/07_battle.rb +4 -0
data/deprecated/components/07_indoor.rb +4 -0
data/deprecated/components/07_overworld.rb +16 -0
data/deprecated/components/debug_singleton.rb +13 -0
data/deprecated/helpers/00_tileset.rb +56 -0
data/deprecated/helpers/01_component.rb +74 -0
data/deprecated/systems/00_update_levels.rb +34 -0
data/deprecated/systems/10_player.rb +41 -0
data/deprecated/systems/99_render.rb +37 -0
data/docs/CNAME +1 -0
data/docs/FelFlame.html +317 -0
data/docs/FelFlame/ComponentManager.html +1627 -0
data/docs/FelFlame/Components.html +423 -0
data/docs/FelFlame/Entities.html +1054 -0
data/docs/FelFlame/Helper.html +142 -0
data/docs/FelFlame/Helper/ComponentManager.html +1627 -0
data/docs/FelFlame/Scenes.html +761 -0
data/docs/FelFlame/Stage.html +598 -0
data/docs/FelFlame/Systems.html +1541 -0
data/docs/_index.html +173 -0
data/docs/class_list.html +51 -0
data/docs/css/common.css +1 -0
data/docs/css/full_list.css +58 -0
data/docs/css/style.css +497 -0
data/docs/file.README.html +498 -0
data/docs/file_list.html +56 -0
data/docs/frames.html +17 -0
data/docs/index.html +498 -0
data/docs/js/app.js +314 -0
data/docs/js/full_list.js +216 -0
data/docs/js/jquery.js +4 -0
data/docs/method_list.html +475 -0
data/docs/top-level-namespace.html +137 -0
data/felflame.gemspec +45 -0
data/lib/felflame.rb +59 -0
data/lib/felflame/component_manager.rb +245 -0
data/lib/felflame/entity_manager.rb +135 -0
data/lib/felflame/scene_manager.rb +58 -0
data/lib/felflame/stage_manager.rb +70 -0
data/lib/felflame/system_manager.rb +213 -0
data/lib/felflame/version.rb +5 -0
data/logos/felflame-logo-text.png +0 -0
data/logos/felflame-logo-text.svg +172 -0
data/logos/felflame-logo.png +0 -0
data/logos/felflame-logo.svg +97 -0
metadata +239 -0

data/docs/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,137 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.26
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="FelFlame.html" title="FelFlame (class)">FelFlame</a></span>
+</p>
+    <h2>
+      Constant Summary
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+    <dl class="constants">
+        <dt id="FF-constant" class="">FF =
+          <div class="docstring">
+  <div class="discussion">
+<p>An alias for <span class='object_link'><a href="FelFlame.html" title="FelFlame (class)">FelFlame</a></span></p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='const'><span class='object_link'><a href="FelFlame.html" title="FelFlame (class)">FelFlame</a></span></span></pre></dd>
+    </dl>
+</div>
+      <div id="footer">
+  Generated on Fri Jul  9 01:56:53 2021 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.26 (ruby-2.7.3).
+</div>
+    </div>
+  </body>
+</html>

data/felflame.gemspec ADDED Viewed

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require_relative "lib/felflame/version"
+Gem::Specification.new do |spec|
+  spec.name          = "felflame"
+  spec.version       = Felflame::VERSION
+  spec.authors       = ["Tradam"]
+  spec.email         = ["felflame@tradam.dev"]
+  spec.summary       = "The Engine Agnostic ECS Ruby Framework"
+  #spec.description   = "TODO: Write a longer description or delete this line."
+  spec.homepage      = "https://felflame.tradam.fyi"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/realtradam/FelFlame"
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_development_dependency 'minitest-reporters', '~> 1.4', '>= 1.4.3'#, require: false
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'#, require: false
+  spec.add_development_dependency 'simplecov-console', '~> 0.9.1'
+  spec.add_development_dependency 'simplecov_json_formatter', '~> 0.1.3'#, require: false
+  spec.add_development_dependency 'redcarpet', '~> 3.5', '>= 3.5.1'#, require: false
+  spec.add_development_dependency 'yard', '~> 0.9.26'#, require: false
+  spec.add_development_dependency 'rubocop', '~> 1.7'
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/felflame.rb ADDED Viewed

@@ -0,0 +1,59 @@
+require_relative 'felflame/entity_manager'
+require_relative 'felflame/component_manager'
+require_relative 'felflame/system_manager'
+require_relative 'felflame/scene_manager'
+require_relative 'felflame/stage_manager'
+require_relative "felflame/version"
+# The FelFlame namespace where all its functionality resides under.
+class FelFlame
+  class <<self
+    # :nocov:
+    # An alias for {FelFlame::Stage.call}. It executes a single frame in the game.
+    def call
+      FelFlame::Stage.call
+    end
+    # :nocov:
+  end
+  # Creates and manages Entities. Allows accessing Entities using their {FelFlame::Entities#id ID}. Entities are just collections of Components.
+  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::ComponentManager} documentation.
+  class Components; end
+  # Creates an manages Systems. Systems are the logic of the game and do not contain any data within them.
+  #
+  # TODO: Improve Systems overview
+  class Systems; end
+  # Creates and manages Scenes. Scenes are collections of Systems, and execute all the Systems when called upon.
+  #
+  # 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
+end
+# 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

data/lib/felflame/component_manager.rb ADDED Viewed

@@ -0,0 +1,245 @@
+class FelFlame
+  class Components
+    @component_map = []
+    class <<self
+      include Enumerable
+      # Creates a new {FelFlame::ComponentManager component manager}.
+      #
+      # @example
+      #   # Here color is set to default to red
+      #   # while max and current are nil until set.
+      #   # When you make a new component using this component manager
+      #   # these are the values and accessors it will have.
+      #   FelFlame::Component.new('Health', :max, :current, color: 'red')
+      #
+      # @param component_name [String] Name of your new component manager. Must be stylized in the format of constants in Ruby
+      # @param attrs [:Symbols] New components made with this manager will include these symbols as accessors, the values of these accessors will default to nil
+      # @param attrs_with_defaults [Keyword: DefaultValue] New components made with this manager will include these keywords as accessors, their defaults set to the values given to the keywords
+      # @return [ComponentManager]
+      def new(component_name, *attrs, **attrs_with_defaults)
+        if FelFlame::Components.const_defined?(component_name)
+          raise(NameError.new, "Component Manager '#{component_name}' is already defined")
+        end
+        const_set(component_name, Class.new(FelFlame::ComponentManager) {})
+        attrs.each do |attr|
+          FelFlame::Components.const_get(component_name).attr_accessor attr
+        end
+        attrs_with_defaults.each do |attr, _default|
+          attrs_with_defaults[attr] = _default.dup
+          FelFlame::Components.const_get(component_name).attr_reader attr
+          FelFlame::Components.const_get(component_name).define_method("#{attr}=") do |value|
+            attr_changed_trigger_systems(attr) unless value.equal? send(attr)
+            instance_variable_set("@#{attr}", value)
+          end
+        end
+        FelFlame::Components.const_get(component_name).define_method(:set_defaults) do
+          attrs_with_defaults.each do |attr, default|
+            instance_variable_set("@#{attr}", default.dup)
+          end
+        end
+        FelFlame::Components.const_get(component_name)
+      end
+      # Iterate over all existing component managers. You also call other enumerable methods instead of each, such as +each_with_index+ or +select+
+      # @return [Enumerator]
+      def each(&block)
+        constants.each(&block)
+      end
+    end
+  end
+  # Component Managers are what is used to create individual components which can be attached to entities.
+  # When a Component is created from a Component Manager that has accessors given to it, you can set or get the values of those accessors using standard ruby message sending (e.g +@component.var = 5+), or by using the {#attrs} and {#update_attrs} methods instead.
+  class ComponentManager
+    # Holds the {id unique ID} of a component. The {id ID} is only unique within the scope of the component manager it was created from.
+    # @return [Integer]
+    attr_reader :id
+    # A seperate attr_writer was made for documentation readability reasons.
+    # Yard will list attr_reader is readonly which is my intention.
+    # This value needs to be changable as it is set by other functions.
+    # @!visibility private
+    attr_writer :id
+    # Allows overwriting the storage of triggers, such as for clearing.
+    # This method should generally only need to be used internally and
+    # not by a game developer.
+    # @!visibility private
+    attr_writer :addition_triggers, :removal_triggers, :attr_triggers
+    # Stores references to systems that should be triggered when a
+    # component from this manager is added.
+    # Do not edit this array as it is managed by FelFlame automatically.
+    # @return [Array<System>]
+    def addition_triggers
+      @addition_triggers ||= []
+    end
+    # Stores references to systems that should be triggered when a
+    # component from this manager is removed.
+    # Do not edit this array as it is managed by FelFlame automatically.
+    # @return [Array<System>]
+    def removal_triggers
+      @removal_triggers ||= []
+    end
+    # Stores references to systems that should be triggered when an
+    # attribute from this manager is changed.
+    # Do not edit this hash as it is managed by FelFlame automatically.
+    # @return [Hash<Symbol, Array<System>>]
+    def attr_triggers
+      @attr_triggers ||= {}
+    end
+    # Creates a new component and sets the values of the attributes given to it. If an attritbute is not passed then it will remain as the default.
+    # @param attrs [Keyword: Value] You can pass any number of Keyword-Value pairs
+    # @return [Component]
+    def initialize(**attrs)
+      # Prepare the object
+      # (this is a function created with metaprogramming
+      # in FelFlame::Components
+      set_defaults
+      # Generate ID
+      new_id = self.class.data.find_index { |i| i.nil? }
+      new_id = self.class.data.size if new_id.nil?
+      @id = new_id
+      # Fill params
+      attrs.each do |key, value|
+        send "#{key}=", value
+      end
+      # Save Component
+      self.class.data[new_id] = self
+    end
+    class <<self
+      # Allows overwriting the storage of triggers, such as for clearing.
+      # This method should generally only need to be used internally and
+      # not by a game developer.
+      # @!visibility private
+      attr_writer :addition_triggers, :removal_triggers, :attr_triggers
+      # Stores references to systems that should be triggered when this
+      # component is added to an enitity.
+      # Do not edit this array as it is managed by FelFlame automatically.
+      # @return [Array<System>]
+      def addition_triggers
+        @addition_triggers ||= []
+      end
+      # Stores references to systems that should be triggered when this
+      # component is removed from an enitity.
+      # Do not edit this array as it is managed by FelFlame automatically.
+      # @return [Array<System>]
+      def removal_triggers
+        @removal_triggers ||= []
+      end
+      # Stores references to systems that should be triggered when an
+      # attribute from this component changed.
+      # Do not edit this hash as it is managed by FelFlame automatically.
+      # @return [Hash<Symbol, System>]
+      def attr_triggers
+        @attr_triggers ||= {}
+      end
+      # @return [Array<Component>] Array of all Components that belong to a given component manager
+      # @!visibility private
+      def data
+        @data ||= []
+      end
+      # Gets a Component from the given {id unique ID}. Usage is simular to how an Array lookup works.
+      #
+      # @example
+      #   # this gets the 'Health' Component with ID 7
+      #   FelFlame::Components::Health[7]
+      # @param component_id [Integer]
+      # @return [Component] Returns the Component that uses the given unique {id ID}, nil if there is no Component associated with the given {id ID}
+      def [](component_id)
+        data[component_id]
+      end
+      # Iterates over all components within the component manager.
+      # Special Enumerable methods like +map+ or +each_with_index+ are not implemented
+      # @return [Enumerator]
+      def each(&block)
+        data.compact.each(&block)
+      end
+    end
+    # An alias for the {id ID Reader}
+    # @return [Integer]
+    def to_i
+      id
+    end
+    # A list of entity ids that are linked to the component
+    # @return [Array<Integer>]
+    def entities
+      @entities ||= []
+    end
+    # Update attribute values using a hash or keywords.
+    # @return [Hash<Symbol, Value>] Hash of updated attributes
+    def update_attrs(**opts)
+      opts.each do |key, value|
+        send "#{key}=", value
+      end
+    end
+    # Execute systems that have been added to execute on variable change
+    # @return [Boolean] +true+
+    def attr_changed_trigger_systems(attr)
+      systems_to_execute = self.class.attr_triggers[attr]
+      systems_to_execute = [] if systems_to_execute.nil?
+      systems_to_execute |= attr_triggers[attr] unless attr_triggers[attr].nil?
+      systems_to_execute.sort_by(&:priority).reverse.each(&:call)
+      true
+    end
+    # Removes this component from the list and purges all references to this Component from other Entities, as well as its {id ID} and data.
+    # @return [Boolean] +true+.
+    def delete
+      addition_triggers.each do |system|
+        system.clear_triggers component_or_manager: self
+      end
+      # This needs to be cloned because indices get deleted as
+      # the remove command is called, breaking the loop if it
+      # wasn't referencing a clone(will get Nil errors)
+      iter = entities.map(&:clone)
+      iter.each do |entity_id|
+        FelFlame::Entities[entity_id].remove self #unless FelFlame::Entities[entity_id].nil?
+      end
+      self.class.data[id] = nil
+      instance_variables.each do |var|
+        instance_variable_set(var, nil)
+      end
+      true
+    end
+    # @return [Hash<Symbol, Value>] A hash, where all the keys are attributes linked to their respective values.
+    def attrs
+      return_hash = instance_variables.each_with_object({}) do |key, final|
+        final[key.to_s.delete_prefix('@').to_sym] = instance_variable_get(key)
+      end
+      return_hash.delete(:attr_triggers)
+      return_hash
+    end
+    # Export all data into a JSON String, which could then later be loaded or saved to a file
+    # TODO: This function is not yet complete
+    # @return [String] a JSON formatted String
+    #def to_json
+    #  # should return a json or hash of all data in this component
+    #end
+  end
+end