locale

Documentation

Index

• Variables
• func ActiveFitsHeight() bool
• func ActiveFont() string
• func ActiveShape(s string) string
• func ActiveUsesArabicShaping() bool
• func ActiveUsesEbitenText() bool
• func Audit() error
• func CharSet(base string, baseWeight, maxCount int) []rune
• func Errorf(format string, args ...interface{})
• func InitCurrent()
• func ResetLanguage()
• type IType
• type Lingua
  • func LinguasSorted() []Lingua
  • func (l Lingua) Canonical() Lingua
  • func (l Lingua) Directory() string
  • func (l Lingua) GroupMembers() []Lingua
  • func (l Lingua) Name() string
  • func (l Lingua) SortKey() string
• type Type
• type VerticalTextPreference
  • func ActivePrefersVerticalText() VerticalTextPreference

Variables

var Linguas = map[Lingua]struct{}{}

Linguas is the set of current languages that are translated "enough".

Functions

func ActiveFitsHeight

func ActiveFitsHeight() bool

ActiveFitsHeight returns whether height auditing will be performed.

This is only accessible for the active locale so it can later be defined by the language file itself.

func ActiveFont

func ActiveFont() string

ActiveFont returns the font this locale uses.

This is only accessible for the active locale so it can later be defined by the language file itself.

func ActiveShape

func ActiveShape(s string) string

ActiveShape performs glyph shaping on a given string.

This is only accessible for the active locale so it can later be defined by the language file itself.

func ActiveUsesArabicShaping

func ActiveUsesArabicShaping() bool

ActiveUsesArabicShaping returns whether Arabic shaping will be performed.

This is only accessible for the active locale so it can later be defined by the language file itself.

func ActiveUsesEbitenText

func ActiveUsesEbitenText() bool

ActiveUsesEbitenText returns whether using ebiten/text for font drawing is safe.

This is only accessible for the active locale so it can later be defined by the language file itself.

func Audit

func Audit() error

func CharSet

func CharSet(base string, baseWeight, maxCount int) []rune

func Errorf

func Errorf(format string, args ...interface{})

func InitCurrent

func InitCurrent()

InitCurrent identifies the system locale. Requires Linguas to have been set.

func ResetLanguage

func ResetLanguage()

ResetLanguage makes everything English again.

Types

type IType

type IType = gotext.Translator

IType is the type of a locale translator interface.

var GI IType

GI is the translation of the game but as an interface. Used to work around go vet as it can't figure out that G.Get isn't a printf-like function if it gets only one arg. See https://github.com/golang/go/issues/57288

type Lingua

type Lingua string

Lingua identifies a language.

const Builtin Lingua = ""

Builtin is a reserved language name for the included language.

const UserProvided Lingua = "."

UserProvided is a reserved language name for language packs.

var Active Lingua

Active is the name of the current language.

var Current Lingua

Current returns the preferred system locale, intersected with available locales.

func LinguasSorted

func LinguasSorted() []Lingua

LinguasSorted returns the languages sorted by humanly expected ordering.

func (Lingua) Canonical

func (l Lingua) Canonical() Lingua

func (Lingua) Directory

func (l Lingua) Directory() string

Directory returns the directory containing the language.

func (Lingua) GroupMembers

func (l Lingua) GroupMembers() []Lingua

GroupMembers returns all additional members of a language group. Groups use the same file, but have {{if eq Lang ...}} template commands for minor differences.

func (Lingua) Name

func (l Lingua) Name() string

Name returns the human readable name of a language for the current font.

func (Lingua) SortKey

func (l Lingua) SortKey() string

type Type

type Type = *gotext.Po

Type is the type of a locale translator.

var G Type

G is the translation of the game.

var L Type

L is the translation of the levels.

type VerticalTextPreference

type VerticalTextPreference int

const (
	NeverPreferVerticalText VerticalTextPreference = iota
	DefaultPreferVerticalText
	AlwaysPreferVerticalText
)

func ActivePrefersVerticalText

func ActivePrefersVerticalText() VerticalTextPreference

ActivePrefersVerticalText returns whether this locale prefers vertical text.

This is only accessible for the active locale so it can later be defined by the language file itself.