igloo

README

Igloo

Extension framework to ebiten

Very much in progress and not production ready

Examples

Coming soon, the go package docs is probably the easiest to read for now.

Documentation

Index

• func AddTicker(imp mathf.TickerImp)
• func Exit()
• func GetOutsideSize() (int, int)
• func GetScreenSize() (int, int)
• func GetWindowSize() (int, int)
• func Height() int
• func InitGame()
• func Pop()
• func Push(scene Scene)
• func Run() error
• func SetScreenSize(w, h int)
• func SetWindowSize(w, h int)
• func Width() int
• type ContentManager
  • func NewContentManager(fsys fs.FS, rootDir string) *ContentManager
  • func (cm *ContentManager) Dispose()
  • func (cm *ContentManager) LoadFontFace(font *sfnt.Font, options *opentype.FaceOptions) (font.Face, error)
  • func (cm *ContentManager) LoadImage(path string) (*ebiten.Image, error)
  • func (cm *ContentManager) LoadOpenType(path string) (*sfnt.Font, error)
• type Dirtier
• type Disposer
• type EventHandlerOne
• type EventHandlerTwo
• type EventHandlerZero
• type EventStoreOne
  • func (e *EventStoreOne[T]) Publish(value T)
  • func (e *EventStoreOne[T]) Subscribe(fn EventHandlerOne[T])
• type EventStoreTwo
  • func (e *EventStoreTwo[T0, T1]) Publish(t0 T0, t1 T1)
  • func (e *EventStoreTwo[T0, T1]) Subscribe(fn EventHandlerTwo[T0, T1])
• type EventStoreZero
  • func (e *EventStoreZero) Publish()
  • func (e *EventStoreZero) Subscribe(fn EventHandlerZero)
• type FSM
  • func NewFSM[T ~string](startingValue T, transitions ...FSMTransition[T]) *FSM[T]
  • func (fsm *FSM[T]) CanTransition(value T) bool
  • func (fsm *FSM[T]) Current() T
  • func (fsm *FSM[T]) Last() T
  • func (fsm *FSM[T]) OnTransition(state T, handler EventHandlerZero)
  • func (fsm *FSM[T]) Transition(value T) bool
• type FSMTransition
  • func NewFSMTransition[T ~string](from T, to ...T) FSMTransition[T]
• type Game
  • func (g *Game) Draw(dest *ebiten.Image)
  • func (g *Game) Layout(outsideWidth int, outsideHeight int) (int, int)
  • func (g *Game) Update() error
• type Scene
• type Updater

Functions

func AddTicker

func AddTicker(imp mathf.TickerImp)

func Exit

func Exit()

Exit the game at the end of the next update

func GetOutsideSize

func GetOutsideSize() (int, int)

func GetScreenSize

func GetScreenSize() (int, int)

func GetWindowSize

func GetWindowSize() (int, int)

func Height

func Height() int

func InitGame

func InitGame()

func Pop

func Pop()

Pop a scene off the stack

func Push

func Push(scene Scene)

Push a new scene to the top of the stack

func Run

func Run() error

func SetScreenSize

func SetScreenSize(w, h int)

func SetWindowSize

func SetWindowSize(w, h int)

func Width

func Width() int

Types

type ContentManager

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

ContentManager handles content loading, unloading, caching and sharing.

func NewContentManager

func NewContentManager(fsys fs.FS, rootDir string) *ContentManager

func (*ContentManager) Dispose

func (cm *ContentManager) Dispose()

func (*ContentManager) LoadFontFace

func (cm *ContentManager) LoadFontFace(
	font *sfnt.Font,
	options *opentype.FaceOptions,
) (font.Face, error)

LoadFontFace will load a font face from font and options. Note that no caching is done for this, so only load once per unique font and options.

func (*ContentManager) LoadImage

func (cm *ContentManager) LoadImage(path string) (*ebiten.Image, error)

