⚙️Configuration

Overview

The Priority Cooldowns system is configured entirely through the config.lua file. This guide covers all available configuration options in detail.

Core Settings

Log Category

Define the logging category for Discord notifications:

PrioCD.LogCategory = 'priocd'

This category should be configured in your TMC Framework logging system to receive notifications when cooldowns are activated or cleared.

Allowed Jobs

Specify which jobs can manage priority cooldowns:

PrioCD.AllowedJobs = {
    'police',
    'medical',
    'ambulance'
}

Configuration Options:

• Add Jobs - Include any job name from your jobs configuration

• Remove Jobs - Delete jobs that shouldn't have access

• Multiple Departments - Add as many jobs as needed

Important: Players must be on duty with one of these jobs to use the cooldown system.

Activation Methods

The script supports two activation methods that can be enabled independently or together.

Command Activation

Enable or disable command-based cooldown management:

PrioCD.Activation = {
    ['Command'] = {
        Enabled = false,  -- Set to true to enable
        SetCMD = 'setcooldown',  -- Command to set cooldowns
        ClearCMD = 'clearcooldown'  -- Command to clear cooldowns
    }
}

Configuration Options:

• Enabled - true to enable commands, false to disable

• SetCMD - Customize the command name for setting cooldowns

• ClearCMD - Customize the command name for clearing cooldowns

Usage Examples:

/setcooldown 10MinCooldown
/setcooldown Meeting
/clearcooldown

Custom Command Names:

SetCMD = 'priocd',  -- Now use /priocd instead
ClearCMD = 'clearprio'  -- Now use /clearprio instead

Radial Menu Activation

Enable radial menu integration for easy access:

PrioCD.Activation = {
    ['Radial'] = {
        Enabled = true,  -- Set to false to disable radial menu
        Root = {
            Id = 'priocd',  -- Unique identifier
            Title = 'Priority Cooldowns',  -- Display name in menu
            Icon = 'user-police',  -- FontAwesome icon name
            IconCategory = 'duotone'  -- Icon style (solid, duotone, etc.)
        }
    }
}

Configuration Options:

• Enabled - true to enable radial menu integration

• Id - Unique identifier for the menu (should remain unchanged)

• Title - Text displayed in the radial menu

• Icon - FontAwesome icon name (without 'fa-' prefix)

• IconCategory - Icon style: 'solid', 'duotone', 'regular', etc.

Customization Example:

Root = {
    Id = 'priocd',
    Title = 'Emergency Priority',  -- Custom title
    Icon = 'siren-on',  -- Different icon
    IconCategory = 'solid'  -- Solid style
}

Cooldown Options

Define the available cooldown presets that users can select.

Standard Cooldown Structure

Each cooldown follows this structure:

['CooldownName'] = {
    Enabled = true,  -- Enable/disable this option
    Title = 'Display Name',  -- Shown in radial menu/UI
    Icon = 'icon-name',  -- FontAwesome icon
    IconCategory = 'duotone',  -- Icon style
    Settings = {
        SetCooldown = true,  -- This is a cooldown setter
        Timer = 10,  -- Duration in minutes
        Type = 'Standard'  -- Cooldown type (references PrioCD.Types)
    }
}

Clear Priority Option

Special option to remove active cooldowns:

['ClearPriority'] = {
    Enabled = true,
    Title = 'Remove Cooldown',
    Icon = 'users',
    IconCategory = 'duotone',
    Settings = {
        RemoveCooldown = true  -- Marks this as a clear option
    }
}

Timed Cooldown Options

Pre-configured time-based cooldowns:

['10MinCooldown'] = {
    Enabled = true,
    Title = '10 Mins',
    Icon = 'users',
    IconCategory = 'duotone',
    Settings = {
        SetCooldown = true,
        Timer = 10,  -- 10 minutes
        Type = 'Standard'  -- References PrioCD.Types['Standard']
    }
},
['20MinCooldown'] = {
    Enabled = true,
    Title = '20 Mins',
    Icon = 'users',
    IconCategory = 'duotone',
    Settings = {
        SetCooldown = true,
        Timer = 20,  -- 20 minutes
        Type = 'Standard'
    }
},
['30MinCooldown'] = {
    Enabled = true,
    Title = '30 Mins',
    Icon = 'users',
    IconCategory = 'duotone',
    Settings = {
        SetCooldown = true,
        Timer = 30,  -- 30 minutes
        Type = 'Standard'
    }
}

Unlimited Duration Cooldown

Cooldown with no automatic expiry:

['Meeting'] = {
    Enabled = true,
    Title = 'Meeting',
    Icon = 'users',
    IconCategory = 'duotone',
    Settings = {
        SetCooldown = true,
        Timer = false,  -- No timer = unlimited duration
        Type = 'Meeting'  -- References PrioCD.Types['Meeting']
    }
}

Adding Custom Cooldowns

