ecs

Documentation

Index

• func NewQuery(l LayerID, f filter.LayoutFilter) *donburi.Query
• type Arg
• type ECS
  • func NewECS(w donburi.World) *ECS
  • func (ecs *ECS) AddRenderer(l LayerID, r any) *ECS
  • func (ecs *ECS) AddSystem(s System) *ECS
  • func (ecs *ECS) Create(l LayerID, components ...donburi.IComponentType) donburi.Entity
  • func (ecs *ECS) CreateMany(l LayerID, n int, components ...donburi.IComponentType) []donburi.Entity
  • func (ecs *ECS) Draw(arg any)
  • func (ecs *ECS) DrawLayer(l LayerID, arg any)
  • func (ecs *ECS) IsPaused() bool
  • func (ecs *ECS) Pause()
  • func (ecs *ECS) Resume()
  • func (ecs *ECS) Update()
• type Layer
• type LayerID
• type RendererWithArg
• type System
• type Time
  • func NewTime() *Time
  • func (t *Time) DeltaTime() time.Duration
  • func (t *Time) Pause()
  • func (t *Time) Resume()
  • func (t *Time) SetSleep(d time.Duration)
  • func (t *Time) SetTimeScale(scale float64)
  • func (t *Time) TimeScale() float64
  • func (t *Time) Update()

Functions

func NewQuery

func NewQuery(l LayerID, f filter.LayoutFilter) *donburi.Query

NewQuery creates a new query.

Types

type Arg

type Arg interface{}

Arg is an argument of the renderer.

type ECS

type ECS struct {
	// World is the underlying world of the ECS.
	World donburi.World
	// Time manages the time of the world.
	Time *Time
	// contains filtered or unexported fields
}

ECS represents an entity-component-system.

func NewECS

func NewECS(w donburi.World) *ECS

NewECS creates a new ECS with the specified world.

func (*ECS) AddRenderer

func (ecs *ECS) AddRenderer(l LayerID, r any) *ECS

AddRenderer adds a renderer.

func (*ECS) AddSystem

func (ecs *ECS) AddSystem(s System) *ECS

AddSystem adds a system.

func (*ECS) Create

func (ecs *ECS) Create(l LayerID, components ...donburi.IComponentType) donburi.Entity

Create creates a new entity

func (*ECS) CreateMany

func (ecs *ECS) CreateMany(l LayerID, n int, components ...donburi.IComponentType) []donburi.Entity

Create creates a new entity

func (*ECS) Draw

func (ecs *ECS) Draw(arg any)

Draw executes all draw systems.

func (*ECS) DrawLayer

func (ecs *ECS) DrawLayer(l LayerID, arg any)

DrawLayer executes all draw systems of the specified layer.

func (*ECS) IsPaused

func (ecs *ECS) IsPaused() bool

IsPaused returns a boolean value indicating whether the world is paused.

func (*ECS) Pause

func (ecs *ECS) Pause()

Pause pauses the world.

func (*ECS) Resume

func (ecs *ECS) Resume()

Resume resumes the world.

func (*ECS) Update

func (ecs *ECS) Update()

Update runs systems

type Layer

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

type LayerID

type LayerID int

LayerID is used to specify a layer.

const LayerDefault LayerID = 0

LayerDefault is the default layer.

type RendererWithArg

type RendererWithArg[T Arg] func(ecs *ECS, arg *T)

DrawSystem is a system that draws the world.

type System

type System func(ecs *ECS)

UpdateSystem is a system that updates the world.

type Time

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

Time manages the time of the world.

func NewTime

func NewTime() *Time

NewTIme creates a new Time.

func (*Time) DeltaTime

func (t *Time) DeltaTime() time.Duration

DeltaTime returns the time between the last update and the current update.

func (*Time) Pause

func (t *Time) Pause()

Pause pauses the time.

func (*Time) Resume

func (t *Time) Resume()

Resume resumes the time.

func (*Time) SetSleep

func (t *Time) SetSleep(d time.Duration)

SetSleep sets the time to sleep.

func (*Time) SetTimeScale

func (t *Time) SetTimeScale(scale float64)

SetTimeScale sets the time scale.

func (*Time) TimeScale

func (t *Time) TimeScale() float64

TimeScale returns the time scale.

func (*Time) Update

func (t *Time) Update()

Update updates the time.