Back To Guides

Custom Special Equipment

This will add a custom Special Equipment (item pickups) to the game, using BeardLib's EquipmentsModule.

Shortcuts:

  • equipmentstweakdata.lua
  • hudiconstweakdata.lua

  • XML structure

    XML (Custom XML)
    <equipments> <special id="" icon="" text_id="" quantity="" max_quantity="" transfer_quantity="" avoid_tranfer=""/> </equipments>

    Put the hudicon tag inside your level tag in your main.xml file to make sure it's only loaded when playing your heist:

    XML (Custom XML)
    <level ...> <equipments> <special .../> </equipments> </level>

    Add addional special tags if you need more special equipments:

    XML (Custom XML)
    <equipments> <special .../> <special .../> <special .../> </equipments>

    If you add your special equipment using Beardlib's XML Module, the tags need to be written like this:

    XML (Custom XML)
    <Equipments> <special id="" icon="" text_id="" quantity="" max_quantity="" transfer_quantity="" avoid_tranfer=""/> </Equipments>

    id

    String

    The ID for your special equipment. Has to be unique.

    based_on

    String

    Will base your special equipment on a already existing one.
    All tags, parameters and values will carry over, but can be overwritten.

    Check the equipmentstweakdata.lua for specials IDs to use.

    text_id

    String

    The string ID for the name of your special equipment. Needs to be localized.
    Overkill usually uses something like hud_equipment_(your equipment id).

    Defaults to hud_equipment_(your id) if not specified.

    quantity

    Number

    Amount you get when optaining this equipment.

    If not specified, you get 1.

    max_quantity

    Number

    Maximum amount you can have of this equipment.

    transfer_quantity

    Number

    How many of this equipment get transfered to other players when disconnecting or going into custody.

    avoid_tranfer

    Boolean

    Set to true to not transfer equipment to other players when disconnecting or going into custody.
    *No, it's not a typo, it actually is misspelled in the tweakdata.