BeardLib
  • Home
  • Things to Know
    • Adding Files
    • ScriptData
  • Modules
    • Achievements
    • Add Files
    • Adding your own modules
    • AssetUpdates (Mod Updates)
    • Classes
    • Contact (contractors)
    • Crime Spree Mission
    • DLC
    • Dependencies
    • Elements
    • Global Value (Tagging weapons/etc)
    • Heist Music
      • Stealth Music
    • Hooks
    • Interactions
    • Keybind
    • Level
    • Localization
    • Mask Material
    • Mask Pattern
    • Mask
    • Melee
    • Menu Music
    • Menu
    • ModuleBase
    • Narrative
    • Options
    • Package
    • Script Mods (Replace script data)
    • Sounds
    • Tweak Modify
    • Weapon Mod
    • Weapon Skin
    • Weapon
    • XML
  • API
    • BeardLib Class
    • Constants
    • File Manager
    • Frameworks
    • Hooks
    • ModCore
    • Package Manager
    • Special Hook IDs
  • Utilities
    • FileIO
    • Input
    • Main
    • Math
    • Menu Helper Plus
    • Path
    • String
    • Sync
    • Table
    • Tweak Data Helper
    • XML
    • YAML
  • MenuUI
    • ComboBox
    • ImageButton
    • Item
    • Items
    • Keybind
    • Menus
    • Slider
    • TextBox
    • Toggle
Powered by GitBook
On this page
  • Module Definition
  • Module name
  • XML Structure
  • Example

Was this helpful?

Edit on GitHub
  1. Modules

Mask

PreviousMask PatternNextMelee

Last updated 3 years ago

Was this helpful?

Updated for version 3.38.

Module Definition

The module is inherited from . So base parameters can be found there.

This modules let's you add masks.

Module name

The name of the module you use as the meta of the module definition is 'Mask' or 'MaskModule' if _force_search is set to true in the module definition.

XML Structure

<Mask id global_value unit type .../>

<Mask ...>

Parameter
Type
Description

id

String

The ID of the material

type

String

The type of the mask. Can be helmet, beard, glasses and mask. Defaults to mask.

global_value

String

unit

String

offsets

Table

Optional table of offsets for each character. Should look something like this: <offsets> <old_hoxton> <value_node value="0 0 0"> <value_node value="Rotation(0,0,0)"> </old_hoxton> </offsets> Each character needs position and rotation offset. First is position and second is rotation.

name_id

String

Localization ID for the title of the mask (Defaults to bm_msk_ + id)

desc_id

String

Localization ID for the description of the mask (Defaults to bm_msk_ + id)

texture_bundle_folder

String

Optional folder to contain the icon. The path will be guis/dlcs/texture_bundle_folder/textures/pd2/blackmarket/icons/masks/id. Defaults to mods

characters

Table

Optional table that contains characters and the mask for them. This allows you to have a unique mask for each character (See bm_msk_balaclava in masks tweakdata)

And any other tweakdata value. There are more that are not listed here yet.

The icon

Example

<Mask id="my_cool_mask" type="helmet"/>

Template

For packs of mods, a global id assigned to all. A nice way to label your mods. You'll still have to create the global value through

Optional path to the unit of the mask. Defaults to units/mods/masks/msk_id/msk_id You still need to add it through and all its dependencies such as object and material config.

The icon will be stored in guis/dlcs/mods/textures/pd2/blackmarket/icons/masks and will be named id.texture then add it using .

This example is what you would put inside your main node within your

This will add the mask my_cool_mask. You will still need to localize the title and description of the mask. In this case bm_msk_my_cool_mask and bm_msk_my_cool_mask_desc will need to be localized using . And add unit, object, material_config, textures and icon through

Download template here:

ItemModuleBase
AddFiles
mod config
LocalizationModule
AddFiles
here
GlobalValueModule
AddFiles