Hooks
Hooks provided by the Donator module for managing donator benefits and rewards.
Overview
The Donator module adds libraries to manage donor perks, tracking for donor ranks and perks, configurable perks by tier, and commands to adjust character slots.. It provides comprehensive hook integration for customizing managing donator benefits and rewards and extending functionality.
DonatorAdditionalSlotsGiven
đ Purpose
Called when additional character slots are given to a player.
â° When Called
After the additional slots are added to the player's account.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
player |
Player | The player receiving additional slots |
addValue |
number | The number of additional slots being added |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Donator module adds libraries to manage donor perks, tracking for donor ranks and perks, configurable perks by tier, and commands to adjust character slots.. It provides comprehensive hook integration for customizing managing donator benefits and rewards and extending functionality.
DonatorAdditionalSlotsSet
đ Purpose
Called when additional character slots are set for a player.
â° When Called
After the additional slots value is set on the player.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
player |
Player | The player whose slots are being set |
value |
number | The new total number of additional slots |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Donator module adds libraries to manage donor perks, tracking for donor ranks and perks, configurable perks by tier, and commands to adjust character slots.. It provides comprehensive hook integration for customizing managing donator benefits and rewards and extending functionality.
DonatorFlagsGiven
đ Purpose
Called when donator flags are given to a player's character.
â° When Called
After flags are granted to the character via console command.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
target |
Player | The player receiving the flags |
flags |
string | The flags string being given |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Donator module adds libraries to manage donor perks, tracking for donor ranks and perks, configurable perks by tier, and commands to adjust character slots.. It provides comprehensive hook integration for customizing managing donator benefits and rewards and extending functionality.
DonatorFlagsGranted
đ Purpose
Called when donator flags are automatically granted based on user group.
â° When Called
When a character is loaded and the player's user group matches a donator group.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player receiving the flags |
group |
string | The donator group name |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Donator module adds libraries to manage donor perks, tracking for donor ranks and perks, configurable perks by tier, and commands to adjust character slots.. It provides comprehensive hook integration for customizing managing donator benefits and rewards and extending functionality.
DonatorItemGiven
đ Purpose
Called when a donator item is given to a player.
â° When Called
After an item is added to the player's inventory via console command.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
target |
Player | The player receiving the item |
uniqueID |
string | The unique ID of the item being given |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Donator module adds libraries to manage donor perks, tracking for donor ranks and perks, configurable perks by tier, and commands to adjust character slots.. It provides comprehensive hook integration for customizing managing donator benefits and rewards and extending functionality.
DonatorMoneyGiven
đ Purpose
Called when donator money is given to a player.
â° When Called
After money is added to the character via console command.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
target |
Player | The player receiving the money |
amount |
number | The amount of money being given |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Donator module adds libraries to manage donor perks, tracking for donor ranks and perks, configurable perks by tier, and commands to adjust character slots.. It provides comprehensive hook integration for customizing managing donator benefits and rewards and extending functionality.
DonatorSlotsAdded
đ Purpose
Called when override character slots are added to a player.
â° When Called
After the override slots count is increased.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
player |
Player | The player receiving slots |
current |
number | The new current total of override slots |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Donator module adds libraries to manage donor perks, tracking for donor ranks and perks, configurable perks by tier, and commands to adjust character slots.. It provides comprehensive hook integration for customizing managing donator benefits and rewards and extending functionality.
DonatorSlotsSet
đ Purpose
Called when override character slots are set for a player.
â° When Called
After the override slots value is set.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
player |
Player | The player whose slots are being set |
value |
number | The new override slots value |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Donator module adds libraries to manage donor perks, tracking for donor ranks and perks, configurable perks by tier, and commands to adjust character slots.. It provides comprehensive hook integration for customizing managing donator benefits and rewards and extending functionality.
DonatorSlotsSubtracted
đ Purpose
Called when override character slots are subtracted from a player.
â° When Called
After the override slots count is decreased.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
player |
Player | The player losing slots |
current |
number | The new current total of override slots |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Donator module adds libraries to manage donor perks, tracking for donor ranks and perks, configurable perks by tier, and commands to adjust character slots.. It provides comprehensive hook integration for customizing managing donator benefits and rewards and extending functionality.
DonatorSpawn
đ Purpose
Called when a donator player spawns with override character slots.
â° When Called
When a player spawns and has override slots configured.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The donator player spawning |
currentSlots |
number | The current number of override slots |
âŠī¸ Returns
nil
đ Realm
Server