ecs

README

ecs

Implementation of ECS pattern

Documentation

Index

• Variables
• type BaseEntity
  • func NewBaseEntity() *BaseEntity
  • func NewBaseEntityWithID(id uint64) *BaseEntity
  • func (e *BaseEntity) GetID() uint64
  • func (e *BaseEntity) GetVersion() uint64
  • func (e *BaseEntity) SetID(id uint64)
  • func (e *BaseEntity) SetVersion(v uint64)
  • func (e *BaseEntity) UpVersion()
• type Component
• type DefaultEntityFactoryHandle
  • func InstallDefaultEntityFactory(factory *EntityFactory) *DefaultEntityFactoryHandle
  • func (h *DefaultEntityFactoryHandle) Close() error
• type Entity
• type EntityFactory
  • func DefaultEntityFactory() *EntityFactory
  • func NewEntityFactory() *EntityFactory
• type Registry
  • func NewRegistry() *Registry
  • func (r *Registry) LatestID() uint64
  • func (r *Registry) NewBaseEntity() *BaseEntity
  • func (r *Registry) NewBaseEntityWithID(id uint64) *BaseEntity
• type System
• type Versionable

Variables

var Default = NewRegistry()

Default is the package-level compatibility ECS registry used by legacy helpers.

Types

type BaseEntity

type BaseEntity struct {
	// contains filtered or unexported fields
}

BaseEntity contains required fields

func NewBaseEntity

func NewBaseEntity() *BaseEntity

NewBaseEntity return new entity.

Deprecated: use NewEntityFactory and EntityFactory.NewBaseEntity for explicit ID ownership.

func NewBaseEntityWithID

func NewBaseEntityWithID(id uint64) *BaseEntity

NewBaseEntityWithID return new entity with id.

Deprecated: use NewEntityFactory and EntityFactory.NewBaseEntityWithID for explicit ID ownership.

func (*BaseEntity) GetID

func (e *BaseEntity) GetID() uint64

GetID return id

func (*BaseEntity) GetVersion

func (e *BaseEntity) GetVersion() uint64

GetVersion return current version of object

func (*BaseEntity) SetID

func (e *BaseEntity) SetID(id uint64)

SetID set id

func (*BaseEntity) SetVersion

func (e *BaseEntity) SetVersion(v uint64)

SetVersion set current version

func (*BaseEntity) UpVersion

func (e *BaseEntity) UpVersion()

UpVersion increase current version

type Component

type Component interface {
	Update(ctx context.Context) error
}

Component is an interface which implements an ECS-System

type DefaultEntityFactoryHandle

type DefaultEntityFactoryHandle struct {
	// contains filtered or unexported fields
}

DefaultEntityFactoryHandle restores a previous package-level entity factory.

func InstallDefaultEntityFactory

func InstallDefaultEntityFactory(factory *EntityFactory) *DefaultEntityFactoryHandle

InstallDefaultEntityFactory installs a scoped package-level entity factory.

func (*DefaultEntityFactoryHandle) Close

func (h *DefaultEntityFactoryHandle) Close() error

Close restores the previous package-level entity factory.

type Entity

type Entity interface {
	GetID() uint64
}

Entity describe entity

type EntityFactory

type EntityFactory = Registry

EntityFactory aliases Registry for backward compatibility.

Deprecated: use Registry.

func DefaultEntityFactory

func DefaultEntityFactory() *EntityFactory

DefaultEntityFactory returns the package-level compatibility entity factory.

func NewEntityFactory

func NewEntityFactory() *EntityFactory

NewEntityFactory returns an isolated ECS entity factory.

Deprecated: use NewRegistry.

type Registry

type Registry struct {
	// contains filtered or unexported fields
}

Registry owns ECS entity ID generation state for application composition.

func NewRegistry

func NewRegistry() *Registry

NewRegistry returns an isolated ECS registry.

func (*Registry) LatestID

func (r *Registry) LatestID() uint64

LatestID returns the latest generated entity ID for this registry.

func (*Registry) NewBaseEntity

func (r *Registry) NewBaseEntity() *BaseEntity

NewBaseEntity returns a new entity owned by this registry.

func (*Registry) NewBaseEntityWithID

func (r *Registry) NewBaseEntityWithID(id uint64) *BaseEntity

NewBaseEntityWithID returns a new entity with an explicit ID owned by this registry.

type System

type System interface {
	Update(ctx context.Context) error
}

System is an interface which implements an ECS-System

type Versionable

type Versionable interface {
	GetVersion() uint64
	UpVersion()
}

Versionable describe version for entity