fsm

README

fsm

Originally from https://github.com/SolarLune/gofsm

Documentation

Index

• type FSM
  • func NewFSM() *FSM
  • func (f *FSM) Change(stateName string)
  • func (f *FSM) HasState(name string) bool
  • func (f *FSM) Register(name string, state State)
  • func (f *FSM) Unregister(name string)
  • func (f *FSM) Update()
• type State

Types

type FSM

type FSM struct {
	State          string
	StateDirectory map[string]State
	ErrorHandler   func(*FSM, error)
}

FSM represents a Finite State Machine, which can have one State active at a time.

func NewFSM

func NewFSM() *FSM

NewFSM creates a new FSM and returns it.

func (*FSM) Change

func (f *FSM) Change(stateName string)

Change allows you to change the current, "main" State assigned to the FSM. If you run Change(), it will call Exit() on the previous State and Enter() on the next State.

func (*FSM) HasState

func (f *FSM) HasState(name string) bool

HasState returns if the FSM has a State associated with the name in its directory.

func (*FSM) Register

func (f *FSM) Register(name string, state State)

Register registers a State with its name.

func (*FSM) Unregister

func (f *FSM) Unregister(name string)

Unregister removes a State from the FSM using its name.

func (*FSM) Update

func (f *FSM) Update()

Update runs the Update() on the active State.

type State

type State struct {
	Enter  func() error
	Update func() error
	Exit   func() error
}

State is a basic struct that implements the State interface.