> For the complete documentation index, see [llms.txt](https://luffyyy.gitbook.io/beardlib/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://luffyyy.gitbook.io/beardlib/modules/scriptreplacementsmodule.md).

# Script Mods (Replace script data)

Updated for version 3.38.

## Module Definition

The module is inherited from [ModuleBase](https://luffyyy.gitbook.io/beardlib/modules/modulebase). So base parameters can be found there.

### Module name

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

### XML Structure

There are two ways of modding scriptdata:

#### File

```markup
<ScriptMods directory>
    <mod file type target_path target_type .../>
</ScriptMods>
```

#### Direct

```markup
<ScriptMods directory>
    <mod target_path target_type ...>
        <tbl>
        </tbl>
    </mod>
</ScriptMods>
```

#### `<ScriptMods directory>`

| Parameter | Type   | Description                                                                                                                |
| --------- | ------ | -------------------------------------------------------------------------------------------------------------------------- |
| directory | String | string directory/path relative to the mods directory which contains all the script data mods being referenced. \[OPTIONAL] |

#### `<mod file type target_path target_type, ...>`

| Parameter    | Type   | Description                                                                                                                                        |
| ------------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| file         | String | string which is the filename of the script data file relative to the Mod directory and the directory defined in the main node if it was specified. |
| type         | String | The script data type of the file you are using for replacement/mod. E.g. custom\_xml, generic\_xml, binary etc                                     |
| tbl          | Table  | Instead of `file` and `type`, write scriptdata mod directly.                                                                                       |
| target\_path | String | The path of the script data file you are modifying                                                                                                 |
| target\_type | String | The extension/type of the script data file you are modifying                                                                                       |

#### Options / Additional parameters

| Parameter   | Type   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ----------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| use\_clbk   | String | Path/name to callback that would be called before scriptdata mod gets applied, if the callback returns true, the scriptdata mod will be applied. Can be "self.UseFunc" or "ClassClbk(class, 'UseFunc')"                                                                                                                                                                                                                                                                                                                                                      |
| merge\_mode | String | How should the scriptdata mode be applied, the modes are:`replace` Replaces the scriptdata entirely, default.`merge` Merges with the scriptdata.`script_merge` A dynamic merge with the script, allows you to remove specific parts of the scriptdata, merge with specific parts or replace specifc parts. Read about script\_merge [here](https://luffyyy.gitbook.io/beardlib/utilities/table#other) and see examples [here](https://luffyyy.gitbook.io/beardlib/utilities/table#script_merge-examples). You can see removal of a part in the example below |

### Examples

In both examples is what you would put inside your main node within your [mod config](https://github.com/GreatBigBushyBeard/PAYDAY-2-BeardLib/wiki/Module-Config)

#### File

For this example your script mod would be like this: `mods/MyMod/scriptdata/start_menu.xml`. If you are using this module in a BLT mod.

```markup
<ScriptMods directory="scriptdata">
    <mod file="start_menu.xml" type="custom_xml" target_path="gamedata/menus/start_menu" target_type="menu"/>
<ScriptMods/>
```

#### Direct

```markup
<ScriptMods>
    <mod target_file="units/payday2/characters/ragdoll" target_type="sequence_manager" merge_mode="script_merge">
        <tbl>
            <table search="unit">
                <table mode="remove" search="sequence;name='\'freeze_ragdoll\''"/>
            </table>
        </tbl>
    </mod>
</ScriptMods>
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://luffyyy.gitbook.io/beardlib/modules/scriptreplacementsmodule.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.