Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pandryx.com/llms.txt

Use this file to discover all available pages before exploring further.




Installation
Med Mask
  1. Unzip Pandryx_MedMask and place Pandryx_MedMask in your server’s resources folder.
  2. Add ensure Pandryx_MedMask to your server.cfg
  3. Start / Restart your server
    This step is optional and only required if you want players to use the mask as an inventory item.
    INSERT INTO `items` (`name`, `label`, `weight`, `rare`, `can_remove`)
VALUES ('mask', 'Medical Mask', 0, 0, 1);

    QBCore does not use SQL items by default.
Open: qb-core/shared/items.lua
Add the following item:
["mask"] = {
    name = "mask",
    label = "Medical Mask",
    weight = 0,
    type = "item",
    image = "mask.png",
    unique = false,
    useable = true,
    shouldClose = true,
    description = "A medical face mask."
},
Make sure the item image exists in: qb-inventory/html/images/
Framework Defines which framework the script uses. Supported Frameworks:
  • Auto - Detect Automatically
  • ESX
  • QBCORE
  • QBOX
Config.Framework = "auto"
Command The command players use to toggle the mask. 
Config.Command = "emask"
Modifying the command may result in conflicts or cause the script to malfunction. Always use /emask to ensure reliable and consistent functionality.
Item Usage Allows the mask to be used as an inventory item instead of only a command. 
Config.Item = {
    Enabled = false,
    Name = "mask",
    Label = "Medical Mask"
}
Mask Settings Controls which mask component is applied to the player. 
Config.Mask = {
    Component = 1,
    Drawable = 33,
    Texture = 0,
    RemoveDrawable = 0,
    RemoveTexture = 0
}
Job Restrictions Limits mask usage to specific jobs. 
Config.JobRestriction = {
    Enabled = true,

    Jobs = {
        police = true,
        ambulance = true
    }
}
Mask Blocker Prevents players from equipping specific masks while this script is active. 
Config.MaskBlocker = {

    Enabled = true,
    Notify = true,
    CheckInterval = 1000,

    Blocks = {
        {Slot = 1, Drawable = 33}
    }

}
Animation Animation played when putting on the mask. 
Config.Animation = {
    Dict = "mp_masks@standard_car@ds@",
    Name = "put_on_mask",
    Duration = 1200
}
Cooldown Adds a cooldown between mask usage. 
Config.Cooldown = {
    Enabled = true,
    Time = 5000
}
Notifications Messages shown to players when using the mask. 
Config.NotifyOn = "You put on your medical mask"
Config.NotifyOff = "You removed your medical mask"
Config.NoPermission = "You are not authorised to use this"
Notification Type 
Config.Notification = {
    Type = "auto"
}
Keybind 
Config.Keybind = {
    Enabled = false,
    Key = 288 -- F1 
}
Remove Mask on Respawn Automatically removes the mask when the player respawns. 
Config.RemoveOnRespawn = {
    Enabled = true
}