kiwi-ecs 0.0.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ecb91b181779636d95d7c72fb3e8bcb6713498253b03ea8dc033a9e99027f59
-  data.tar.gz: 1e06daecfa95b5ecd6f3a6faca0a3b4385dd501ceed81ab9b6816ba62cc327df
+  metadata.gz: 6c92559b41133eb2dc4efeb25ae91bce5ddc356eed0b4164cbc284b5c8ca4eac
+  data.tar.gz: b213c479a15483424f08617bf5fb7c5b0895c8866804f4adaa0912068e6d1819
 SHA512:
-  metadata.gz: 05a2f1676d8883b1e0bdbecd4138e5c424482bedd23a945a815444c86eae88c692b769ebe8cbbfc00910b47ba4219bed79bce5e6c4f678c71de784a5e4078869
-  data.tar.gz: '08a375f932ad364d8194bd97cfd71578eaad9631e8e989c76bfb9dbd33cdacc83c93ba6afd740ee2dc3c80e79fb7576c2c213d912fffee0285ddf155fa85c54f'
+  metadata.gz: 23611a5577855aa6f67245e195942009d08535c82d4bfb5d737bc3d8c9ff9914a09cdc66c5ff920e90cbdc02038b221d8fabdc5111fd20c60bb1e94a4a185d86
+  data.tar.gz: 2adf271c5166619053826369b1458abd4b44d679f02f394f1e6da6cfef86dcb82db67f03d841e7747bd55942fd26b4e64aefa07b7f9f5de2ab30ea030f062aff

data/README.md

@@ -27,7 +27,7 @@ require 'kiwi-ecs'
 The world is the main object that controls the ecs.
 
 ```ruby
-world = World.new
+world = Kiwi::World.new
 ```
 
 ### Components

data/lib/arch_store.rb

@@ -1,5 +1,9 @@
 require_relative 'archetype'
 
+module Kiwi
+# Internal methods not meant for outside use
+module Internal
+
 class ArchStore
   # [[Integer]:Integer]
   attr_accessor :compMap
@@ -28,3 +32,6 @@ class ArchStore
     end
   end
 end
+
+end
+end

data/lib/archetype.rb

@@ -1,93 +1,97 @@
-ComponentColumn = Struct.new(:components)
-
-class Archetype
-  # @params [Array<Integer>] componentIds
-  def initialize(componentIds)
-    # [Integer(componentId): ComponentColumn]
-    @components = componentIds.map do |compId|
-      [compId, ComponentColumn.new([])]
-    end.to_h
-    @availableEntityRows = []
-    @entities = []
-  end
-
-  # @return [int]
-  def new_arch_row_id(entityId)
-    id = @availableEntityRows.pop
-    if id != nil
-      @entities[id] = entityId
-      return id
-    else
-      id = @entities.size
-      @entities.push entityId
-      return id
-    end
-  end
-
-  def set_component(archRowId, component)
-    compCol = @components[component.class.object_id]
-    if compCol.components.size <= archRowId
-      compCol.components.push component
-    else
-      compCol.components[archRowId] = component
-    end
-  end
-
-  def get_component(archRowId, componentId)
-    return @components[componentId].components[archRowId]
-  end
-
-  def has_component(componentId)
-    return @components[componentId] != nil
-  end
+module Kiwi
+  module Internal
+    ComponentColumn = Struct.new(:components)
+    
+    class Archetype
+      # @params [Array<Integer>] componentIds
+      def initialize(componentIds)
+        # [Integer(componentId): ComponentColumn]
+        @components = componentIds.map do |compId|
+          [compId, ComponentColumn.new([])]
+        end.to_h
+        @availableEntityRows = []
+        @entities = []
+      end
 
-  def remove_entity(archRowId)
-    @availableEntityRows.push(archRowId)
-    @entities[archRowId] = nil
-  end
+      # @return [int]
+      def new_arch_row_id(entityId)
+        id = @availableEntityRows.pop
+        if id != nil
+          @entities[id] = entityId
+          return id
+        else
+          id = @entities.size
+          @entities.push entityId
+          return id
+        end
+      end
 
