menu

Documentation

Overview

Package menu is the graphical interface allowing to browse games, launch games, configure settings, and display a contextual menu to interract with the running game.

Index

• func Render(dt float32)
• func RenderNotifications()
• func Update(dt float32)
• type Menu
  • func Init(v *video.Video) *Menu
  • func (menu *Menu) ContextReset()
  • func (menu *Menu) WarpToQuickMenu()
• type Scene

Functions

func Render

func Render(dt float32)

Render takes care of rendering the menu

func RenderNotifications

func RenderNotifications()

RenderNotifications draws the list of notification messages on the viewport

func Update

func Update(dt float32)

Update takes care of calling the update method of the current scene. Each scene has it's own input logic to allow a variety of navigation systems.

Types

type Menu

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

Menu is a type holding the menu state, the stack of scenes, tweens, etc

func Init

func Init(v *video.Video) *Menu

Init initializes the menu. If a game is already running, it will warp the user to the quick menu. If not, it will display the menu tabs.

func (*Menu) ContextReset

func (menu *Menu) ContextReset()

ContextReset uploads the UI images to the GPU. It should be called after each time the window is recreated.

func (*Menu) WarpToQuickMenu

func (menu *Menu) WarpToQuickMenu()

WarpToQuickMenu loads the contextual menu for games that are launched from the command line interface or from 'Load Game'.

type Scene

type Scene interface {
	Entry() *entry
	// contains filtered or unexported methods
}

Scene represents a page of the UI A scene is typically an entry displaying its own children A segue is a smooth transition between two scenes.