You can add as many custom cooldown options as needed:

['5MinCooldown'] = {
    Enabled = true,
    Title = '5 Minutes',
    Icon = 'clock',
    IconCategory = 'solid',
    Settings = {
        SetCooldown = true,
        Timer = 5,
        Type = 'Standard'
    }
},
['60MinCooldown'] = {
    Enabled = true,
    Title = '1 Hour',
    Icon = 'hourglass',
    IconCategory = 'solid',
    Settings = {
        SetCooldown = true,
        Timer = 60,
        Type = 'Standard'
    }
},
['Maintenance'] = {
    Enabled = true,
    Title = 'Server Maintenance',
    Icon = 'screwdriver-wrench',
    IconCategory = 'duotone',
    Settings = {
        SetCooldown = true,
        Timer = false,  -- Unlimited
        Type = 'Maintenance'  -- Must add to PrioCD.Types
    }
}

Key Configuration Tips:

• Enabled - Set to false to hide a cooldown option without deleting it

• Timer - Value in minutes; set to false for unlimited duration

• Type - Must match a key in PrioCD.Types configuration

Cooldown Types

Define how different cooldown types appear to players in the UI.

Type Structure

PrioCD.Types = {
    ['TypeName'] = {
        Title = 'Display Title',  -- Main heading shown to players
        Info = 'Description text',  -- Information message
        Color = '#E14141',  -- Background color (hex code)
        TextColor = 'white'  -- Text color
    }
}

Standard Type

Default cooldown type for general incidents:

['Standard'] = {
    Title = 'Priority Cooldown',
    Info = 'Ongoing incident, cooldown activated, No robberies until the cooldown has finished!',
    Color = '#E14141',  -- Red background
    TextColor = 'white'
}

Meeting Type

Specialized type for police meetings:

['Meeting'] = {
    Title = 'Police Meeting Cooldown',
    Info = 'There is currently A police meeting, No robberies until the cooldown has finished!',
    Color = '#E14141',  -- Red background
    TextColor = 'white'
}

Creating Custom Types

Add new cooldown types for different scenarios:

['Chase'] = {
    Title = 'Active Police Chase',
    Info = 'High-speed pursuit in progress. All criminal activities are suspended until the chase concludes.',
    Color = '#FF6B35',  -- Orange background
    TextColor = 'white'
},
['Investigation'] = {
    Title = 'Major Investigation',
    Info = 'Major crime investigation underway. Please avoid starting new criminal activities.',
    Color = '#4A90E2',  -- Blue background
    TextColor = 'white'
},
['Maintenance'] = {
    Title = 'Server Maintenance',
    Info = 'Server is undergoing maintenance. All activities are temporarily restricted.',
    Color = '#6C757D',  -- Gray background
    TextColor = 'white'
},
['Event'] = {
    Title = 'Server Event Active',
    Info = 'Special server event in progress! Normal activities will resume after the event.',
    Color = '#28A745',  -- Green background
    TextColor = 'white'
},
['Training'] = {
    Title = 'Training Exercise',
    Info = 'Police department training exercise. Criminal activities are paused during this session.',
    Color = '#FFC107',  -- Yellow background
    TextColor = '#000000'  -- Black text for contrast
}

Color Customization Tips:

