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
  • Functions

Was this helpful?

Edit on GitHub
  1. Modules

Contact (contractors)

PreviousClassesNextCrime Spree Mission

Last updated 3 years ago

Was this helpful?

Updated for version 3.37.

Module Definition

The module inherits . All parameters and functions of this class are inherited by the module.

Module name

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

XML Structure

<contact id name_id desc_id package assets_gui ...>
    ...
</contact>

<contact id name_id desc_id package assets_gui>

Parameter
Type
Description

id

String

id of the contact [REQUIRED]. This is used as the key for when it is added to the tweak_data

name_id

String

The localization id for the name of the contact, this is localized when the name of the contact is being displayed

desc_id

String

The localization id for the description of the contact

package

String

The package/bundle to be loaded which contains the assets used for the contact

assets_gui

String

The path of the gui file which is to be used by the contact

And any data which is not present here, but you wish to be included in the tweak data definition

Example

<contact id="shatter" name_id="heist_contact_shatter" desc_id="heist_contact_shatter_description" package="packages/contact_interupt" assets_gui="guis/mission_briefing/preload_contact_interupt"/>

Functions

Function
Description

AddContactData(Table narr_self)

Called automatically by RegisterHook() if it's called. Adds to narr_self.contacts (narr_self is tweak_data.narrative) your new contact.

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

ItemModuleBase
mod config