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 Material

PreviousLocalizationNextMask Pattern

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 mask materials.

Module name

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

XML Structure

<MaskMaterial id texture global_value material_amount/>

<MaskMaterial ...>

Parameter
Type
Description

id

String

The ID of the material

texture

String

global_value

String

material_amount

Integer

How the material is applied to the mask. Set to 0 to have it tile across the mask. Remove it to have it strech over the mask

name_id

String

A localization ID for the pattern (Defaults to material_ + id + _title)

texture_bundle_folder

String

Optional folder to contain the icon. The path will be guis/dlcs/ texture_bundle_folder/textures/pd2/blackmarket/icons/materials/id. Defaults to mods with ver="2"

ver

Number

Version of the module. 2 makes texture_bundle_folder default to mods

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

The icon

Example

<MaskMaterial id="bubblewrap" material_amount="0"/>

Template

The path of the material's texture. You'll need to load it through . Defaults to units/mods/matcaps/id_df

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

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

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

This will add the mask material bubblewrap. You will still need to localize the name of the material. In this case material_bubblewrap_title will need to be localized using . And add the texture which is currently units/mods/matcaps/matcap_bubblewrap_df and icon through

Download template

ItemModuleBase
AddFiles
mod config
LocalizationModule
AddFiles
here
AddFiles
GlobalValueModule