summaryrefslogtreecommitdiffhomepage
path: root/lib/felflame/entity_manager.rb
diff options
context:
space:
mode:
author_Tradam <[email protected]>2022-01-03 08:26:24 -0500
committerGitHub <[email protected]>2022-01-03 08:26:24 -0500
commita0f792d8feadf919290b8349dbc0eac143545927 (patch)
treeee70c5357d5969caaed08446c32746e656b223e6 /lib/felflame/entity_manager.rb
parentb535a6b1bd8019dbeba17f3853b338383208c9b3 (diff)
downloadFelECS-v4.0.0.tar.gz
FelECS-v4.0.0.zip
Major 4.0 Update (#16)v4.0.04.0.0
See Changelog
Diffstat (limited to 'lib/felflame/entity_manager.rb')
-rw-r--r--lib/felflame/entity_manager.rb124
1 files changed, 75 insertions, 49 deletions
diff --git a/lib/felflame/entity_manager.rb b/lib/felflame/entity_manager.rb
index a05ef93..ef70510 100644
--- a/lib/felflame/entity_manager.rb
+++ b/lib/felflame/entity_manager.rb
@@ -1,53 +1,53 @@
-class FelFlame
- class Entities
- # Holds the unique ID of this entity
- # @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
+# frozen_string_literal: true
+module FelFlame
+ class Entities
# Creating a new Entity
# @param components [Components] Can be any number of components, identical duplicates will be automatically purged however different components from the same component manager are allowed.
# @return [Entity]
def initialize(*components)
- # Assign new unique ID
- new_id = self.class.data.find_index(&:nil?)
- new_id = self.class.data.size if new_id.nil?
- self.id = new_id
-
# Add each component
add(*components)
-
- self.class.data[id] = self
+ self.class._data.push self
end
- # A hash that uses component manager constant names as keys, and where the values of those keys are arrays that contain the {FelFlame::ComponentManager#id IDs} of the components attached to this entity.
+ # A hash that uses component manager constant names as keys, and where the values of those keys are arrays that contain the the components attached to this entity.
# @return [Hash<Component_Manager, Array<Integer>>]
def components
@components ||= {}
end
- # An alias for the {#id ID reader}
- # @return [Integer]
- def to_i
- id
+ # A single component from a component manager. Use this if you expect the component to only belong to one entity and you want to access it. Access the component using either parameter notation or array notation. Array notation is conventional for better readablility.
+ # @example
+ # @entity.component[@component_manager] # array notation(the standard)
+ # @entity.component(@component_manager) # method notation
+ # @param manager [ComponentManager] If you pass nil you can then use array notation to access the same value.
+ # @return [Component]
+ def component(manager = nil)
+ if manager.nil?
+ FelFlame::Entities.component_redirect.entity = self
+ FelFlame::Entities.component_redirect
+ else
+ if components[manager].nil?
+ raise "This entity(#{self}) doesnt have any components of this type: #{manager}"
+ elsif components[manager].length > 1
+ Warning.warn("This entity has MANY of this component but you called the method that is intended for having a single of this component type.\nYou may have a bug in your logic.")
+ end
+
+ components[manager].first
+ end
end
- # Removes this Entity from the list and purges all references to this Entity from other Components, as well as its {id ID} and data.
+ # Removes this Entity from the list and purges all references to this Entity from other Components, as well as its data.
# @return [Boolean] +true+
def delete
- components.each do |component_manager, component_array|
- component_array.each do |component|
+ components.each do |_component_manager, component_array|
+ component_array.reverse_each do |component|
component.entities.delete(self)
end
end
- FelFlame::Entities.data[id] = nil
+ FelFlame::Entities._data.delete self
@components = {}
- @id = nil
true
end
@@ -89,6 +89,7 @@ class FelFlame
check_systems component, :removal_triggers if component.entities.include? self
component.entities.delete self
components[component.class].delete component
+ components.delete component.class if components[component.class].empty?
end
true
end
@@ -96,39 +97,64 @@ class FelFlame
# Export all data into a JSON String which can then be saved into a file
# TODO: This function is not yet complete
# @return [String] A JSON formatted String
- #def to_json() end
+ # def to_json() end
- class <<self
- include Enumerable
- # @return [Array<Entity>] Array of all Entities that exist
+ class << self
+ # Makes component managers behave like arrays with additional
+ # methods for managing the array
# @!visibility private
- def data
- @data ||= []
+ def respond_to_missing?(method, *)
+ if _data.respond_to? method
+ true
+ else
+ super
+ end
+ end
+
+ # Makes component managers behave like arrays with additional
+ # methods for managing the array
+ # @!visibility private
+ def method_missing(method, *args, **kwargs, &block)
+ if _data.respond_to? method
+ _data.send(method, *args, **kwargs, &block)
+ else
+ super
+ end
end
- # Gets an Entity from the given {id unique ID}. Usage is simular to how an Array lookup works
- #
- # @example
- # # This gets the Entity with ID 7
- # FelFlame::Entities[7]
- # @param entity_id [Integer]
- # @return [Entity] returns the Entity that uses the given unique ID, nil if there is no Entity associated with the given ID
- def [](entity_id)
- data[entity_id]
+ # Fancy method redirection for when the `component` method is called
+ # in an Entity
+ # WARNING: This method will not correctly work with multithreading
+ # @!visibility private
+ def component_redirect
+ if @component_redirect
+ else
+ @component_redirect = Object.new
+ @component_redirect.instance_variable_set(:@entity, nil)
+ @component_redirect.define_singleton_method(:entity) do
+ instance_variable_get(:@entity)
+ end
+ @component_redirect.define_singleton_method(:entity=) do |value|
+ instance_variable_set(:@entity, value)
+ end
+ @component_redirect.define_singleton_method(:[]) do |component_manager|
+ entity.component(component_manager)
+ end
+ end
+ @component_redirect
end
- # Iterates over all entities. The data is compacted so that means index does not correlate to ID.
- # You also call other enumerable methods instead of each, such as +each_with_index+ or +select+
- # @return [Enumerator]
- def each(&block)
- data.compact.each(&block)
+ # @return [Array<Entity>] Array of all Entities that exist
+ # @!visibility private
+ def _data
+ @data ||= []
end
# Creates a new entity using the data from a JSON string
# TODO: This function is not yet complete
# @param json_string [String] A string that was exported originally using the {FelFlame::Entities#to_json to_json} function
# @param opts [Keywords] What values(its {FelFlame::Entities#id ID} or the {FelFlame::ComponentManager#id component IDs}) should be overwritten TODO: this might change
- #def from_json(json_string, **opts) end
+ # def from_json(json_string, **opts) end
end
end
end