Hooks
Hooks provided by the Perma Remove module for managing permanent entity removal.
Overview
The Perma Remove module adds ability to permanently delete map entities, logging for each removed entity, an admin-only command, confirmation prompts before removal, and restore list to undo mistakes.. It provides comprehensive hook integration for customizing managing permanent entity removal and extending functionality.
CanPermaRemoveEntity
đ Purpose
Called to determine if an entity can be permanently removed.
â° When Called
When the permaremove command is executed, before removal.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The admin attempting to remove the entity |
entity |
Entity | The entity to be removed |
âŠī¸ Returns
boolean - Return false to prevent removal
đ Realm
Server
Overview
The Perma Remove module adds ability to permanently delete map entities, logging for each removed entity, an admin-only command, confirmation prompts before removal, and restore list to undo mistakes.. It provides comprehensive hook integration for customizing managing permanent entity removal and extending functionality.
OnPermaRemoveEntity
đ Purpose
Called when an entity is permanently removed.
â° When Called
After the entity is removed and saved to the removal list.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The admin who removed the entity |
entity |
Entity | The entity that was removed (may be invalid) |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Perma Remove module adds ability to permanently delete map entities, logging for each removed entity, an admin-only command, confirmation prompts before removal, and restore list to undo mistakes.. It provides comprehensive hook integration for customizing managing permanent entity removal and extending functionality.
OnPermaRemoveLoaded
đ Purpose
Called when a permanently removed entity is loaded and removed on map start.
â° When Called
When the module loads and finds entities that should be removed.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
entity |
Entity | The entity being removed |
âŠī¸ Returns
nil
đ Realm
Server