notifications

Documentation

Overview

Package notifications exposes functions to display messages in toast widgets.

Index

• Constants
• func Clear()
• func Display(severity Severity, message string, duration float32) xid.ID
• func DisplayAndLog(severity Severity, prefix, message string, vars ...interface{}) xid.ID
• func Process(dt float32)
• func Update(id xid.ID, severity Severity, message string)
• type Notification
  • func List() []Notification
• type Severity

Constants

const Medium float32 = 4

Medium is the standard duration for a notification

Functions

func Clear

func Clear()

Clear empties the notification list

func Display

func Display(severity Severity, message string, duration float32) xid.ID

Display creates a new notification.

func DisplayAndLog

func DisplayAndLog(severity Severity, prefix, message string, vars ...interface{}) xid.ID

DisplayAndLog creates a new notification and also logs the message to stdout.

func Process

func Process(dt float32)

Process iterates over the notifications, update them, delete the old ones.

func Update

func Update(id xid.ID, severity Severity, message string)

Update the message of a given notification. Also resets the delay before disapearing.

Types

type Notification

type Notification struct {
	ID       xid.ID
	Severity Severity
	Message  string
	Duration float32
}

Notification is a message that will be displayed on the screen during a certain time.

func List

func List() []Notification

List lists the current notifications.

type Severity

type Severity uint8

Severity represents the severity of a notification message. It will affect the color of the notification text in the UI.

const (
	// Info is for informative message, when everything is fine
	Info Severity = iota
	// Success is for successful actions
	Success
	// Warning is also for informative messages, when something is not right
	// for example, if a menu entry has not been implemented.
	Warning
	// Error is for failed actions. For example, trying to load a game that
	// doesn't exists.
	Error
)