Configuration

Region Information

General Details

The tw-plumber script includes a dedicated job region set in El Burro Heights, offering players various plumbing-related tasks like pipe repairs, valve operations, and electrical fixes.

  • Region Key: 1

    • This is a unique identifier for the region.

  • Region Title: "El Burro Heights"

    • The name of the job region.

  • Region Details: Localized text to describe the job.

  • Region Image: "region.png"

    • Displays the region's image.

  • Minimum Level Required: 0

    • No level restrictions are set for participating in this region's tasks.

Vehicle Configuration

Job Vehicle

Defines the primary vehicle used for the tailoring tasks.

  • Vehicle Model: "tolboru"

    • This is the job vehicle players use during missions.

  • Spawn Locations: Vehicles spawn at the following coordinates:

    • vector4(1370.2, -2080.13, 52.02, 39.56)

Rewards Configuration

Region Awards

Players earn rewards upon completing tasks successfully. The amount of Money and XP per mission when doing bonus missions

  • Monetary Reward: $5000

  • Experience Points (XP): 1000

  • Online Job Extra Awards: 2x

  • Bonus Extra Money: $500

  • Bonus Extra XP: 200

Job Tasks

Task Types

The region includes several types of plumbing tasks:

  1. Pipe Repair

    • Job Name: "repairpipe"

    • Task Count: 1

    • Label: missionTwoBlips

  2. Pipe Insertion

    • Job Name: "insertpipe"

    • Task Count: 1

    • Label: missionOneBlips

  3. Toilet Unclogging

    • Job Name: "toiletschoked"

    • Task Count: 2

    • Label: missionThreeBlips

  4. Valve Operation

    • Job Name: "openvalve"

    • Task Count: 1

    • Label: missionFourBlips

  5. Switch Fixing (Bonus Task)

    • Job Name: "fixswitch"

    • Task Count: 1

    • Label: missionFiveBlips

    • Bonus Enabled: Yes

Here’s the GitBook-style documentation for the provided dailyMission configuration:

Daily Missions Documentation

Overview

The dailyMission configuration defines daily tasks that players can complete to earn rewards such as experience points (XP) and money. Each mission includes a unique name, header, label, and specific objectives.

Mission Details

Mission 1: Job Task One

  • Name: jobtask_one

  • Header: Localized string for "Job Task 1".

    • Retrieved from: Locales[Config.Locale]['jobtask'] .. " 1"

  • Label: Localized label for daily job one.

    • Retrieved from: Locales[Config.Locale]['dailyjobone']

  • Objective: Complete 50 tasks.

  • Rewards:

    • Experience Points (XP): 2500

    • Money: $1000

Mission 2: Job Task Two

  • Name: jobtask_two

  • Header: Localized string for "Job Task 2".

    • Retrieved from: Locales[Config.Locale]['jobtask'] .. " 2"

  • Label: Localized label for daily job two.

    • Retrieved from: Locales[Config.Locale]['dailyjobtwo']

  • Objective: Complete 10 tasks.

  • Rewards:

    • Experience Points (XP): 1000

    • Money: $3000

Mission 3: Job Task Three

  • Name: jobtask_three

  • Header: Localized string for "Job Task 3".

    • Retrieved from: Locales[Config.Locale]['jobtask'] .. " 3"

  • Label: Localized label for daily job three.

    • Retrieved from: Locales[Config.Locale]['dailyjobthree']

  • Objective: Complete 10,000 tasks.

  • Rewards:

    • Experience Points (XP): 2000

    • Money: $3000

Mission 4: Job Task Four

  • Name: jobtask_four

  • Header: Localized string for "Job Task 4".

    • Retrieved from: Locales[Config.Locale]['jobtask'] .. " 4"

  • Label: Localized label for daily job four.

    • Retrieved from: Locales[Config.Locale]['dailyjobfour']

  • Objective: Complete 20 tasks.

  • Rewards:

    • Experience Points (XP): 2000

    • Money: $3000

Configuration Highlights

  1. Dynamic Localization:

    • Headers and labels for missions are dynamically retrieved from the configured locale (Locales[Config.Locale]), ensuring multi-language support.

  2. Scalable Objectives:

    • Each mission's count determines the total tasks required for completion, allowing flexibility in mission difficulty.

  3. Balanced Rewards:

    • XP and money rewards vary based on the mission's difficulty, providing fair incentives for players.

Tutorial List Configuration

Overview

The TutorialList configuration defines a structured list of tutorials to guide players through various aspects of the script. Each tutorial contains a unique ID, a localized title, a description, and an internal name for easy identification.

End Job Function Documentation

Overview

The endJobFunction is a customizable callback that executes after a job is completed. This function provides flexibility for developers to add specific actions, events, or rewards for players upon job completion.

Notification System

Overview

This section explains the Config.sendNotification function used to display UI notifications within the plumber job or any compatible script.

Function Definition

Config.sendNotification = function(messages, value) NuiMessage('NOTIFICATION', { message = messages, type = value }) end

Config.sendNotification = function(messages, value)
    NuiMessage('NOTIFICATION', { message = messages, type = value })
end
Name
Type
Description

messages

string

The message text to be shown in the UI

value

string

Notification type (e.g., "success", "error")

How It Works

This function triggers a NuiMessage event with the notification data. It sends an object containing both message and type to the 'NOTIFICATION' event used in the NUI interface.

Example Usage

Config.sendNotification("Pipe repaired successfully!", "success")

This example will trigger a success notification with the given message.

PreviousInstallationNextConfig File

Last updated