draco 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c3c9cbbaf38c7b5b07e5bc31dc43cd3f046f37290b165e3133c4617e10cdb54
-  data.tar.gz: f7ec6ce41ca9d9a9d7c6de52cb3c89f4d1b1a4998d7ebb8467c6bf511d41e78d
+  metadata.gz: 1057daf5d6bb88b4877d001fe21d123557cb720df446d9ff2c0111a58baceb0f
+  data.tar.gz: a96296838c903442df84482a8eb57346fc8225a34a6842f352d8d3ec1cc955cb
 SHA512:
-  metadata.gz: 595424485c3bde045b8679fe8efc00a3c77109f381902f71b47abcec17a6c729529f902e0c32d194308088d9e9ce1ac80e4343a19d01a6aa6f25ce8c3437ca78
-  data.tar.gz: c4e6ad8b15416fc9646b1c1540c34bc8752d55fe01662c7c49f84f7496794b7d1a7993abc959b97e65dd03d44fb9a6521461a30eebc2d54db97fb79b07236b53
+  metadata.gz: 502d00bc7c2d3e099548c8c2211182ae95bbb0d35de8dba9e20f232046803740bfa3331a8bf94a414b4c5ecaad7c86a570fdcb53fec8325e07191eec4342a3ec
+  data.tar.gz: f19a25eca8d942dea85a8835f8e239d3a81613a9667c788dba4eadb021876b90938e533bb049bf50155f316a16fe43065dd730b9578a927ea3691a2775b8538f

data/README.md

@@ -23,6 +23,19 @@ This repository includes a sample application in `samples/teeny-tiny`.
 2. Copy `lib/draco.rb` into your new `lib` directory.
 3. In your `main.rb` file, require `app/lib/draco.rb`.
 
+## Support
+
+- Find a bug? [Open an issue](https://github.com/guitsaru/draco/issues).
+- Need help? [Start a Discussion](https://github.com/guitsaru/draco/discussions) or [Join us in Discord: Channel #oss-draco](https://discord.gg/vPUNtwfm).
+
+## Versioning
+
+Draco uses [https://semver.org/].
+
+* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
 ## Usage
 
 ### Components
@@ -161,6 +174,19 @@ player entity has been given the name `player`. We can now access this directly
 world.player
 ```
 
+### Fetching entities by id
+
+In some cases you'll want to keep track of entities by their id, such as when you want to keep track of another entity in a component.
+
+```ruby
+entity = Player.new
+entity.id
+# => 12
+
+world.entities[12] == entity
+# => true
+```
+
 ## Learn More
 
 Here are some good resources to learn about Entity Component Systems
@@ -172,6 +198,8 @@ Here are some good resources to learn about Entity Component Systems
 
 Draco is licensed under AGPL. You can purchase the right to use Draco under the [commercial license](https://github.com/guitsaru/draco/blob/master/COMM-LICENSE).
 
+Each purchase comes with free upgrades for the current major version of Draco.
+
 <a class="gumroad-button" href="https://guitsaru.itch.io/draco" target="_blank">Purchase Commercial License</a>
 
 ## Development

data/lib/draco.rb

@@ -5,7 +5,7 @@
 # An Entity Component System is an architectural pattern used in game development to decouple behavior from objects.
 module Draco
   # Public: The version of the library. Draco uses semver to version releases.
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 
   # Public: A general purpose game object that consists of a unique id and a collection of Components.
   class Entity
@@ -505,19 +505,26 @@ module Draco
       def initialize(*entities)
         @entity_to_components = Hash.new { |hash, key| hash[key] = Set.new }
         @component_to_entities = Hash.new { |hash, key| hash[key] = Set.new }
+        @entity_ids = {}
 
         self << entities
       end
 
-      # Internal: Gets all Entities that implement all of the given Components
+      # Internal: Gets all Entities that implement all of the given Components or that match the given entity ids.
       #
-      # components - The Component Classes to filter by
+      # components_or_ids - The Component Classes to filter by
       #
       # Returns a Set list of Entities
-      def [](*components)
-        components
+      def [](*components_or_ids)
+        components_or_ids
           .flatten
-          .map { |component| @component_to_entities[component] }
+          .map do |component_or_id|
+            if component_or_id.is_a?(Numeric)
+              Array(@entity_ids[component_or_id])
+            else
+              @component_to_entities[component_or_id]
+            end
+          end
           .reduce { |acc, i| i & acc }
       end
 
@@ -539,6 +546,8 @@ module Draco
       def add(entity)
         entity.subscribe(self)
 
+        @entity_ids[entity.id] = entity
+
         components = entity.components.map(&:class)
         @entity_to_components[entity].merge(components)
 
@@ -555,6 +564,7 @@ module Draco
       #
       # Returns the EntityStore
       def delete(entity)
+        @entity_ids.delete(entity.id)
         components = Array(@entity_to_components.delete(entity))
 
         components.each do |component|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: draco
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Matt Pruitt