mirror
/
fireblade-ecs
mirror of https://github.com/fireblade-engine/ecs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README for 0.4.0

This commit is contained in:
Christian Treffs 2018-05-10 16:13:03 +02:00
parent 33d4bf0b85
commit 6c5755324a
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -32,7 +32,7 @@ import PackageDescription
let package = Package( let package = Package(
name: "YourPackageName", name: "YourPackageName",
dependencies: [ dependencies: [
.package(url: "https://github.com/fireblade-engine/ecs.git", from: "0.3.0") .package(url: "https://github.com/fireblade-engine/ecs.git", from: "0.4.0")
], ],
targets: [ targets: [
.target( .target(
@ -86,9 +86,9 @@ Create a family by calling `.family` with a set of traits on the nexus.
A family that containts only entities with a `Movement` and `PlayerInput` component, but no `Texture` component is created by A family that containts only entities with a `Movement` and `PlayerInput` component, but no `Texture` component is created by
```swift ```swift
let family = nexus.family(requiresAll: [Movement.self, PlayerInput.self], let family = nexus.family(requiresAll: [Movement.self, PlayerInput.self],
excludesAll: [Texture.self], excludesAll: [Texture.self],
any: [Name.self]) needsAtLeastOne: [Name.self])
``` ```
These entities are cached in the nexus for efficient access and iteration. These entities are cached in the nexus for efficient access and iteration.
@ -98,12 +98,12 @@ followed by the typesafe component instances of the current entity that you may
```swift ```swift
class PlayerMovementSystem { class PlayerMovementSystem {
let family = nexus.family(requiresAll: [Movement.self, PlayerInput.self], let family = nexus.family(requiresAll: [Movement.self, PlayerInput.self],
excludesAll: [Texture.self], excludesAll: [Texture.self],
any: [Name.self]) needsAtLeastOne: [Name.self])
func update() { func update() {
family.iterate { (_, mov: Movement!, input: PlayerInput!, name: Name?) in family.iterate { (mov: Movement!, input: PlayerInput!, name: Name?) in
// position & velocity for the current entity // position & velocity for the current entity
// we know that we will have this component so we force unwrap the component // we know that we will have this component so we force unwrap the component