BLN Studio Docs - RedM Scripts

🛡️ BLN Shield ​

bln shield

📺 Preview ​

Video Preview

🔽 Get it Now ​

Download

A powerful and immersive body shield system for RedM. Players can equip shields via usable items that absorb incoming damage, feature stunning visual effects, and break when depleted. Fully configurable with multiple shield tiers and visual types.

✨ Features ​

🎯 Core Features ​

  • 🛡️ Damage Absorption - Shields absorb incoming damage based on configurable drain rates
  • ⚡ Multiple Shield Types - Electric (prop + particle FX) and Normal (clothing overlay)
  • 📊 Tiered Shields - Create light, medium, and heavy shields with different power levels
  • 💥 Visual Feedback - Particle effects on damage and healing
  • 🔄 Auto Break - Shield automatically unequips and notifies when depleted
  • 🧹 Auto Cleanup - Full cleanup on resource stop or player ped change

🎨 Visual Types ​

TypeVisuals
ElectricAttached prop + electric crackle on damage + tesla coil heal FX
NormalArmor & mask clothing overlay on the player ped

📦 Dependencies ​

  • bln_lib - Framework compatibility and item registration
  • bln_notify - Notification system
  • bln_hud - v3.0.2+ (Optional) For visual hud to see the shield.

🛠️ Configuration ​

Shield Items ​

Define your shield items in config/main.cfg.lua:

lua
Config.Items = {
    ['shield_normal'] = {
        power          = 40,   -- Max power (0-100)
        drainPerDamage = 0.45, -- Power drained per damage point
        type           = 'normal',
        segments       = 1,    -- UI segments (for HUD display)
    },
    ['shield_md'] = {
        power          = 70,
        drainPerDamage = 0.30,
        type           = 'electric',
        segments       = 4,
    },
    ['shield_heavy'] = {
        power          = 100,
        drainPerDamage = 0.18,
        type           = 'normal',
        segments       = 7,
    },
}

Shield Types ​

Define visual configurations in config/types.cfg.lua:

lua
Config.Types = {
    ['electric'] = {
        prop = {
            model = 'w_electricfielddetector01',
            bone  = 'skel_l_upperarm',
            x = 0.043, y = -0.109, z = 0.059,
            rx = -131.427, ry = 10.513, rz = 85.431,
        },
        healFx = {
            dict = 'scr_crackpot',
            name = 'scr_crackpot_tesla_coil',
            bone = 'SKEL_Head',
            scale = 0.4,
            durationMs = 1200,
        },
        damageFx = {
            dict = 'core',
            name = 'ent_amb_elec_crackle',
            scale = 1.2,
            durationMs = 600,
        },
    },
    ['normal'] = {
        clothing = {
            armor = 989985828,
            mask  = 1724663810,
        },
    },
}

Notification ​

lua
function _Notify(title)
    exports.bln_notify:tip(title, 4000, "middle-right")
end

Unequip Command ​

lua
Config.UnEquipCommand = 'unshield' -- /unshield to remove the shield

📋 Configuration Options ​

OptionDescription
powerMaximum shield capacity (0–100)
drainPerDamageMultiplier for how fast the shield drains per damage
typeWhich visual type to use (electric, normal)
segmentsNumber of UI segments for HUD integration

🔌 Exports (Client) ​

GetShieldInfo ​

Returns the current shield state.

lua
local itemId, item, percent = exports.bln_shield:GetShieldInfo()
-- itemId: string or nil
-- item: item config table or nil
-- percent: 0-100

IsShieldEquipped ​

Check if a shield is currently active.

lua
local equipped = exports.bln_shield:IsShieldEquipped()

SetShield ​

Set the shield power to a specific value.

lua
exports.bln_shield:SetShield(50) -- Set power to 50

AddShield ​

Add or subtract power from the current shield.

lua
exports.bln_shield:AddShield(20)  -- Heal 20 power
exports.bln_shield:AddShield(-10) -- Drain 10 power

UnequipShield ​

Force unequip the current shield.

lua
exports.bln_shield:UnequipShield()

🎯 How It Works ​

  1. Player uses a shield item → Server registers the item via bln_lib
  2. Shield equips → Visual type is applied (prop or clothing)
  3. Player takes damage → Shield absorbs damage and drains power
  4. Shield breaks → Auto-unequips, visuals removed, player notified

🤝 Support ​

Need help? Have questions? Join our Discord server for support and updates!

  • 💬 Discord: Join Our Community
  • 🎮 Live support and community help
  • 🔄 Regular updates and improvements
  • 💡 Feature requests and suggestions

Built with ❤️ by BLN Studio