gamedata

Documentation

Overview

Package gamedata provides Arknights gamedata lookup datastructures parsed from https://github.com/Kengxxiao/ArknightsGameData. The package will automatically query the ArknightsGameData github repository will update the local files if the files are different from the local files.

Index

• Variables
• type GameData
  • func New(region string, logger log.Logger) (*GameData, error)
  • func (d *GameData) GetItemInfo(region ...string) (*itemtable.ItemTable, error)
  • func (d *GameData) GetStageInfo(region ...string) (*stagetable.StageTable, error)

Variables

var (
	// ErrInvalidRegion is returned if the specified region is invalid.
	ErrInvalidRegion = errors.New("Invalid region")
)

var ErrPathOutOfBounds = fmt.Errorf("Path specified breaks out of data directory")

ErrPathOutOfBounds is returned when the fileName specified breaks out the directory.

Types

type GameData

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

GameData provides methods to get data structures that contain game related data.

func New

func New(region string, logger log.Logger) (*GameData, error)

New creates a new GameData struct, may return an error if an invalid region is provided. Refer to proxy.regionMap for valid region strings.

func (*GameData) GetItemInfo

func (d *GameData) GetItemInfo(region ...string) (*itemtable.ItemTable, error)

GetItemInfo provides a reference to the ItemTable struct which contains information about items. This call will block if the gamedata has not been loaded yet. Region is an optional argument, by default it will use the region associated with the GameData receiver.

func (*GameData) GetStageInfo

func (d *GameData) GetStageInfo(region ...string) (*stagetable.StageTable, error)

GetStageInfo provides a reference to the StageTable struct which contains information about game stages. This call will block if the gamedata has not been loaded yet. Region is an optional argument, by default it will use the region associated with the GameData receiver.