ordering

package
v0.0.18 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2021 License: BSD-2-Clause Imports: 0 Imported by: 0

Documentation

Overview

Package ordering provides a list for ordering Attributes when they are marshaled.

There is no good reason for defining the attribute names as constants, other than the fact the groupings can be documented.

BUG(diddymus): This should really be under attr/ordering.go, however this causes the configuration loading to kick in when the init methods are run. This is not ideal for simple tools like wrjfmt :(

Index

Constants

View Source
const (
	Ref     = "Ref"
	Name    = "Name"
	Alias   = "Alias"
	Aliases = "Aliases"
)

Identification related attributes:

View Source
const (
	Author   = "Author"
	Disabled = "Disabled"
	Zone     = "Zone"
)

Zone related attributes (only used in zone header records):

View Source
const (
	Barrier   = "Barrier"
	Door      = "Door"
	Exit      = "Exit"
	Exits     = "Exits"
	Location  = "Location"
	Start     = "Start"
	ZoneLinks = "ZoneLinks"
)

Location related attributes:

View Source
const (
	Body      = "Body"
	Gender    = "Gender"
	Health    = "Health"
	Holding   = "Holding"
	Inv       = "Inv"
	Inventory = "Inventory"
	Wearing   = "Wearing"
	Wielding  = "Wielding"
)

Body related attributes:

View Source
const (
	Holdable  = "Holdable"
	Narrative = "Narrative"
	Veto      = "Veto"
	Vetoes    = "Vetoes"
	Wearable  = "Wearable"
	Wieldable = "Wieldable"
	Writing   = "Writing"
)

Attributes affecting how something is used:

View Source
const (
	Action    = "Action"
	Cleanup   = "Cleanup"
	OnAction  = "OnAction"
	OnCleanup = "OnCleanup"
	OnReset   = "OnReset"
	Reset     = "Reset"
)

Event related attributes

View Source
const (
	Description = "Description"
)

Description attribute when used as a named field and not an unnamed free text section:

Variables

Attributes defines the prefered sorting or for attributes when marshaled.

Functions

This section is empty.

Types

This section is empty.

Notes

Bugs

  • This should really be under attr/ordering.go, however this causes the configuration loading to kick in when the init methods are run. This is not ideal for simple tools like wrjfmt :(

Jump to

Keyboard shortcuts

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