common

Documentation

Overview

Package common provides shared interfaces / structures between Kaori's Modules

Index

• type Cleaner
• type Drawer
• type EventHandler
• type GameObject
• type Updater

Types

type Cleaner

type Cleaner interface {
	Clean()
}

Cleaner provides a function which will be used when a game is closing. This function should be used for freeing SDL's objects and/or cleaning resources

type Drawer

type Drawer interface {
	Draw(*sdl.Renderer)
}

Drawer provides a Draw function which will be used when a game draw event happens. This function also provides access to the game's renderer

type EventHandler

type EventHandler interface {
	HandleEvents(sdl.Event)
}

EventHandler provides a function which will be used when a certain SDL Event is received

type GameObject

type GameObject interface {
	Updater
	Drawer
	Cleaner
}

GameObject provides the functions which are needed for a game object.

type Updater

type Updater interface {
	Update()
}

Updater provides a function which will be used when a game update event happens