goldsrc

Documentation

Index

• Constants
• func IsValidTextureName(str string) bool
• func NewTitlesFromModRoot(mod *os.Root) (map[string]Title, error)
• func NewTitlesFromReader(r io.Reader) (map[string]Title, error)
• type MaterialType
  • func (t MaterialType) String() string
• type Materials
  • func LoadMaterials(r io.Reader) (Materials, error)
  • func LoadMaterialsFromFile(path string) (Materials, error)
  • func (m Materials) IsEmpty() bool
• type MaterialsRemapper
  • func NewMaterialsRemapper(source Materials) MaterialsRemapper
  • func (r *MaterialsRemapper) PrintAvailable(w io.Writer)
  • func (r *MaterialsRemapper) ReMap(stderr io.Writer, from []wad.MIPTexture, replacements Materials) (map[wad.TextureName]wad.TextureName, error)
• type ParseError
  • func (e ParseError) Error() string
• type Title
• type TitleEffect

Constants

const MaterialTypeCount = 9 + 1

Functions

func IsValidTextureName

func IsValidTextureName(str string) bool

func NewTitlesFromModRoot

func NewTitlesFromModRoot(mod *os.Root) (map[string]Title, error)

func NewTitlesFromReader

func NewTitlesFromReader(r io.Reader) (map[string]Title, error)

Types

type MaterialType

type MaterialType rune

const (
	MaterialTypeInvalid MaterialType = 0

	MaterialTypeComputer MaterialType = 'P'
	MaterialTypeDirt     MaterialType = 'D'
	MaterialTypeGlass    MaterialType = 'Y'
	MaterialTypeGrate    MaterialType = 'G'
	MaterialTypeLiquid   MaterialType = 'S' // "slosh"
	MaterialTypeMetal    MaterialType = 'M'
	MaterialTypeTile     MaterialType = 'T'
	MaterialTypeVents    MaterialType = 'V'
	MaterialTypeWood     MaterialType = 'W'
)

func (MaterialType) String

func (t MaterialType) String() string

type Materials

type Materials map[string]MaterialType // texture name => material type

materials.txt parser.

func LoadMaterials

func LoadMaterials(r io.Reader) (Materials, error)

func LoadMaterialsFromFile

func LoadMaterialsFromFile(path string) (Materials, error)

func (Materials) IsEmpty

func (m Materials) IsEmpty() bool

type MaterialsRemapper

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

func NewMaterialsRemapper

func NewMaterialsRemapper(source Materials) MaterialsRemapper

func (*MaterialsRemapper) PrintAvailable

func (r *MaterialsRemapper) PrintAvailable(w io.Writer)

func (*MaterialsRemapper) ReMap

func (r *MaterialsRemapper) ReMap(
	stderr io.Writer,
	from []wad.MIPTexture,
	replacements Materials,
) (map[wad.TextureName]wad.TextureName, error)

type ParseError

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

func (ParseError) Error

func (e ParseError) Error() string

type Title

type Title struct {
	Name    string
	Message string

	// I won't bother parsing position/colors for now. Don't need them.
	Position       string      // $position "0.0 0.0"
	Effect         TitleEffect // $effect 0/1/2
	TextColor      string      // $color "255 255 255"
	HighlightColor string      // $color2 "255 255 255"
	FadeIn         float32     // $fadein
	FadeOut        float32     // $fadeout
	FXTime         float32     // $fxtime
	HoldTime       float32     // $holdtime
}

A single entry from titles.txt.

type TitleEffect

type TitleEffect int

const (
	TitleEffectFade TitleEffect = iota
	TitleEffectFlicker
	TitleEffectTypewriter
)