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 ¶
const ( Ref = "Ref" Name = "Name" Alias = "Alias" Aliases = "Aliases" )
Identification related attributes:
const ( Author = "Author" Disabled = "Disabled" Zone = "Zone" )
Zone related attributes (only used in zone header records):
const ( Barrier = "Barrier" Door = "Door" Exit = "Exit" Exits = "Exits" Location = "Location" Start = "Start" ZoneLinks = "ZoneLinks" )
Location related attributes:
const ( Body = "Body" Gender = "Gender" Health = "Health" Holding = "Holding" Inv = "Inv" Inventory = "Inventory" Wearing = "Wearing" Wielding = "Wielding" )
Body related attributes:
const ( Holdable = "Holdable" Narrative = "Narrative" Veto = "Veto" Vetoes = "Vetoes" Wearable = "Wearable" Wieldable = "Wieldable" Writing = "Writing" )
Attributes affecting how something is used:
const ( Action = "Action" Cleanup = "Cleanup" OnAction = "OnAction" OnCleanup = "OnCleanup" OnReset = "OnReset" Reset = "Reset" )
Event related attributes
const (
Description = "Description"
)
Description attribute when used as a named field and not an unnamed free text section:
Variables ¶
var Attributes = []string{ Ref, Zone, Author, Disabled, Name, Alias, Aliases, Start, Exit, Exits, ZoneLinks, Barrier, Door, Location, Description, Body, Gender, Health, Inv, Inventory, Holding, Wearing, Wielding, Narrative, Holdable, Wearable, Wieldable, Writing, Veto, Vetoes, Action, OnAction, Cleanup, OnCleanup, Reset, OnReset, }
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 :(