vptypes

Documentation

Overview

Package vptypes contains some general purpose basic types.

Index

• Constants
• type Size
  • func (s *Size) MarshalJSON() ([]byte, error)
  • func (s *Size) String() string
  • func (s *Size) UnmarshalJSON(data []byte) error

Constants

const PackageCopyright = "Copyright (C)  2015, 2016  Christian Mauduit <ufoot@ufoot.org>" // PackageCopyright set by version.sh

PackageCopyright contains a short copyright notice.

const PackageEmail = "ufoot@ufoot.org" // PackageEmail set by version.sh

PackageEmail contains a contact email for the package.

const PackageLicense = "GNU GPL v3" // PackageLicense set by version.sh

PackageLicense contains a short license information.

const PackageName = "Vapor Toolkit" // PackageName set by version.sh

PackageName contains a readable name of the package, suitable for display.

const PackageTarname = "vapor" // PackageTarname set by version.sh

PackageTarname contains a short name of the package, suitable for a filename.

const PackageURL = "https://github.com/ufoot/vapor" // PackageURL set by version.sh

PackageURL contains the address of the project homepage.

const VersionMajor = 0 // VersionMajor set by version.sh

VersionMajor is the project major version.

const VersionMinor = 3 // VersionMinor set by version.sh

VersionMinor is the project minor version.

const VersionStamp = "c6a4298" // VersionStamp set by version.sh

VersionStamp is the project stamp, possibly changes for each build.

Types

type Size

type Size int

Size is a generic type to store small/medium/large values. Typically used for game settings.

const (
	// SizeSmall represent an abritrary "small" value.
	SizeSmall Size = iota
	// SizeMedium represent an abritrary "medium" value.
	SizeMedium
	// SizeLarge represent an abritrary "large" value.
	SizeLarge
	// SizeRange is the number of available sizes.
	SizeRange
)

func (*Size) MarshalJSON

func (s *Size) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*Size) String

func (s *Size) String() string

String returns a readable form of the Size.

func (*Size) UnmarshalJSON

func (s *Size) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.