encumbrance

Documentation

Index

• Variables
• type Level
  • func ExtractLevel(str string) Level
  • func (enum Level) EnsureValid() Level
  • func (enum Level) Key() string
  • func (enum Level) MarshalText() (text []byte, err error)
  • func (enum Level) Penalty() fxp.Int
  • func (enum Level) String() string
  • func (enum *Level) UnmarshalText(text []byte) error
  • func (enum Level) WeightMultiplier() fxp.Int

Variables

var Levels = []Level{
	No,
	Light,
	Medium,
	Heavy,
	ExtraHeavy,
}

Levels holds all possible values.

Types

type Level

type Level byte

Level holds the encumbrance level.

const (
	No Level = iota
	Light
	Medium
	Heavy
	ExtraHeavy
)

Possible values.

const LastLevel Level = ExtraHeavy

LastLevel is the last valid value.

func ExtractLevel

func ExtractLevel(str string) Level

ExtractLevel extracts the value from a string.

func (Level) EnsureValid

func (enum Level) EnsureValid() Level

EnsureValid ensures this is of a known value.

func (Level) Key

func (enum Level) Key() string

Key returns the key used in serialization.

func (Level) MarshalText

func (enum Level) MarshalText() (text []byte, err error)

MarshalText implements the encoding.TextMarshaler interface.

func (Level) Penalty

func (enum Level) Penalty() fxp.Int

Penalty returns the penalty associated with the encumbrance level.

func (Level) String

func (enum Level) String() string

String implements fmt.Stringer.

func (*Level) UnmarshalText

func (enum *Level) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

func (Level) WeightMultiplier

func (enum Level) WeightMultiplier() fxp.Int

WeightMultiplier returns the weight multiplier associated with the encumbrance level.