-  # @return [[Component, EntityId]]
-  def active_components(componentIds)
-    # [comp1a, comp1b]
-    # [comp2a, comp2b]
-    # ...
-    components = componentIds
-      .map do |compId|
-        @components[compId].components
+      def set_component(archRowId, component)
+        compCol = @components[component.class.object_id]
+        if compCol.components.size <= archRowId
+          compCol.components.push component
+        else
+          compCol.components[archRowId] = component
+        end
       end
-    compCount = componentIds.size
 
-    @entities
-      .each_with_index
-      .filter do |entId, _|
-        entId != nil
+      def get_component(archRowId, componentId)
+        return @components[componentId].components[archRowId]
       end
-      .map do |_, rowIdx|
-        (0...compCount).map do |compRowId|
-          components[compRowId][rowIdx]
-        end
+
+      def has_component(componentId)
+        return @components[componentId] != nil
       end
-  end
 
-  def components_and_ids(componentIds)
-    # [comp1a, comp1b]
-    # [comp2a, comp2b]
-    # ...
-    components = componentIds
-      .map do |compId|
-        @components[compId].components
+      def remove_entity(archRowId)
+        @availableEntityRows.push(archRowId)
+        @entities[archRowId] = nil
       end
-    compCount = componentIds.size
 
-    @entities
-      .each_with_index
-      .filter do |entId, _|
-        entId != nil
+      # @return [[Component, EntityId]]
+      def active_components(componentIds)
+        # [comp1a, comp1b]
+        # [comp2a, comp2b]
+        # ...
+        components = componentIds
+          .map do |compId|
+            @components[compId].components
+          end
+        compCount = componentIds.size
+
+        @entities
+          .each_with_index
+          .filter do |entId, _|
+            entId != nil
+          end
+          .map do |_, rowIdx|
+            (0...compCount).map do |compRowId|
+              components[compRowId][rowIdx]
+            end
+          end
       end
-      .map do |entId, rowIdx|
-        [entId, *(0...compCount).map do |compRowId|
-          components[compRowId][rowIdx]
-        end]
+
+      def components_and_ids(componentIds)
+        # [comp1a, comp1b]
+        # [comp2a, comp2b]
+        # ...
+        components = componentIds
+          .map do |compId|
+            @components[compId].components
+          end
+        compCount = componentIds.size
+
+        @entities
+          .each_with_index
+          .filter do |entId, _|
+            entId != nil
+          end
+          .map do |entId, rowIdx|
+            [entId, *(0...compCount).map do |compRowId|
+              components[compRowId][rowIdx]
+            end]
+          end
       end
+    end
   end
 end

data/lib/bitmap.rb

@@ -1,3 +1,6 @@
+module Kiwi
+module Internal
+
 # TODO: actual bitmap implementation
 class Bitmap
   def initialize
@@ -30,3 +33,6 @@ class Bitmap
     end
   end
 end
+
+end
+end

data/lib/entity.rb

@@ -1,6 +1,9 @@
 require 'set'
 require_relative 'bitmap'
 
+module Kiwi
+module Internal
+
 Entity = Struct.new(:archId, :archRow)
 
 class EntityStore
@@ -100,3 +103,6 @@ class EntityStore
     end
   end
 end
+
+end
+end

data/lib/kiwi-ecs.rb

@@ -5,14 +5,14 @@
 # Copyright (C) 2023  Jonas Everaert
 # 
 # This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
+# it under the terms of the GNU Lesser General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 # 
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
+# GNU Lesser General Public License for more details.
 # 
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.

data/lib/query.rb

@@ -1,3 +1,5 @@
+module Kiwi
+module Internal
 module Query
   # @return [enumerator<Integer>]
   def query_ids
@@ -23,6 +25,12 @@ module Query
           .active_components(componentIds)
       end
 
+    if componentType.size == 1
+      result = result.map do |c|
+        c[0]
+      end
+    end
+
     if block_given?
       result.each do |a|
         yield a
