mouse

Documentation

Overview

Package mouse handles all mouse-oriented interactions.

Index

• Variables
• func FuncOverRange(mp *m.Map, start, end int, f func(*m.Map, int, int))
• func MouseIdx() int
• func TileRange(start, end int) (int, int, int, int)
• type Mode
  • func (m Mode) String() string
• type System
  • func NewSystem() *System
  • func (s *System) Handle(mp *m.Map, rs *room.Service, dwarves *[]*dwarf.Dwarf) string

Variables

var ModeFromString = map[string]Mode{
	"Normal":    Normal,
	"Storage":   Storage,
	"SleepHall": SleepHall,
	"Farm":      Farm,
	"Brewery":   Brewery,
	"Bar":       Bar,
	"Library":   Library,
	"Delete":    Delete,
}

Functions

func FuncOverRange

func FuncOverRange(mp *m.Map, start, end int, f func(*m.Map, int, int))

FuncOverRange runs over a map between the start and end points against the supplied function.

func MouseIdx

func MouseIdx() int

func TileRange

func TileRange(start, end int) (int, int, int, int)

TileRange returns a two-dimensional range between start and end, regardless of direction.

Types

type Mode

type Mode int

Mode enum for managing mouse action state.

const (
	Normal Mode = iota
	Storage
	SleepHall
	Farm
	Brewery
	Bar
	Library
	Delete
)

Mode enum.

func (Mode) String

func (m Mode) String() string

type System

type System struct {
	Mode Mode
	// contains filtered or unexported fields
}

System for handling all functionality by mouse.

func NewSystem

func NewSystem() *System

func (*System) Handle

func (s *System) Handle(mp *m.Map, rs *room.Service, dwarves *[]*dwarf.Dwarf) string

Handle all the mouse interactivity.