lemure

Documentation

Index

• type Engine
  • func (e *Engine) Run()
• type GameObject
  • func (g *GameObject) Update()
• type Scene
  • func (s *Scene) Update()

Types

type Engine

type Engine struct {
	CurrentScene *Scene                // current scene being displayed
	Config       *common.Configuration // the configurations for the engine
}

Engine is the type holding all Lemure Engine data and methods necessary to run

func (*Engine) Run

func (e *Engine) Run()

Run is responsible for running the game loop properly after setting all configurations

type GameObject

type GameObject struct {
	Name string // the name of the GO
}

GameObject holds data for an object inside the game

func (*GameObject) Update

func (g *GameObject) Update()

Update is responsible for updating the state of the GO. This should never be called by the user, it is exported so the Scene can use it

type Scene

type Scene struct {
	Name        string        // the name of the scene
	GameObjects []*GameObject // list of gameobjects in the scene
}

Scene holds all gameobjects of that scene and updates them correctly

func (*Scene) Update

func (s *Scene) Update()

Update is responsible for updating every updatable object inside it This should never be called by the user, it is exported so the Engine can call it