The highest tagged major version is
README
¶
Entity Component System
A fast, code generate ECS (no more interface{}). Game Engine agnostic.
Example:
package mycomponents
import "github.com/gabstv/ecs/v2"
type World struct {
ecs.World
}
func NewWorld() *World {
base := ecs.NewWorld()
ecs.RegisterWorldDefaults(base)
return &World{
World: base,
}
}
// Update all systems (sorted by priority)
func (w *World) Update(dt float64) {
w.EachSystem(func(s ecs.System) bool {
s.(System).Update(dt)
return true
})
}
type System interface {
ecs.System
Update(dt float64)
}
// ecsgen will create the component+system logic:
//go:generate go run ecsgen
// Position component data
//
// ecs:component
// uuid:9F414CAD-4C1B-49B2-980E-0A61302AD5DE
type Position struct {
X float64
Y float64
}
// Velocity component
//
// ecs:component
// the uuid for this component is generated automatically
type Velocity struct {
X float64
Y float64
}
// Update MovementSystem matches
//
// ecs:system
// uuid:43838027-AA12-4AD2-9F09-5DCBDA589779
// name:MovementSystem
// components: Position, Velocity
func (s *MovementSystem) Update(dt float64) {
for _, v := range s.V().Matches() {
v.Position.X += v.Velocity.X
v.Position.Y += v.Velocity.Y
}
}
Documentation
¶
Index ¶
- Constants
- func DispatchComponentEvent(c Component, t EventType, e Entity)
- func RegisterComponent(fn RegisterComponentFn)
- func RegisterSystem(fn RegisterSystemFn)
- func RegisterWorldDefaults(w World)
- type BaseSystem
- type Component
- type Entity
- type EntityFlag
- type EntityFlagSlice
- type Event
- type EventFn
- type EventListener
- type EventType
- type Flag
- type Locker
- type MatchFn
- type RegisterComponentFn
- type RegisterSystemFn
- type SortedEntities
- type System
- type View
- type World
Constants ¶
View Source
const MaxFlagCapacity = 256
Variables ¶
This section is empty.
Functions ¶
func DispatchComponentEvent ¶ added in v2.2.0
DispatchComponentEvent is a helper to dispatch component events
func RegisterComponent ¶
func RegisterComponent(fn RegisterComponentFn)
func RegisterSystem ¶
func RegisterSystem(fn RegisterSystemFn)
func RegisterWorldDefaults ¶
func RegisterWorldDefaults(w World)
Types ¶
type BaseSystem ¶
type BaseSystem struct {
// contains filtered or unexported fields
}
BaseSystem implements Enable(), Disable() and Enabled() from ecs.System
func (*BaseSystem) Enabled ¶
func (s *BaseSystem) Enabled() bool
Enabled returns if this system is enabled
type EntityFlag ¶
type EntityFlagSlice ¶
type EntityFlagSlice []EntityFlag
func (EntityFlagSlice) Len ¶
func (a EntityFlagSlice) Len() int
func (EntityFlagSlice) Less ¶
func (a EntityFlagSlice) Less(i, j int) bool
func (EntityFlagSlice) Swap ¶
func (a EntityFlagSlice) Swap(i, j int)
type EventListener ¶ added in v2.0.11
type Flag ¶
type Flag [4]uint64
Flag is a 256 bit binary flag
func MergeFlags ¶ added in v2.2.0
MergeFlags performs an OR operation to return a single flag
func (Flag) ContainsAny ¶ added in v2.1.0
ContainsAny tests if f contains at least one bit of g
type RegisterComponentFn ¶
type RegisterComponentFn func() Component
type RegisterSystemFn ¶
type RegisterSystemFn func() System
type SortedEntities ¶
type SortedEntities []Entity
SortedEntities implements sort.Interface
func (SortedEntities) Len ¶
func (a SortedEntities) Len() int
func (SortedEntities) Less ¶
func (a SortedEntities) Less(i, j int) bool
func (SortedEntities) Swap ¶
func (a SortedEntities) Swap(i, j int)
type World ¶
type World interface {
RegisterComponent(c Component)
IsRegistered(id string) bool
CFlag(e Entity) Flag
NewEntity() Entity
RemoveEntity(e Entity) bool
C(id string) Component
S(id string) System
CAdded(e Entity, c Component, key [4]byte)
CRemoved(e Entity, c Component, key [4]byte)
CWillResize(c Component, key [4]byte)
CResized(c Component, key [4]byte)
AddSystem(s System) error
RemoveSystem(s System)
EachSystem(func(s System) bool)
Dispatch(e Event)
Listen(mask EventType, fn EventFn) int64
RemoveListener(id int64)
SetFlagGroup(name string, f Flag)
FlagGroup(name string) Flag
LGet(name string) interface{}
LSet(name string, value interface{})
}
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.