direction

Documentation

Index

• func AbbreviationToString(abbrev string) (str string, err error)
• func DirectionToAbbreviation(dir Direction) (str string, err error)
• func DirectionToString(d Direction) (str string, err error)
• func ExitsToFormattedString(exits string) (result string, err error)
• type Direction
  • func StringToDirection(s string) (dir Direction, err error)

Functions

func AbbreviationToString

func AbbreviationToString(abbrev string) (str string, err error)

turn an abbreviation like "n" into a string like "North"

func DirectionToAbbreviation

func DirectionToAbbreviation(dir Direction) (str string, err error)

take a value such as Direction.NORTH and turn it into an abbreviation such as "n" noinspection GoNameStartsWithPackageName

func DirectionToString

func DirectionToString(d Direction) (str string, err error)

noinspection GoNameStartsWithPackageName

func ExitsToFormattedString

func ExitsToFormattedString(exits string) (result string, err error)

Given an 'exits' string like "nsed", return a formatted string for the player with something like "North, South, East, Down"

Types

type Direction

type Direction int32

noinspection GoNameStartsWithPackageName

const (
	NONE  Direction = iota // 0
	NORTH                  // 1
	EAST                   // 2
	SOUTH                  // 3
	WEST                   // 4
	UP                     // 5
	DOWN                   // 6
)

func StringToDirection

func StringToDirection(s string) (dir Direction, err error)

take an abbreviation such as "n" and turn it into a direction int const like Direction.NORTH