@@ -54,3 +62,5 @@ module Query
     end
   end
 end
+end
+end

data/lib/world.rb

@@ -2,63 +2,65 @@ require_relative 'entity'
 require_relative 'arch_store'
 require_relative 'query'
 
-class World
-  def initialize
-    @entityStore = EntityStore.new
-    @archStore = ArchStore.new
-  end
+module Kiwi
+  class World
+    def initialize
+      @entityStore = Kiwi::Internal::EntityStore.new
+      @archStore = Kiwi::Internal::ArchStore.new
+    end
 
-  def spawn(*components)
-    compIds = components.map { |c| c.class.object_id }.sort
-    archId = @archStore.get_archetype_id(compIds)
-    entId = @entityStore.new_id
-    archetype = @archStore.get(archId)
-    archRowId = archetype.new_arch_row_id(entId)
-    @entityStore.spawn(entId, archId, archRowId)
-    for component in components
-      archetype.set_component(archRowId, component)
+    def spawn(*components)
+      compIds = components.map { |c| c.class.object_id }.sort
+      archId = @archStore.get_archetype_id(compIds)
+      entId = @entityStore.new_id
+      archetype = @archStore.get(archId)
+      archRowId = archetype.new_arch_row_id(entId)
+      @entityStore.spawn(entId, archId, archRowId)
+      for component in components
+        archetype.set_component(archRowId, component)
+      end
+      return entId
     end
-    return entId
-  end
 
-  def get_component(entityId, componentType)
-    entity = @entityStore.get(entityId)
-    archetype = @archStore.get(entity.archId)
-    archetype.get_component(entity.archRow, componentType.object_id)
-  end
+    def get_component(entityId, componentType)
+      entity = @entityStore.get(entityId)
+      archetype = @archStore.get(entity.archId)
+      archetype.get_component(entity.archRow, componentType.object_id)
+    end
 
-  def kill(entityId)
-    entity = @entityStore.get entityId
-    @entityStore.kill(entityId)
-    archetype = @archStore.get(entity.archId)
-    archetype.remove_entity(entity.archRow)
-  end
+    def kill(entityId)
+      entity = @entityStore.get entityId
+      @entityStore.kill(entityId)
+      archetype = @archStore.get(entity.archId)
+      archetype.remove_entity(entity.archRow)
+    end
 
-  def entity_count
-    return @entityStore.entity_count
-  end
+    def entity_count
+      return @entityStore.entity_count
+    end
 
-  def has_component(entityId, componentType)
-    entity = @entityStore.get(entityId)
-    archetype = @archStore.get(entity.archId)
-    return archetype.has_component(componentType.object_id)
-  end
+    def has_component(entityId, componentType)
+      entity = @entityStore.get(entityId)
+      archetype = @archStore.get(entity.archId)
+      return archetype.has_component(componentType.object_id)
+    end
 
-  def has_flag(entityId, flagId)
-    return @entityStore.has_flag entityId, flagId
-  end
+    def has_flag(entityId, flagId)
+      return @entityStore.has_flag entityId, flagId
+    end
 
-  def has_flags(entityId, *flagIds)
-    return flagIds.filter { |flagId| !@entityStore.has_flag entityId, flagId }.count == 0
-  end
+    def has_flags(entityId, *flagIds)
+      return flagIds.filter { |flagId| !@entityStore.has_flag entityId, flagId }.count == 0
+    end
 
-  def set_flag(entityId, flagId)
-    @entityStore.set_flag(entityId, flagId)
-  end
+    def set_flag(entityId, flagId)
+      @entityStore.set_flag(entityId, flagId)
+    end
 
-  def remove_flag(entityId, flagId)
-    @entityStore.remove_flag(entityId, flagId)
-  end
+    def remove_flag(entityId, flagId)
+      @entityStore.remove_flag(entityId, flagId)
+    end
 
-  include Query
+    include Kiwi::Internal::Query
+  end
 end

metadata

@@ -1,17 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: kiwi-ecs
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
 platform: ruby
 authors:
 - Jonas Everaert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-11 00:00:00.000000000 Z
