Hooks

Hooks provided by the Map Cleaner module for managing automatic map and item cleanup.

---

Overview

The Map Cleaner module adds periodic cleaning of map debris, a configurable interval, reduced server lag, a whitelist for protected entities, and manual cleanup commands.. It provides comprehensive hook integration for customizing managing automatic map and item cleanup and extending functionality.

---

ItemCleanupEntityRemoved

📋 Purpose

Called when an item entity is removed during item cleanup.

⏰ When Called

For each item entity that is removed during the cleanup cycle.

⚙️ Parameters

Parameter	Type	Description
item	Entity	The item entity being removed

↩️ Returns

nil

🌐 Realm

Server

---

Overview

The Map Cleaner module adds periodic cleaning of map debris, a configurable interval, reduced server lag, a whitelist for protected entities, and manual cleanup commands.. It provides comprehensive hook integration for customizing managing automatic map and item cleanup and extending functionality.

---

MapCleanupEntityRemoved

📋 Purpose

Called when an entity is removed during map cleanup.

⏰ When Called

For each entity that is removed during the map cleanup cycle.

⚙️ Parameters

Parameter	Type	Description
ent	Entity	The entity being removed

↩️ Returns

nil

🌐 Realm

Server

---

Overview

The Map Cleaner module adds periodic cleaning of map debris, a configurable interval, reduced server lag, a whitelist for protected entities, and manual cleanup commands.. It provides comprehensive hook integration for customizing managing automatic map and item cleanup and extending functionality.

---

PostItemCleanup

📋 Purpose

Called after item cleanup has completed.

⏰ When Called

After all items have been removed.

⚙️ Parameters

None

↩️ Returns

nil

🌐 Realm

Server

---

Overview

The Map Cleaner module adds periodic cleaning of map debris, a configurable interval, reduced server lag, a whitelist for protected entities, and manual cleanup commands.. It provides comprehensive hook integration for customizing managing automatic map and item cleanup and extending functionality.

---

PostItemCleanupWarning

📋 Purpose

Called after item cleanup warning messages are sent.

⏰ When Called

After warning messages are sent to all players (60 seconds before cleanup).

⚙️ Parameters

None

↩️ Returns

nil

🌐 Realm

Server

---

Overview

The Map Cleaner module adds periodic cleaning of map debris, a configurable interval, reduced server lag, a whitelist for protected entities, and manual cleanup commands.. It provides comprehensive hook integration for customizing managing automatic map and item cleanup and extending functionality.

---

PostMapCleanup

📋 Purpose

Called after map cleanup has completed.

⏰ When Called

After all entities have been removed.

⚙️ Parameters

None

↩️ Returns

nil

🌐 Realm

Server

---

Overview

The Map Cleaner module adds periodic cleaning of map debris, a configurable interval, reduced server lag, a whitelist for protected entities, and manual cleanup commands.. It provides comprehensive hook integration for customizing managing automatic map and item cleanup and extending functionality.

---

PostMapCleanupWarning

📋 Purpose

Called after map cleanup warning messages are sent.

⏰ When Called

After warning messages are sent to all players (60 seconds before cleanup).

⚙️ Parameters

None

↩️ Returns

nil

🌐 Realm

Server

---

Overview

The Map Cleaner module adds periodic cleaning of map debris, a configurable interval, reduced server lag, a whitelist for protected entities, and manual cleanup commands.. It provides comprehensive hook integration for customizing managing automatic map and item cleanup and extending functionality.

---

PreItemCleanup

📋 Purpose

Called before item cleanup begins.

⏰ When Called

Before items start being removed.

⚙️ Parameters

None

↩️ Returns

nil

🌐 Realm

Server

---

Overview

The Map Cleaner module adds periodic cleaning of map debris, a configurable interval, reduced server lag, a whitelist for protected entities, and manual cleanup commands.. It provides comprehensive hook integration for customizing managing automatic map and item cleanup and extending functionality.

---

PreItemCleanupWarning

📋 Purpose

Called before item cleanup warning messages are sent.

⏰ When Called

Before warning messages are sent to players (60 seconds before cleanup).

⚙️ Parameters

None

↩️ Returns

nil

🌐 Realm

Server

---

Overview

The Map Cleaner module adds periodic cleaning of map debris, a configurable interval, reduced server lag, a whitelist for protected entities, and manual cleanup commands.. It provides comprehensive hook integration for customizing managing automatic map and item cleanup and extending functionality.

---

PreMapCleanup

📋 Purpose

Called before map cleanup begins.

⏰ When Called

Before entities start being removed.

⚙️ Parameters

None

↩️ Returns

nil

🌐 Realm

Server

---

Overview

The Map Cleaner module adds periodic cleaning of map debris, a configurable interval, reduced server lag, a whitelist for protected entities, and manual cleanup commands.. It provides comprehensive hook integration for customizing managing automatic map and item cleanup and extending functionality.

---

PreMapCleanupWarning

📋 Purpose

Called before map cleanup warning messages are sent.

⏰ When Called

Before warning messages are sent to players (60 seconds before cleanup).

⚙️ Parameters

None

↩️ Returns

nil

🌐 Realm

Server