world

Documentation

Overview

Package world allows to create an use our ECS World

Index

• type Listener
• type System
• type World
  • func New() *World
  • func (wld *World) AddSystem(sys System)
  • func (wld *World) AddSystemWithPriority(sys System, priority int32)
  • func (wld *World) Clear()
  • func (wld *World) Listen(lis Listener)
  • func (wld *World) ListenWithPriority(lis Listener, priority int32)
  • func (wld *World) Signal(event interface{}) error
  • func (wld World) String() string
  • func (wld *World) Update(delta float32) error

Types

type Listener

type Listener func(wld *World, signal interface{}, delta float32) error

Listener the get notified that a new signal has been received by World.Signal

type System

type System func(wld *World, delta float32) error

System get invoke with Update() from a World

type World

type World struct {
	*view.View
	// contains filtered or unexported fields
}

World is a view.View that contains the entity.Entity and System of our ECS

func New

func New() *World

New creates a new World

func (*World) AddSystem

func (wld *World) AddSystem(sys System)

AddSystem adds the given System to the world

func (*World) AddSystemWithPriority

func (wld *World) AddSystemWithPriority(sys System, priority int32)

AddSystemWithPriority adds the given System to the world

func (*World) Clear

func (wld *World) Clear()

Clear removes all world.System and entity.Entity from the world.World

func (*World) Listen

func (wld *World) Listen(lis Listener)

Listen adds the given System to the world

func (*World) ListenWithPriority

func (wld *World) ListenWithPriority(lis Listener, priority int32)

ListenWithPriority adds the given System to the world

func (*World) Signal

func (wld *World) Signal(event interface{}) error

Signal signal an event to be sent

func (World) String

func (wld World) String() string

String get a string representation of our World

func (*World) Update

func (wld *World) Update(delta float32) error

Update ask to update the System send the pending events