module

Documentation

Index

• type BasicModule
  • func NewBasicModule(name string) *BasicModule
  • func (mod *BasicModule) Init() error
  • func (mod *BasicModule) Logger() *log.ContextLogger
  • func (mod *BasicModule) Name() string
  • func (mod *BasicModule) Shutdown()
  • func (mod *BasicModule) Start()
  • func (mod *BasicModule) Update(now time.Time, dt time.Duration)
• type Manager
  • func NewManager() *Manager
  • func (m *Manager) Add(mod Module) Module
  • func (m *Manager) Find(t reflect.Type) Module
  • func (m *Manager) FindAll(t reflect.Type) []Module
  • func (m *Manager) Get(i int) Module
  • func (m *Manager) Init() error
  • func (m *Manager) Len() int
  • func (m *Manager) Shutdown()
  • func (m *Manager) Start()
  • func (m *Manager) Update(now time.Time, dt time.Duration)
• type Module

Types

type BasicModule

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

BasicModule implements the Module interface{}

func NewBasicModule

func NewBasicModule(name string) *BasicModule

NewBasicModule creates a BasicModule

func (*BasicModule) Init

func (mod *BasicModule) Init() error

Init implements Module Init method

func (*BasicModule) Logger

func (mod *BasicModule) Logger() *log.ContextLogger

Logger returns the Module logger

func (*BasicModule) Name

func (mod *BasicModule) Name() string

Name implements Module Name method

func (*BasicModule) Shutdown

func (mod *BasicModule) Shutdown()

Shutdown implements Module Shutdown method

func (*BasicModule) Start

func (mod *BasicModule) Start()

Start implements Module Start method

func (*BasicModule) Update

func (mod *BasicModule) Update(now time.Time, dt time.Duration)

Update implements Module Update method

type Manager

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

Manager used to manages a group of modules

func NewManager

func NewManager() *Manager

NewManager creates a Manager

func (*Manager) Add

func (m *Manager) Add(mod Module) Module

Add adds a module to the manager

func (*Manager) Find

func (m *Manager) Find(t reflect.Type) Module

Find finds the first added module from the manager by type

func (*Manager) FindAll

func (m *Manager) FindAll(t reflect.Type) []Module

FindAll finds all modules from the manager by type

func (*Manager) Get

func (m *Manager) Get(i int) Module

Get returns ith module

func (*Manager) Init

func (m *Manager) Init() error

Init initializes all modules

func (*Manager) Len

func (m *Manager) Len() int

Len returns the number of modules

func (*Manager) Shutdown

func (m *Manager) Shutdown()

Shutdown shutdowns all modules in reverse order

func (*Manager) Start

func (m *Manager) Start()

Start starts all modules

func (*Manager) Update

func (m *Manager) Update(now time.Time, dt time.Duration)

Update updates all modules

type Module

type Module interface {
	// Name returns the name of module
	Name() string
	// Init initializes the module
	Init() error
	// Start starts the module
	Start()
	// Shutdown shutdwons the module
	Shutdown()
	// Update updates the module per frame
	Update(time.Time, time.Duration)
}

Module represents a generic logic module