> 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/crimespreemissionmodule.md).

# Crime Spree Mission

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.

This module is used to add your level to the crime spree pool

### Module name

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

### XML Structure

```markup
<CrimeSpreeMission id icon level type add>
</CrimeSpreeMission>
```

| Parameter  | Type   | Description                                                                                                                        |
| ---------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| id         | String | Id for the crimespree mission                                                                                                      |
| icon       | String | A preview texture for the level                                                                                                    |
| level      | String | The id of the level that is going to be in this crimespree mission                                                                 |
| type       | String | The type of the level, short, medium or long(if I'm not wrong short is stealth)                                                    |
| add        | Number | How much points to add to the crimespree score \[Default: 7]                                                                       |
| icon\_rect | Table  | A table for the rectangle shape of the image(x,y,w,h). This can be used if your picture is inside a sprite texture, usage example: |

```markup
<CrimeSpreeMission id="crimespree_custom" icon="guis/path/to/loaded/texture" level="some_custom_level" type="medium">
    <icon_rect>
        <value_node value="250"/>
        <value_node value="0"/>
        <value_node value="250"/>
        <value_node value="250"/>
    </icon_rect>
</CrimeSpreeMission>
```

### Example

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

```markup
<CrimeSpreeMission id="crimespree_custom" icon="guis/path/to/loaded/texture" level="some_custom_level" type="medium">
```

### Functions

| Function                                                    | Description                                                                                                                                                        |
| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| AddMissionDataToTweak(crimespree\_tweak\_data, tweak\_data) | The function that injects the crimespree mission to the crimespree tweak data. Called by the hook created in RegisterHook or from the function RegisterHook itself |


---

# 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/crimespreemissionmodule.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.