• Use hex color codes (e.g., #E14141)

• Choose contrasting text colors for readability

• Common colors:

  • Red: #E14141 (urgent/danger)

  • Orange: #FF6B35 (warning)

  • Blue: #4A90E2 (informational)

  • Green: #28A745 (positive/event)

  • Yellow: #FFC107 (caution)

  • Gray: #6C757D (neutral/maintenance)

Icon Configuration

The script uses FontAwesome icons for visual elements.

Available Icon Styles

• solid - Filled icons

• regular - Outlined icons

• duotone - Two-tone icons (if supported)

• light - Light-weight icons (if supported)

• brands - Brand logos

Common Icon Examples

-- Emergency/Police Icons
Icon = 'user-police',        -- Police officer
Icon = 'siren-on',           -- Emergency siren
Icon = 'shield-halved',      -- Shield
Icon = 'handcuffs',          -- Handcuffs

-- Time Icons
Icon = 'clock',              -- Clock
Icon = 'hourglass',          -- Hourglass
Icon = 'timer',              -- Timer
Icon = 'stopwatch',          -- Stopwatch

-- General Icons
Icon = 'users',              -- Multiple users
Icon = 'ban',                -- Ban/prohibition
Icon = 'exclamation-triangle', -- Warning
Icon = 'info-circle',        -- Information
Icon = 'check-circle',       -- Success/complete

Icon Configuration Example

['30MinCooldown'] = {
    Enabled = true,
    Title = '30 Mins',
    Icon = 'clock',  -- Choose appropriate icon
    IconCategory = 'solid',  -- Choose icon style
    Settings = {
        SetCooldown = true,
        Timer = 30,
        Type = 'Standard'
    }
}

Advanced Configuration

Complete Configuration Example

Here's a full example with multiple custom options:

TMC = exports.core:getCoreObject()

PrioCD = {}

-- Logging
PrioCD.LogCategory = 'priocd'

-- Job Permissions
PrioCD.AllowedJobs = {
    'police',
    'sheriff',
    'statepolice',
    'medical',
    'ambulance'
}

-- Activation Methods
PrioCD.Activation = {
    ['Command'] = {
        Enabled = true,
        SetCMD = 'setcooldown',
        ClearCMD = 'clearcooldown'
    },
    ['Radial'] = {
        Enabled = true,
        Root = {
            Id = 'priocd',
            Title = 'Priority Cooldowns',
            Icon = 'siren-on',
            IconCategory = 'solid'
        }
    }
}

-- Cooldown Options
PrioCD.Cooldowns = {
    ['ClearPriority'] = {
        Enabled = true,
        Title = 'Remove Cooldown',
        Icon = 'xmark-circle',
        IconCategory = 'solid',
        Settings = {
            RemoveCooldown = true
        }
    },
    ['5MinCooldown'] = {
        Enabled = true,
        Title = '5 Minutes',
        Icon = 'clock',
        IconCategory = 'solid',
        Settings = {
            SetCooldown = true,
            Timer = 5,
            Type = 'Standard'
        }
    },
    ['15MinCooldown'] = {
        Enabled = true,
        Title = '15 Minutes',
        Icon = 'clock',
        IconCategory = 'solid',
        Settings = {
            SetCooldown = true,
            Timer = 15,
            Type = 'Standard'
        }
    },
    ['30MinCooldown'] = {
        Enabled = true,
        Title = '30 Minutes',
        Icon = 'clock',
        IconCategory = 'solid',
        Settings = {
            SetCooldown = true,
            Timer = 30,
            Type = 'Standard'
        }
    },
    ['MeetingCooldown'] = {
        Enabled = true,
        Title = 'Police Meeting',
        Icon = 'users',
        IconCategory = 'duotone',
        Settings = {
            SetCooldown = true,
            Timer = false,
            Type = 'Meeting'
        }
    },
    ['TrainingCooldown'] = {
        Enabled = true,
        Title = 'Training Exercise',
        Icon = 'graduation-cap',
        IconCategory = 'solid',
        Settings = {
            SetCooldown = true,
            Timer = false,
            Type = 'Training'
        }
    }
}

-- Cooldown Types
PrioCD.Types = {
    ['Standard'] = {
        Title = 'Priority Cooldown Active',
        Info = 'Major incident in progress. All criminal activities are suspended until the cooldown expires.',
        Color = '#E14141',
        TextColor = 'white'
    },
    ['Meeting'] = {
        Title = 'Police Department Meeting',
        Info = 'Police department meeting in session. Criminal activities will resume after the meeting.',
        Color = '#4A90E2',
        TextColor = 'white'
    },
    ['Training'] = {
        Title = 'Training Exercise Active',
        Info = 'Law enforcement training exercise underway. Please hold all criminal activities.',
        Color = '#FFC107',
        TextColor = '#000000'
    }
}

Configuration Best Practices

1. Enable What You Need - Disable unused cooldown options to keep menus clean

2. Logical Durations - Choose timer durations that make sense (5, 10, 15, 30, 60 minutes)

3. Clear Naming - Use descriptive titles that players instantly understand

4. Consistent Types - Match cooldown types to their intended purpose

5. Visual Distinction - Use different colors for different cooldown types

6. Icon Selection - Choose icons that represent the cooldown type clearly

Disabling Features

To disable specific features without removing configuration:

-- Disable command activation
['Command'] = {
    Enabled = false,  -- Commands disabled
    SetCMD = 'setcooldown',
    ClearCMD = 'clearcooldown'
}

-- Disable specific cooldown option
['40MinCooldown'] = {
    Enabled = false,  -- This option won't appear
    Title = '40 Mins',
    -- ... rest of config
}

Integration Configuration

When integrating with other scripts, you may want to adjust logging or add custom types:

Custom Log Categories

For different departments or purposes:

PrioCD.LogCategory = 'police-priority'  -- For police-specific logs
PrioCD.LogCategory = 'server-cooldowns'  -- For general server logs

Department-Specific Configurations

Create separate configurations for different departments:

-- Police-only configuration
PrioCD.AllowedJobs = {'police', 'sheriff'}

-- Medical-only configuration
PrioCD.AllowedJobs = {'medical', 'ambulance'}

-- Combined emergency services
PrioCD.AllowedJobs = {'police', 'sheriff', 'medical', 'fire'}

Next Steps

After configuring your priority cooldown system, check out the FAQ for common questions and troubleshooting tips, or return to Installation for setup instructions.