root

Documentation

Index

• func CheckLuaErrors(zones *zone.Manager, s *game.Session) tea.Cmd
• func GettingVisible() tea.Cmd
• func Push(model tea.Model) tea.Cmd
• func PushAll(models ...tea.Model) tea.Cmd
• func PushTransitionFunc(fn func(parent tea.Model) tea.Model) tea.Cmd
• func RemovePushTransitionFunc() tea.Cmd
• func TooltipClear() tea.Cmd
• func TooltipCreate(tip Tooltip) tea.Cmd
• func TooltipDelete(id string) tea.Cmd
• type Model
  • func New(zones *zone.Manager, root tea.Model) Model
  • func (m Model) Init() tea.Cmd
  • func (m Model) PushModel(model tea.Model) Model
  • func (m Model) SetRoot(model tea.Model) Model
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string
• type ModelGettingVisibleMsg
• type OnVisibleModel
  • func NewOnVisibleModel(parent tea.Model, fn func(model tea.Model)) OnVisibleModel
  • func (m OnVisibleModel) Init() tea.Cmd
  • func (m OnVisibleModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m OnVisibleModel) View() string
• type PushModelMsg
• type PushTransitionFuncMsg
• type Tooltip
• type TooltipClearMsg
• type TooltipDeleteMsg
• type TooltipMsg

Functions

func CheckLuaErrors

func CheckLuaErrors(zones *zone.Manager, s *game.Session) tea.Cmd

CheckLuaErrors checks if there are any lua errors and pushes them to the stack as lua error model.

func GettingVisible

func GettingVisible() tea.Cmd

GettingVisible is a message that is sent to a model when it is getting visible.

func Push

func Push(model tea.Model) tea.Cmd

Push pushes a new model on the root stack.

func PushAll

func PushAll(models ...tea.Model) tea.Cmd

PushAll pushes multiple models on the root stack.

func PushTransitionFunc

func PushTransitionFunc(fn func(parent tea.Model) tea.Model) tea.Cmd

PushTransitionFunc pushes a new transition model on the root ui that will be shown between models on the stack.

func RemovePushTransitionFunc

func RemovePushTransitionFunc() tea.Cmd

RemovePushTransitionFunc removes the transition model from the root ui.

func TooltipClear

func TooltipClear() tea.Cmd

TooltipClear clears all tooltips.

func TooltipCreate

func TooltipCreate(tip Tooltip) tea.Cmd

TooltipCreate creates a new tooltip.

func TooltipDelete

func TooltipDelete(id string) tea.Cmd

TooltipDelete deletes a tooltip.

Types

type Model

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

Model is the root model of the game. It holds the current model stack and the zone manager. The top model of the internal stack is the current model and will be rendered.

func New

func New(zones *zone.Manager, root tea.Model) Model

New creates a new root model.

func (Model) Init

func (m Model) Init() tea.Cmd

func (Model) PushModel

func (m Model) PushModel(model tea.Model) Model

PushModel pushes a new model on the stack.

func (Model) SetRoot

func (m Model) SetRoot(model tea.Model) Model

SetRoot sets the root (last) model of the stack.

func (Model) Update

func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (Model) View

func (m Model) View() string

type ModelGettingVisibleMsg

type ModelGettingVisibleMsg struct{}

type OnVisibleModel

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

func NewOnVisibleModel

func NewOnVisibleModel(parent tea.Model, fn func(model tea.Model)) OnVisibleModel

func (OnVisibleModel) Init

func (m OnVisibleModel) Init() tea.Cmd

func (OnVisibleModel) Update

func (m OnVisibleModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (OnVisibleModel) View

func (m OnVisibleModel) View() string

type PushModelMsg

type PushModelMsg []tea.Model

type PushTransitionFuncMsg

type PushTransitionFuncMsg func(parent tea.Model) tea.Model

type Tooltip

type Tooltip struct {
	ID      string
	Content string
	X       int
	Y       int
}

Tooltip represents a tooltip aka overlay message that should be displayed.

type TooltipClearMsg

type TooltipClearMsg struct{}

type TooltipDeleteMsg

type TooltipDeleteMsg string

type TooltipMsg

type TooltipMsg Tooltip