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

Tweak Modify

PreviousSoundsNextWeapon Mod

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 change tweakdata through XML. The module uses to inject to the tweakdata.

Module name

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

XML Structure

<TweakModify overwrite normalize>
    <tweak path data overwrite normalize/>
</TweakModify>

<tweak path data overwrite/>

Parameter
Type
Description

path

String

Path to the data in tweak_data that you wish to "modify/overwrite". For example: narrative/jobs (tweak_data.narrative.jobs) or "dlc" (tweak_data.dlc)

data

Any

The data that should merge with it/overwrite it. This can be a table, string, number etc

overwrite

Boolean

Determines if the data should be overwritten. Non table values are always overwritten.

normalize

Boolean

Determines if the data should be "normalized". This let's us write values like Color and Rotation which normally not supported (The game will read it as a string)

Example

<TweakModify>
    <tweak path="screen_colors/button_stage_2" data="Color(0.5, 0.3, 0.6)" normalize="true"/>
</TweakModify>

This changes one of the button colors in many areas of the game (Modifies tweak_data.screen_colors.button_stage_2)

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

ItemModuleBase
TweakDataHelper
mod config