draco 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fabf6d184411f5d8dc5782499dfd2e7d07174333f6927566fb3fe51d59ae0df3
-  data.tar.gz: 5a647308729162793c8d4841b86f954298640d319dbfa836f8cb072f491c04cb
+  metadata.gz: f135d47efafef38fd731f870c963e9764f113317f1156ca3c93b10a99a87cdb3
+  data.tar.gz: c8ef07e0313011c1333886410fe43f68804da261b74b1d197742824f07c2e907
 SHA512:
-  metadata.gz: 6e754598051acec8e35c62d40d52c255bf2187fa68b6e2e18112de90661af7faa53b9bb7fc402b8425df99bac3fb6d9d6a3cf15dabb0f956004dd43a63d04ae7
-  data.tar.gz: a558139ee8f227e9307c406453b18a5280ceac36ee0386fbd3998eebfe975cb0fc6e21effff52292aab4b594fbef56498a69623aa75586d6229a0b34740613a2
+  metadata.gz: c8858f4d209549cb36b23aa300f18bde9548dfcd56cd1519a61d8a04c4f32c309e5453805358733773a9f63d0cbc8e63c0e9c21bc909acd34d3d272f549b6679
+  data.tar.gz: 175629d4ac05169ed4bfe393eff7507d0dd0e7afa62c112a464dd30d3c97876233fa6e93b51af1ecc1ccd2cb22b5b708ffc96cb1e1517232164d61b38532fa46

data/README.md

@@ -129,6 +129,27 @@ world.systems << RenderSpriteSystem
 world.tick(args)
 ```
 
+Just like with entities, we can define a subclassed template for our world.
+
+```ruby
+class Overworld < Draco::World
+  entity Goblin
+  entity Player, position: { x: 50, y: 50 }, as: :player
+  systems RenderSpriteSystem, InputSystem
+end
+
+world = Overworld.new
+```
+
+### Named Entities
+
+If there are entities that are frequently accessed in our systems, we can give these a name. In the above example, our
+player entity has been given the name `player`. We can now access this directly from our world:
+
+```ruby
+world.player
+```
+
 ## Learn More
 
 Here are some good resources to learn about Entity Component Systems

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.2.0"
+  VERSION = "0.3.1"
 
   # Public: A general purpose game object that consists of a unique id and a collection of Components.
   class Entity
@@ -39,8 +39,8 @@ module Draco
       @default_components[component] = defaults
     end
 
-    # Internal: Returns the default components for the class.
     class << self
+      # Internal: Returns the default components for the class.
       attr_reader :default_components
     end
 
@@ -373,6 +373,62 @@ module Draco
 
   # Public: The container for current Entities and Systems.
   class World
+    @default_entities = {}
+    @default_systems = []
+
+    # Internal: Resets the default components for each class that inherites Entity.
+    #
+    # sub - The class that is inheriting Entity.
+    #
+    # Returns nothing.
+    def self.inherited(sub)
+      super
+      sub.instance_variable_set(:@default_entities, {})
+      sub.instance_variable_set(:@default_systems, [])
+    end
+
+    # Public: Adds a default Entity to the World.
+    #
+    # entity - The class of the Entity to add by default.
+    # defaults - The Hash of default values for the Entity. (default: {})
+    #
+    # Examples
+    #
+    #   entity(Player)
+    #
+    #   entity(Player, position: { x: 0, y: 0 })
+    #
+    # Returns nothing.
+    def self.entity(entity, defaults = {})
+      name = defaults[:as]
+      @default_entities[entity] = defaults
+
+      attr_reader(name.to_sym) if name
+    end
+
+    # Public: Adds default Systems to the World.
+    #
+    # systems - The System or Array list of System classes to add to the World.
+    #
+    # Examples
+    #
+    #   systems(RenderSprites)
+    #
+    #   systems(RenderSprites, RenderLabels)
+    #
+    # Returns nothing.
+    def self.systems(*systems)
+      @default_systems += Array(systems).flatten
+    end
+
+    class << self
+      # Internal: Returns the default Entities for the class.
+      attr_reader :default_entities
+
+      # Internal: Returns the default Systems for the class.
+      attr_reader :default_systems
+    end
+
     # Public: Returns the Array of Systems.
     attr_reader :systems
 
@@ -384,8 +440,16 @@ module Draco
     # entities - The Array of Entities for the World (default: []).
     # systems - The Array of System Classes for the World (default: []).
     def initialize(entities: [], systems: [])
-      @entities = EntityStore.new(entities)
-      @systems = systems
+      default_entities = self.class.default_entities.map do |klass, attributes|
+        name = attributes[:as]
+        entity = klass.new(attributes)
+        instance_variable_set("@#{name}", entity) if name
+
+        entity
+      end
+
+      @entities = EntityStore.new(default_entities + entities)
+      @systems = self.class.default_systems + systems
     end
 
     # Public: Runs all of the Systems every tick.

metadata

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