Resource Configuration

This page provides comprehensive information about our configuration files, assisting in the setup of the resource.

---

cfg.Commands

This section documents the cfg.Commands configuration table, which controls ladder-related gameplay commands.

---@section Commands
cfg.Commands = {
    use = true,
}

• use: Enables (true) or disables (false) the command system. When true, the commands listed in this section become available for use.

---

Command References

collect

collect = {
    input = "ladder:collect",
    description = "Collect ladder from vehicle.",
    parameters = {
        {
            name = "type",
            help = "<9> <105> <135>"
        }
    }
}

• Description: Collect a ladder from the vehicle.

• Trigger: ladder:collect

• Parameters:

  • type: Specifies the type of ladder to collect. Accepted values: 9, 105, 135.

---

store

store = {
    input = "ladder:return",
    description = "Return ladder to vehicle."
}

• Description: Return the currently held ladder to the vehicle.

• Trigger: ladder:return

---

climb

climb = {
    input = "ladder:climb",
    description = "Climb ladder infront."
}

• Description: Climb the ladder directly in front of the player.

• Trigger: ladder:climb

---

pickup

pickup = {
    input = "ladder:pickup",
    description = "Pickup ladder infront."
}

• Description: Pick up a ladder found directly in front of the player.

• Trigger: ladder:pickup

---

cfg.LadderPlacement

This section defines how ladder placement is handled in the game environment, including options for visual aids and tool-based placement.

Overview

---@section LadderPlacement
cfg.LadderPlacement = {
    useGizmo = false,
    placementIndicator = true
}

---

Options

useGizmo

• Type: boolean

• Default: false

• Description: When set to true, the Gizmo Tool is used to place the ladder, allowing more precise and interactive control over its position and rotation.

useGizmo = true  -- Enables the Gizmo tool for placement

---

placementIndicator

• Type: boolean

• Default: true

• Description: When true, a visual indicator is shown on the ground at the spot where the ladder will be placed. This helps the player understand where the ladder will spawn before confirming the placement.

placementIndicator = true  -- Shows a visual guide on the ground

---

cfg.Keybinds

This table facilitates the editing of the keybinds utilized by the resource. These keybinds are represented in string format and can be found in the following location: core > client > classes > enumerators.lua.

---@section Keybinds
cfg.Keybinds = {
    collect_ladder = "E",
    return_ladder = "E",
    drop_ladder = "LEFT_ALT",

    climb_ladder = "G",
    pickup_ladder = "M",

    climb_up_ladder = "LEFT_SHIFT",
    climb_down_ladder = "LEFT_CTRL",
    slide_down_ladder = "SPACEBAR",

    extend_ladder = "LEFT_SHIFT",
    retract_ladder = "LEFT_CTRL"
}

---

cfg.InteractionSystem

This section controls the ladder system’s interaction UI, including whether it's enabled and how it appears visually through theme customization.

Overview

---@section InteractionSystem
cfg.InteractionSystem = {
    use = true,

    themes = {
        main_theme = "rgba(0, 168, 255, 0.7)",
        text_theme = "#f8f8f8",
        stroke_theme = "#f8f8f8"
    }
}

---

Settings

use

• Type: boolean

• Default: true

• Description: Enables (true) or disables (false) the ladder system’s interaction UI. If disabled, players won’t see any UI prompts for ladder-related interactions.

---

Theme Customization

Customize the appearance of the on-screen interaction prompts using the themes subtable.

themes.main_theme

• Type: string

• Default: "rgba(0, 168, 255, 0.7)"

• Description: Sets the background color of the interaction prompts. The example color is a semi-transparent blue.

themes.text_theme

• Type: string

• Default: "#f8f8f8"

• Description: Defines the color of the text shown in the interaction UI (e.g., prompt labels or key hints).

themes.stroke_theme

• Type: string

• Default: "#f8f8f8"

• Description: Sets the color of the border or stroke around the interaction prompt elements.

---