BeardLib
Search…
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
Optional path of the pattern's texture. If you're loading a custom one you'll need to load it through AddFiles first. Defaults to units/mods/masks/shared_textures/pattern_id
global_value
String
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 GlobalValueModule
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
Last modified 6mo ago
Copy link
Edit on GitHub
On this page
Module Definition
Module name
XML Structure
Example