Skip to content

Armor proxy (self.armor)

Bound on script tables as self.armor. Only these members are available; unknown names are rejected.

Source: Utils/Lua/LuaArmorApi.cs.

Properties

Name Lua type Access Notes
Category string or nil Read-only Authored category string, or nil when unavailable.
DamageReductionFlat number Read/write Flat physical damage reduction in damage points. Changed values on worn armor refresh cached player stats on the next equipment update. Reads 0 and ignores writes when the armor is absent.
DamageReductionPercent number Read/write Physical damage reduction in percentage points: 10 means 10 percent. Changed values on worn armor refresh cached player stats on the next equipment update. Reads 0 and ignores writes when the armor is absent.
Description string or nil Read-only Description text, or nil when unavailable.
DrawSkinUnder boolean Read/write Whether skin is drawn underneath the armor. Reads false and ignores writes when the armor is absent.
Encumbrance number Read/write Armor encumbrance contribution. Changed values on worn armor refresh cached player stats on the next equipment update. Reads 0 and ignores writes when the armor is absent.
EquipSlot string or nil Read-only Equipment-slot name as a string, or nil when the armor is absent.
HasWornSprites boolean Read-only Whether the armor has worn sprites. Reads false when the armor is absent.
HidesFacialHair boolean Read/write Whether worn armor hides facial hair. Reads false and ignores writes when the armor is absent.
HidesHair boolean Read/write Whether worn armor hides hair. Reads false and ignores writes when the armor is absent.
IsInSet boolean Read-only Whether the armor belongs to a set. Reads false when the armor is absent.
ItemTypeIDString string or nil Read-only Item type identity string, or nil when unavailable.
Name string or nil Read-only Display name, or nil when unavailable.
SetString string or nil Read-only Authored armor-set identifier, or nil when unavailable.
UniqueIdentifier string or nil Read-only Armor identity string, or nil when unavailable.
CLR declaration reference

These names identify the backing engine source declarations.

  • String Category
  • float DamageReductionFlat
  • float DamageReductionPercent
  • String Description
  • Boolean DrawSkinUnder
  • float Encumbrance
  • String EquipSlot
  • Boolean HasWornSprites
  • Boolean HidesFacialHair
  • Boolean HidesHair
  • Boolean IsInSet
  • String ItemTypeIDString
  • String Name
  • String SetString
  • String UniqueIdentifier

Generated 2026-10-02T21:05:27.5090099Z · b8c9ae78 · 15 members.

Official modding overview · Signs of Life on Steam