help

Documentation

Index

• type Help
  • func ReadHelp(lbxFile *lbx.LbxFile, entry int) (Help, error)
  • func (help *Help) GetEntries(entry int) []HelpEntry
  • func (help *Help) GetEntriesByName(name string) []HelpEntry
  • func (help *Help) GetRawEntry(entry int) HelpEntry
• type HelpEntry

Types

type Help

type Help struct {
	Entries []HelpEntry
	// contains filtered or unexported fields
}

func ReadHelp

func ReadHelp(lbxFile *lbx.LbxFile, entry int) (Help, error)

func (*Help) GetEntries

func (help *Help) GetEntries(entry int) []HelpEntry

func (*Help) GetEntriesByName

func (help *Help) GetEntriesByName(name string) []HelpEntry

func (*Help) GetRawEntry

func (help *Help) GetRawEntry(entry int) HelpEntry

type HelpEntry

type HelpEntry struct {
	// shows up on top of scroll
	Headline string
	// lbx file to pull an icon out, shown at top left of scroll
	Lbx string
	// index of sprite in the lbx file
	LbxIndex int
	// extra text to append
	AppendHelpIndex int
	// text displayed in scroll
	Text string
}

stuff from help.lbx