Skip to content

Reference

tilttek/heraldry
TypeRole
CoatA coat of arms: field, ordinary, charges and mark of difference, checked together
FieldA plain field, or a field divided between two tinctures
PartitionHow a field is divided: per pale, per fess, per bend, per bend sinister, quarterly, per saltire
TinctureThe metals, colours and furs, with their kind and their contrast
TinctureKindMetal, Colour or Fur
OrdinaryThe honourable ordinaries, with the charges each carries and surrounds
PieceAn ordinary in its tincture
ChargeThe charges: mullet, crescent, roundel, annulet, lozenge, mascle, billet, fleur-de-lis
ChargeGroupOne to three charges of a kind and a tincture, on the field or on the ordinary
ArrangementUsual, InFess or InPale
BrisureA mark of difference in its tincture
BrisureMarkLabel or Bendlet
ShieldShapeHeater, French, Iberian or Lozenge
LanguageEnglish or French
TinctureRuleThe rule of tincture, checked on a coat
ViolationWhere a coat breaks the rule, in a sentence
Generator\CoatGeneratorArms drawn from a seed, keeping the rule
Generator\SeedThe 32 bytes arms are drawn from, written in hexadecimal
Blazon\BlazonryThe blazon in the language asked for
Blazon\EnglishBlazonThe blazon in English
Blazon\FrenchBlazonThe blazon in French
Contract\BlazonWriterA writer of blazons
Svg\SvgRendererThe accessible SVG image of a coat
Svg\PaletteThe colours of the tinctures and outlines
Exception\HeraldryExceptionThe interface of every exception of the library
Exception\InvalidCoatA coat the model cannot hold
Exception\InvalidSeedA seed that is not 64 hexadecimal digits
Exception\InvalidPaletteA palette the renderer refuses
Exception\InvalidDrawingA prefix of ids the renderer refuses

Svg\Shapes is internal: the paths and the places of the drawing.