+date: 2023-08-13 00:00:00.000000000 Z
 dependencies: []
-description: Kiwi is a versatile entity component system that is focussed on fast
-  iteration and a nice api
+description: |-
+  == Description
+
+  ["Kiwi is a versatile entity component system focussing on fast iteration and a nice api.\n", "\n", "To get started, read the [usage guide](#usage) below.\n", "\n", "[![Tests](https://github.com/Jomy10/kiwi-ecs-ruby/actions/workflows/tests.yml/badge.svg)](https://github.com/Jomy10/kiwi-ecs-ruby/actions/workflows/tests.yml)\n", "\n", "## Installation\n", "\n", "The library is available from [ruby gems](https://rubygems.org/gems/kiwi-ecs):\n", "\n", "```sh\n", "gem install kiwi-ecs\n", "```\n", "\n", "To use it in your ruby source files:\n", "\n", "```ruby\n", "require 'kiwi-ecs'\n", "```\n", "\n", "## Usage\n", "\n", "### The world\n", "\n", "The world is the main object that controls the ecs.\n", "\n", "```ruby\n", "world = Kiwi::World.new\n", "```\n", "\n", "### Components\n", "\n", "Creating a component is as simple as declaring a struct:\n", "\n", "```ruby\n", "Position = Struct.new :x, :y\n", "```\n", "\n", "Classes can also be used instead of structs\n", "\n", "```ruby\n", "class Velocity\n", "  attr_accessor :x\n", "  attr_accessor :y\n", "end\n", "```\n", "\n", "### Entities\n", "\n", "An entity is spawned with a set of components:\n", "\n", "```ruby\n", "entityId = world.spawn(Position.new(10, 10))\n", "\n", "world.spawn(Position.new(3, 5), Velocity.new(1.5, 0.0))\n", "```\n", "\n", "The `world.spawn(*components)` function will return the id of the spawned entity.\n", "\n", "Killing an entity can be done using `world.kill(entityId)`:\n", "\n", "```ruby\n", "world.kill(entityId)\n", "```\n", "\n", "### Systems\n", "\n", "#### Queries\n", "\n", "Queries can be constructed as follows:\n", "\n", "```ruby\n", "# Query all position componentss\n", "world.query(Position) do |pos|\n", "    puts pos\n", "end\n", "\n", "# Query all entities having a position and a velocity component, and their entity ids\n", "world.query_with_ids(Position, Velocity) do |id, pos, vel|\n", "  # ...\n", "end\n", "```\n", "\n", "### Flags\n", "\n", "Entities can be tagged using flags\n", "\n", "#### Defining flags\n", "\n", "A flag is an integer\n", "\n", "```ruby\n", "module Flags\n", "  Player = 0\n", "  Enemy = 1\n", "end\n", "```\n", "\n", "#### Setting flags\n", "\n", "```ruby\n", "id = world.spawn\n", "\n", "world.set_flag(id, Flags::Player)\n", "```\n", "\n", "#### Removing a flag\n", "\n", "```ruby\n", "world.remove_flag(id, Flags::Player)\n", "```\n", "\n", "#### Checking wether an entity has a flag\n", "\n", "```ruby\n", "world.has_flag(id, Flags::Player)\n", "```\n", "\n", "#### Filtering queries with flags\n", "\n", "```ruby\n", "world.query_with_ids(Pos)\n", "  .filter do |id, pos|\n", "    world.has_flag(id, Flags::Player)\n", "  end\n", "  .each do |id, pos|\n", "    # Do something with the filtered query\n", "  end\n", "```\n", "\n", "The `hasFlags` function is also available for when you want to check multiple flags.\n", "\n", "## Road map\n", "\n", "- [ ] System groups\n", "\n", "## Contributing\n", "\n", "Contributors are welcome to open an issue requesting new features or fixes or opening a pull request for them.\n", "\n", "## License\n", "\n", "The library is licensed under LGPLv3.\n"]
 email: 
 executables: []
 extensions: []