Hooks
Hooks provided by the Model Pay module for managing salary payments based on player models.
Overview
The Model Pay module adds payment to characters based on model, custom wage definitions, integration into the economy, config to exclude certain models, and logs of wages issued.. It provides comprehensive hook integration for customizing managing salary payments based on player models and extending functionality.
CreateSalaryTimer
đ Purpose
Called when a salary timer should be created for a player with an eligible model.
â° When Called
When a player's model changes to an eligible model.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player whose salary timer should be created |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Model Pay module adds payment to characters based on model, custom wage definitions, integration into the economy, config to exclude certain models, and logs of wages issued.. It provides comprehensive hook integration for customizing managing salary payments based on player models and extending functionality.
ModelPayModelChecked
đ Purpose
Called when a player's model is checked for salary eligibility.
â° When Called
During salary amount calculation, before model matching.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player whose model is being checked |
playerModel |
string | The lowercase model path |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Model Pay module adds payment to characters based on model, custom wage definitions, integration into the economy, config to exclude certain models, and logs of wages issued.. It provides comprehensive hook integration for customizing managing salary payments based on player models and extending functionality.
ModelPayModelEligible
đ Purpose
Called when a player's model matches an eligible model for salary.
â° When Called
When a player's model changes to a model that has salary configured.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player with the eligible model |
newModel |
string | The model path that is eligible |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Model Pay module adds payment to characters based on model, custom wage definitions, integration into the economy, config to exclude certain models, and logs of wages issued.. It provides comprehensive hook integration for customizing managing salary payments based on player models and extending functionality.
ModelPayModelIneligible
đ Purpose
Called when a player's model does not match any eligible models.
â° When Called
When a player's model changes to a model that has no salary configured.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player with the ineligible model |
newModel |
string | The model path that is ineligible |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Model Pay module adds payment to characters based on model, custom wage definitions, integration into the economy, config to exclude certain models, and logs of wages issued.. It provides comprehensive hook integration for customizing managing salary payments based on player models and extending functionality.
ModelPayModelMatched
đ Purpose
Called when a player's model matches a salary model.
â° When Called
During salary calculation when a model match is found.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player whose model matched |
model |
string | The model that matched |
pay |
number | The salary amount for this model |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Model Pay module adds payment to characters based on model, custom wage definitions, integration into the economy, config to exclude certain models, and logs of wages issued.. It provides comprehensive hook integration for customizing managing salary payments based on player models and extending functionality.
ModelPayModelNotMatched
đ Purpose
Called when a player's model does not match any salary models.
â° When Called
During salary calculation when no model match is found.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player whose model did not match |
playerModel |
string | The model path that was checked |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Model Pay module adds payment to characters based on model, custom wage definitions, integration into the economy, config to exclude certain models, and logs of wages issued.. It provides comprehensive hook integration for customizing managing salary payments based on player models and extending functionality.
ModelPaySalaryDetermined
đ Purpose
Called when a player's salary amount has been determined.
â° When Called
After salary calculation completes, whether a match was found or not.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player whose salary was calculated |
pay |
number | The determined salary amount (0 if no match) |
âŠī¸ Returns
nil
đ Realm
Server