Hooks
Hooks provided by the Extended Descriptions module for managing detailed character descriptions.
Overview
The Extended Descriptions module adds support for long item descriptions, localization for multiple languages, better rp text display, automatic line wrapping, and fallback to short descriptions.. It provides comprehensive hook integration for customizing managing detailed character descriptions and extending functionality.
ExtendedDescriptionClosed
đ Purpose
Called when the extended description viewing panel is closed.
â° When Called
When the description frame is removed on the client.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
ply |
Player | The player whose description was being viewed |
descText |
string | The description text that was displayed |
descURL |
string | The description image URL that was displayed |
âŠī¸ Returns
nil
đ Realm
Client
Overview
The Extended Descriptions module adds support for long item descriptions, localization for multiple languages, better rp text display, automatic line wrapping, and fallback to short descriptions.. It provides comprehensive hook integration for customizing managing detailed character descriptions and extending functionality.
ExtendedDescriptionEditClosed
đ Purpose
Called when the extended description edit panel is closed.
â° When Called
When the edit frame is removed on the client.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
steamName |
string | The Steam name of the player editing the description |
âŠī¸ Returns
nil
đ Realm
Client
Overview
The Extended Descriptions module adds support for long item descriptions, localization for multiple languages, better rp text display, automatic line wrapping, and fallback to short descriptions.. It provides comprehensive hook integration for customizing managing detailed character descriptions and extending functionality.
ExtendedDescriptionEditOpened
đ Purpose
Called when the extended description edit panel is opened.
â° When Called
When the edit frame is created and displayed on the client.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
frame |
Panel | The edit frame panel |
steamName |
string | The Steam name of the player editing |
âŠī¸ Returns
nil
đ Realm
Client
Overview
The Extended Descriptions module adds support for long item descriptions, localization for multiple languages, better rp text display, automatic line wrapping, and fallback to short descriptions.. It provides comprehensive hook integration for customizing managing detailed character descriptions and extending functionality.
ExtendedDescriptionEditSubmitted
đ Purpose
Called when an extended description edit is submitted.
â° When Called
When the player clicks the submit button to save changes.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
steamName |
string | The Steam name of the player submitting |
url |
string | The image URL entered |
text |
string | The description text entered |
âŠī¸ Returns
nil
đ Realm
Client
Overview
The Extended Descriptions module adds support for long item descriptions, localization for multiple languages, better rp text display, automatic line wrapping, and fallback to short descriptions.. It provides comprehensive hook integration for customizing managing detailed character descriptions and extending functionality.
ExtendedDescriptionOpened
đ Purpose
Called when the extended description viewing panel is opened.
â° When Called
When the description frame is created and displayed on the client.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
ply |
Player | The player whose description is being viewed |
frame |
Panel | The description frame panel |
descText |
string | The description text being displayed |
descURL |
string | The description image URL being displayed |
âŠī¸ Returns
nil
đ Realm
Client
Overview
The Extended Descriptions module adds support for long item descriptions, localization for multiple languages, better rp text display, automatic line wrapping, and fallback to short descriptions.. It provides comprehensive hook integration for customizing managing detailed character descriptions and extending functionality.
ExtendedDescriptionUpdated
đ Purpose
Called after an extended description has been updated on the server.
â° When Called
After the character's description data is saved.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player whose description was updated |
url |
string | The new image URL |
text |
string | The new description text |
âŠī¸ Returns
nil
đ Realm
Server
Overview
The Extended Descriptions module adds support for long item descriptions, localization for multiple languages, better rp text display, automatic line wrapping, and fallback to short descriptions.. It provides comprehensive hook integration for customizing managing detailed character descriptions and extending functionality.
PreExtendedDescriptionUpdate
đ Purpose
Called before an extended description is updated on the server.
â° When Called
Before the character's description data is saved.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player whose description is being updated |
url |
string | The new image URL to be set |
text |
string | The new description text to be set |
âŠī¸ Returns
nil
đ Realm
Server