Miscellaneous variables

Name

Miscellaneous config variables.

Synopsis

-- Default item carried by a knight
kts.DEFAULT_ITEM = <item-type>

-- Anim used by knights
kts.KNIGHT_ANIM = <anim>

-- Knight house colours (in-game)
kts.KNIGHT_HOUSE_COLOURS = {
    {0x664477, 0x553366, 0x442255},   -- purple
    {0x116622, 0x115522, 0x114422},   -- green
    -- etc.
}

-- Knight house colours (menu dropdown)
kts.KNIGHT_HOUSE_COLOURS_MENU = {
    0xaa55bb,    -- purple
    0x189933,    -- green
    -- etc.
}

-- Stuff bag graphic
kts.STUFF_BAG_GRAPHIC = <graphic>

-- Miscellaneous blood effects
kts.BLOOD_ICON = <graphic>
kts.BLOOD_TILES = {<tile>, <tile>, ...}
kts.DEAD_KNIGHT_TILES = {<tile>, <tile>, ...}

-- Controls
kts.CONTROLS = {<control>, <control>, ...}

Description

This page documents some miscellaneous variables that can be set directly in the kts table.

The following variables are available:

• kts.DEFAULT_ITEM is the ItemType of the default item carried by all knights (usually a sword).
• kts.KNIGHT_ANIM is the Anim used for knights. The artwork for this should use the colours defined for the first House (the first entry in the kts.KNIGHT_HOUSE_COLOURS list). If a player has selected a different House for their knight, then the knight graphics are automatically re-coloured by changing pixels of any colour that shows up in the first House's colour list to pixels of the corresponding colour from the other House.
• kts.KNIGHT_HOUSE_COLOURS defines the colours for the different Houses. For each i, kts.KNIGHT_HOUSE_COLOURS[i] is a list of colours for house number i (more specifically, it is a list of hex values representing RGB colours). All Houses should use the same number of colours; usually it is three colours per House. These entries are used for colouring the knight graphics, as described above.
  • The first House Colour for each House is also used as the colour of the small rectangle which represents a "secured home" in the game. As a special rule, if all three components of this colour are 0x40 or less, then the value of each component is doubled – this is to prevent homes secured by Black Knights being invisible, as they would be rendered as "black on black", effectively, otherwise.
• kts.KNIGHT_HOUSE_COLOURS_MENU is a list of RGB colours (one per house) to be used in the "House Colours" dropdown on the quest selection menu.
• kts.STUFF_BAG_GRAPHIC is a Graphic used to represent a "stuff bag" item (i.e. a pile of items dropped by a dead knight).
• kts.BLOOD_ICON is a graphic representing a small "blood splat" which will briefly appear when a knight is struck with a weapon.
• kts.BLOOD_TILES is a list of Tiles which are superimposed over the normal dungeon tiles whenever a "blood stain" is left on the dungeon floor. Each tile should (visually) contain a little more blood than the previous one.
• kts.DEAD_KNIGHT_TILES is a list of (at least) four Tiles which are superimposed over the normal dungeon tiles whenever a dead knight corpse is left on the dungeon floor. The different tiles can contain different variants of the "dead knight" graphic. The odd-numbered entries (first, third, etc. in the list) should contain blood splats and the even-numbered entries should not (the "non-blood" versions are used when a knight dies by poison).
• kts.CONTROLS is a list of in-game Controls that are always potentially available to any knight, i.e. they are not necessarily tied to the knight carrying a specific item or being near a specific tile. Examples could include the "pick up item" or "drop currently held item" controls.

Notes

These variables are read once, when the game boots up, and therefore cannot be modified mid-game, nor can they be modified in response to changes made by players when selecting a quest (any changes made at those times will be ignored).

Bugs

For some reason, in the default Knights data files, the "Drop Gem" control is defined in the kts.CONTROLS list, but it would probably make more sense to attach it to the i_gem item instead.

Examples

The default settings for these variables can be found in general_stuff.lua, or in controls.lua in the case of kts.CONTROLS.