func (*ContentManager) LoadOpenType

func (cm *ContentManager) LoadOpenType(path string) (*sfnt.Font, error)

type Dirtier

type Dirtier interface {
	// IsDirty returns whether or not our object is dirty
	IsDirty() bool
	// Clean the object back to a fresh state
	Clean()
}

Dirtier allows structs to track when they are changed and only apply complex changes when there is something new to update.

type Disposer

type Disposer interface {
	Dispose()
}

Disposer lets content be disposed of properly

type EventHandlerOne

type EventHandlerOne[T any] func(T)

EventHandlerOne handles events with one argument

type EventHandlerTwo

type EventHandlerTwo[T0, T1 any] func(T0, T1)

EventHandlerTwo handles events with two arguments

type EventHandlerZero

type EventHandlerZero func()

EventHandlerZero handles events with no arguments

type EventStoreOne

type EventStoreOne[T any] struct {
	// contains filtered or unexported fields
}

EventStoreOne contains all the events we are subscribed to with one argument

func (*EventStoreOne[T]) Publish

func (e *EventStoreOne[T]) Publish(value T)

Publish an event to all subscribers

func (*EventStoreOne[T]) Subscribe

func (e *EventStoreOne[T]) Subscribe(fn EventHandlerOne[T])

Subscribe to our event

type EventStoreTwo

type EventStoreTwo[T0, T1 any] struct {
	// contains filtered or unexported fields
}

EventStoreTwo contains all the events we are subscribed to with two arguments

func (*EventStoreTwo[T0, T1]) Publish

func (e *EventStoreTwo[T0, T1]) Publish(t0 T0, t1 T1)

Publish an event to all subscribers

func (*EventStoreTwo[T0, T1]) Subscribe

func (e *EventStoreTwo[T0, T1]) Subscribe(fn EventHandlerTwo[T0, T1])

Subscribe to our event

type EventStoreZero

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

EventStoreZero contains all the events we are subscribed to with no arguments

func (*EventStoreZero) Publish

func (e *EventStoreZero) Publish()

Publish an event to all subscribers

func (*EventStoreZero) Subscribe

func (e *EventStoreZero) Subscribe(fn EventHandlerZero)

Subscribe to our event

type FSM

type FSM[T ~string] struct {
	// contains filtered or unexported fields
}

FSM is a mini finite state machine

func NewFSM

func NewFSM[T ~string](startingValue T, transitions ...FSMTransition[T]) *FSM[T]

NewWatchable will create a watchable with a starting value

func (*FSM[T]) CanTransition

func (fsm *FSM[T]) CanTransition(value T) bool

func (*FSM[T]) Current

func (fsm *FSM[T]) Current() T

func (*FSM[T]) Last

func (fsm *FSM[T]) Last() T

func (*FSM[T]) OnTransition

func (fsm *FSM[T]) OnTransition(state T, handler EventHandlerZero)

func (*FSM[T]) Transition

func (fsm *FSM[T]) Transition(value T) bool

Transition to a new state will return true if we were able to transition, otherwise false

type FSMTransition

type FSMTransition[T ~string] struct {
	From T
	To   []T
}

func NewFSMTransition

func NewFSMTransition[T ~string](from T, to ...T) FSMTransition[T]

type Game

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

func (*Game) Draw

func (g *Game) Draw(dest *ebiten.Image)

Draw all the game scenes, bottom up

func (*Game) Layout

func (g *Game) Layout(outsideWidth int, outsideHeight int) (int, int)

func (*Game) Update

func (g *Game) Update() error

Update the top scene of the stack

type Scene

type Scene interface {
	Updater
	Disposer

	// Draw all game elements.
	Draw(screen *ebiten.Image)
}

Scene is a core component of logic and rendering. The core methods are update and draw to handle game logic and rendering.

type Updater

type Updater interface {
	Update(*mathf.GameTime)
}

Updater is the default updating method