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

Update README

This commit is contained in:
Christian Treffs 2020-07-30 16:33:18 +02:00
parent bcbd9bb31c
commit 3a6145e634
No known key found for this signature in database
GPG Key ID: 49A4B4B460BE3ED4
1 changed files with 25 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -66,24 +66,41 @@ let nexus = Nexus()
then create entities by letting the `Nexus` generate them. then create entities by letting the `Nexus` generate them.
```swift ```swift
let myEntity = nexus.createEntity() // an entity without components
let newEntity = nexus.createEntity()
``` ```
You can define `Components` like this To define components conform your class to the `Component` protocol
```swift ```swift
class Movement: Component { final class Position: Component {
var position: (x: Double, y: Double) = (0.0, 1.0) var x: Int = 0
var velocity: Double = 0.1 var y: Int = 0
} }
``` ```
and assign instances of them to an `Entity` with and assign instances of it to an `Entity` with
```swift ```swift
let movement = Movement() let position = Position(x: 1, y: 2)
myEntity.assign(movement) entity.assign(position)
``` ```
You can be more efficient by assigning components while creating an entity.
```swift
// an entity with two components assigned.
nexus.createEntity {
Position(x: 1, y: 2)
Color(.red)
}
// bulk create entities with multiple components assigned.
nexus.createEntities(count: 100) { _ in
Position()
Color()
}
```
### 👪 Families ### 👪 Families
This ECS uses a grouping approach for entities with the same component types to optimize cache locality and ease up access to them. This ECS uses a grouping approach for entities with the same component types to optimize cache locality and ease up access to them.