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 Pattern

Updated for version 3.38.

Module Definition

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

This modules let's you add mask patterns.

Module name

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

XML Structure

<MaskPattern id texture global_value/>

<MaskPattern ...>

Parameter
Type
Description

id

String

The ID of the pattern

texture

String

global_value

String

name_id

String

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

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

Example

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

<MaskPattern id="spade"/>

This will add the mask pattern spade. You will still need to localize the name of the pattern. In this case pattern_spade_title will need to be localized using LocalizationModule. And add the texture which in this is in "units/mods/masks/shared_textures/pattern_spade" through AddFiles

Template

Download template here

PreviousMask MaterialNextMask

Last updated 3 years ago

Was this helpful?

Optional path of the pattern's texture. If you're loading a custom one you'll need to load it through first. Defaults to units/mods/masks/shared_textures/pattern_id

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

AddFiles
GlobalValueModule