obj.Equipment - originalfoo/Prison-Architect-API GitHub Wiki

Were you looking for Equipment (materials.txt setting)?

PA Bug 9969, PA Bug 10170

##Overview

This property is specific to Entity objects and indicates what type of equipment they have.

##Syntax

local equipped = someObj.Equipment -- string

someObj.Equipment = <number> -- PA Bug 9969

Values:

  • See "Notes" section below.

##Example

##Notes

In the game it seems that entities (such as Workman, Guard, etc) can be equipped with more than one item, yet the property only relates to a single item (PA Bug 10170).

The standard equipment available in the game includes:

0. 'None' - not carrying any equipment

  1. 'Fists'
  2. 'Baton' (the one the guards use)
  3. 'Club' (the improvised weapon)
  4. 'Shank'
  5. 'Knife'
  6. 'Fork'
  7. 'Gun' (revolver)
  8. 'Spoon'
  9. 'Needle'
  10. 'Medicine'
  11. 'Scissors'
  12. 'Booze'
  13. 'Poison'
  14. 'Cigs'
  15. 'Saw'
  16. 'JailKeys'
  17. 'MobilePhone'
  18. 'Lighter'
  19. 'Screwdriver'
  20. 'Drugs'
  21. 'Sheers'
  22. 'Mop'
  23. 'Rake'
  24. 'Hose' (does not turn people into firefighters)
  25. 'Spatula'
  26. 'WoodenSpoon'
  27. 'CleaningBrush'
  28. 'Hammer'
  29. 'Clipboard'
  30. 'Drill'
  31. 'PianoWire'
  32. 'Shotgun'
  33. 'Iron' (clothes iron)
  34. 'MoneyBag'
  35. 'DogLeash'
  36. 'DogBite' (what dogs use instead of fists)
  37. 'Tazer'
  38. 'GuardUniform' (not an actual uniform)
  39. 'PrisonerUniform' (not an actual uniform)
  40. 'StabVest' (not wearable)
  41. 'Torch' (flashlight)
  42. 'Rifle' (sniper)
  43. 'Axe'
  44. 'Spade' (shovel)
  45. 'AssaultRifle' (M16)
  46. 'SubMachineGun' (Mac10)
  47. 'WoodenPickAxe'
  48. 'BatteringRam'
  49. 'Megaphone'
  50. 'Book'
  51. 'BookClosed'
  52. 'CbRadio' (walkie-talkie)
  53. 'Magazine'
  54. 'Snack'
  55. 'Soap'
  56. 'Photo'

The numeric values may change if materials.txt is edited (it's not clear what will happen in this scenario). A value of 0 will remove any equipment (just remove, not drop) and a value of 57 or above seems to leave the entity with their arms out holding some imaginary invisible object. Setting an invalid value will cause the game crash.

##See Also

⚠️ **GitHub.com Fallback** ⚠️