equipment

package

v0.0.0-...-5b87e35 Latest Latest Go to latest Published: Dec 31, 2020 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/deichindianer/tq-item-setup

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Equipment
- func FromFile(path string) (*Equipment, error)
- func New(name, folderPath string) (*Equipment, error)
- func (e *Equipment) Flush() error
type Item
- func (i *Item) Validate() error
type Slot
- func SlotFromString(s string) (Slot, error)
- func (i Slot) String() string

Constants ¶

View Source

const (
	// I know this could be iota but this is way more readable :)
	UnknownSlot = -1
	Amulet      = 0
	Arm         = 1
	Head        = 2
	Leg         = 3
	RingLeft    = 4
	RingRight   = 5
	Torso       = 6
	WeaponLeft  = 7
	WeaponRight = 8
)

Constants for all the item slots. They can be converted to and from strings. UnknownSlot is treated as an invalid slot and used in error cases.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Equipment ¶

type Equipment struct {
	Name       string `yaml:"Name"`
	FolderPath string `yaml:"FolderPath"`
	TablePath  string `yaml:"TablePath"`
	Items      []Item `yaml:"Items"`
}

Equipment is an entire equipment of a Titan Quest char plus all metadata for filesystem storage

func FromFile ¶

func FromFile(path string) (*Equipment, error)

FromFile reads a given file path and builds an equipment struct from that.

func New ¶

func New(name, folderPath string) (*Equipment, error)

New creates the memory construct for the table bases

func (*Equipment) Flush ¶

func (e *Equipment) Flush() error

Flush creates the entire representation of the equipment in the filesystem.

type Item ¶

type Item struct {
	SlotIdentifier string `yaml:"SlotIdentifier"`
	BaseName       string `yaml:"BaseName"`
	BaseRecord     string `yaml:"BaseRecord"`
	PrefixName     string `yaml:"PrefixName"`
	PrefixRecord   string `yaml:"PrefixRecord"`
	SuffixName     string `yaml:"SuffixName"`
	SuffixRecord   string `yaml:"SuffixRecord"`
}

Item holds all references to item configuration. Also this is used to represent the config structure.

func (*Item) Validate ¶

func (i *Item) Validate() error

Validate validates an item. Currently this only checks if the slot identifier is valid.

type Slot ¶

type Slot int

Slot is the slot where the equipment goes, lol

func SlotFromString ¶

func SlotFromString(s string) (Slot, error)

SlotFromString converts a string representation of a slot into its constant value.

func (Slot) String ¶

func (i Slot) String() string

Source Files ¶

View all Source files

equipment.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL