gamer

README

gamer

Provides Discord Activity generators, as well as a shuffling Queue, for Snart.

Documentation

Overview

Package gamer provides Activity generators.

Index

• type Gamer
  • func Static(a discord.Activity) Gamer
  • func Uptime() Gamer
• type Queue
  • func (q Queue) Cycle(u StatusUpdater, dur time.Duration)
  • func (q Queue) Random() discord.Activity
  • func (q Queue) Select(i int) discord.Activity
• type StatusUpdater

Types

type Gamer

type Gamer = func() discord.Activity

Gamer is a closure that generates an Activity.

func Static

func Static(a discord.Activity) Gamer

Static makes a Gamer that just returns the given Activity.

func Uptime

func Uptime() Gamer

Uptime makes a Gamer that shows the duration since its creation.

type Queue

type Queue []Gamer

Queue provides a pseudo-random less-recently-used queue of Gamers.

func (Queue) Cycle

func (q Queue) Cycle(u StatusUpdater, dur time.Duration)

Cycle continually calls UpdateStatus using Random, on an interval.

You'll probably want to pass a Gateway for u. 12 seconds seems to be a good minimum interval.

func (Queue) Random

func (q Queue) Random() discord.Activity

Random calls Select on a pseudo-random index in [0, (len(q) + 1) / 2).

func (Queue) Select

func (q Queue) Select(i int) discord.Activity

Select calls the Gamer at position i in the Queue, updating the order accordingly.

type StatusUpdater

type StatusUpdater interface {
	UpdateStatus(gateway.UpdateStatusData) error
}

StatusUpdater updates status. A Gateway implements this.