keywords

package

v0.9.2-combat-as-module.5 Latest Latest Go to latest Published: Jun 25, 2025 License: GPL-3.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/GoMudEngine/GoMud

Links

Open Source Insights

Documentation ¶

Index ¶

func GetAllCommandAliases() map[string]string
func GetAllHelpAliases() map[string]string
func GetAllHelpTopics() []string
func GetAllLegendAliases(area ...string) map[rune]string
func LoadAliases(f ...fileloader.ReadableGroupFS)
func TryCommandAlias(input string) string
func TryDirectionAlias(input string) string
func TryHelpAlias(input string) string
type Aliases
type HelpTopic
- func GetAllHelpTopicInfo() []HelpTopic

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetAllCommandAliases ¶

func GetAllCommandAliases() map[string]string

func GetAllHelpAliases ¶

func GetAllHelpAliases() map[string]string

func GetAllHelpTopics ¶

func GetAllHelpTopics() []string

func GetAllLegendAliases ¶

func GetAllLegendAliases(area ...string) map[rune]string

func LoadAliases ¶

func LoadAliases(f ...fileloader.ReadableGroupFS)

Loads the ansi aliases from the config file Only if the file has been modified since the last load

func TryCommandAlias ¶

func TryCommandAlias(input string) string

func TryDirectionAlias ¶

func TryDirectionAlias(input string) string

func TryHelpAlias ¶

func TryHelpAlias(input string) string

Types ¶

type Aliases ¶

type Aliases struct {
	Help               map[string]map[string][]string `yaml:"help"`
	HelpAliases        map[string][]string            `yaml:"help-aliases"`
	CommandAliases     map[string][]string            `yaml:"command-aliases"`
	DirectionAliases   map[string]string              `yaml:"direction-aliases"`
	MapLegendOverrides map[string]map[string]string   `yaml:"legend-overrides"`
	// contains filtered or unexported fields
}

func (*Aliases) Filename ¶

func (a *Aliases) Filename() string

func (*Aliases) Filepath ¶

func (a *Aliases) Filepath() string

func (*Aliases) Validate ¶

func (a *Aliases) Validate() error

Presumably to ensure the datafile hasn't messed something up.

type HelpTopic ¶

type HelpTopic struct {
	Command   string
	Type      string // command/skill
	Category  string
	AdminOnly bool
}

func GetAllHelpTopicInfo ¶

func GetAllHelpTopicInfo() []HelpTopic

Source Files ¶

View all Source files

keywords.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL