Hooks
Hooks provided by the Shoot Lock module for managing lock breaking via shooting.
Overview
The Shoot Lock module adds the ability to shoot door locks to open them, a quick breach alternative, a loud action that may alert others, and chance-based lock destruction.. It provides comprehensive hook integration for customizing managing lock breaking via shooting and extending functionality.
CanPlayerBustLock
đ Purpose
Called to determine if a player can bust a lock by shooting.
â° When Called
When a door is shot and before lock breaking is attempted.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player attempting to bust the lock |
entity |
Entity | The door entity |
âŠī¸ Returns
boolean - Return false to prevent lock busting
đ Realm
Server
Overview
The Shoot Lock module adds the ability to shoot door locks to open them, a quick breach alternative, a loud action that may alert others, and chance-based lock destruction.. It provides comprehensive hook integration for customizing managing lock breaking via shooting and extending functionality.
LockShotAttempt
đ Purpose
Called when a player attempts to shoot a lock.
â° When Called
When a door is shot with a bullet, before validation.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player attempting to shoot the lock |
entity |
Entity | The door entity being shot |
dmgInfo |
CTakeDamageInfo | The damage information |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Shoot Lock module adds the ability to shoot door locks to open them, a quick breach alternative, a loud action that may alert others, and chance-based lock destruction.. It provides comprehensive hook integration for customizing managing lock breaking via shooting and extending functionality.
LockShotBreach
đ Purpose
Called when a lock is successfully breached.
â° When Called
After the door is unlocked and opened.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player who breached the lock |
entity |
Entity | The door entity that was breached |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Shoot Lock module adds the ability to shoot door locks to open them, a quick breach alternative, a loud action that may alert others, and chance-based lock destruction.. It provides comprehensive hook integration for customizing managing lock breaking via shooting and extending functionality.
LockShotFailed
đ Purpose
Called when a lock shot attempt fails.
â° When Called
When the shot doesn't hit the lock handle or other validation fails.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player whose attempt failed |
entity |
Entity | The door entity |
dmgInfo |
CTakeDamageInfo | The damage information |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Shoot Lock module adds the ability to shoot door locks to open them, a quick breach alternative, a loud action that may alert others, and chance-based lock destruction.. It provides comprehensive hook integration for customizing managing lock breaking via shooting and extending functionality.
LockShotSuccess
đ Purpose
Called when a lock is successfully shot open.
â° When Called
After the door is unlocked and opened.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player who succeeded |
entity |
Entity | The door entity that was opened |
âŠī¸ Returns
nil
đ Realm
Server