stories

type Config ¶

type Config struct {
	// If zero, the story will resize
	Size geom.Size
	// If true, the viewer captures the screen immediately and uses that
	// instead of a live view.
	IsSnapshot bool
	// A list of inputs that will be executed in order when the story
	// begins.
	Input []interface{}
}

func (c *Config) HasInputs() bool

type InitFunc ¶

type InitFunc func(context.Context) (mux.Screen, error)

type MouseClickEvent ¶ added in v1.12.0

type MouseClickEvent struct {
	Button keys.MouseButton
}

MouseClickEvent clicks at the current mouse position.

func Click() MouseClickEvent

func RightClick() MouseClickEvent

type MouseDragEvent ¶ added in v1.12.0

type MouseDragEvent struct {
	geom.Vec2
}

MouseDragEvent moves the cursor to (R, C) while holding the left mouse button, triggering drag/selection behavior.

func Drag(r, c int) MouseDragEvent

type MouseMoveEvent ¶ added in v1.12.0

type MouseMoveEvent struct {
	geom.Vec2
}

MouseMoveEvent tells the story runner to smoothly interpolate the cursor from its current position to (R, C).

func MouseMove(r, c int) MouseMoveEvent

type MouseScrollEvent ¶ added in v1.12.0

type MouseScrollEvent struct {
	Up bool
}

MouseScrollEvent scrolls at the current mouse position.

func Scroll(up bool) MouseScrollEvent

type Story ¶

type Story struct {
	Name   string
	Init   InitFunc
	Config Config
}

type WaitEvent ¶ added in v0.1.10

type WaitEvent struct {
	Duration time.Duration
}

func Wait(duration time.Duration) WaitEvent