Skip to content

Commit 783e18f

Browse files
MrNewbMrNewb
committed
docs: add GetResourceName & API docs for modules
Add GetResourceName documentation to multiple Community Bridge module pages and expand several module APIs. Updated modules: Banking, BossMenu (client/server), Clothing (client/server), Dialogue (client), Dispatch (client/server), Doorlock (client/server), Fuel (client), HelpText (client/server), Housing (client), Input (client), Inventory (client/server), Menu (client), Notify (client/server), Phone (client/server) (also added GetPhoneName), ProgressBar (client), Shops (client/server), Skills (server), Target (client), VehicleKey (client), Weather (client), Zones (client), and Framework (server). Notable changes: - Added a standard GetResourceName() doc for many modules (returns "default"). - Phone: added GetPhoneName() to report configured phone system. - Framework (server): clarified GetResourceName description and added job count helpers (AddJobCount, SearchJobCountBySource, RemoveJobCount) with examples. - Skills (server): updated function signatures and return values for Create, AddXP, SetSkillLevel, SetXP, GetScaledXP; added examples, return descriptions, and algorithm notes. - Target (client): added extensive internal utility docs (GetCanInteract, CreateCanInteract, CanInteract, FixOptions) and examples for advanced usage. These documentation updates improve discoverability and clarify function behavior/returns for developers integrating with Community Bridge modules.
1 parent f80ddb3 commit 783e18f

31 files changed

Lines changed: 640 additions & 17 deletions

File tree

‎pages/community-bridge/modules/banking/server.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@ The Banking module provides server-side bank account management.
33

44
## Server Functions
55

6+
### GetResourceName
7+
8+
Returns the banking resource name.
9+
10+
```lua
11+
local name = Bridge.Banking.GetResourceName()
12+
-- Returns: string (always "default")
13+
```
14+
15+
**Description:**
16+
Returns the name of the Banking module resource. Used for internal identification. Always returns `"default"` for the built-in Banking module.
17+
618
### GetAccountMoney
719

820
Returns the balance of a specific bank account.

‎pages/community-bridge/modules/bossmenu/client.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Boss Menu — Client
22

3+
## GetResourceName
4+
5+
Returns the boss menu resource name.
6+
7+
```lua
8+
local name = Bridge.BossMenu.GetResourceName()
9+
-- Returns: string (always "default")
10+
```
11+
12+
**Description:**
13+
Returns the name of the Boss Menu module resource. Used for internal identification. Always returns `"default"` for the built-in Boss Menu module.
14+
315
## OpenBossMenu
416

517
Opens the boss menu for the local player's current job.

‎pages/community-bridge/modules/bossmenu/server.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Boss Menu — Server
22

3+
## GetResourceName
4+
5+
Returns the boss menu resource name.
6+
7+
```lua
8+
local name = Bridge.BossMenu.GetResourceName()
9+
-- Returns: string (always "default")
10+
```
11+
12+
**Description:**
13+
Returns the name of the Boss Menu module resource. Used for internal identification. Always returns `"default"` for the built-in Boss Menu module.
14+
315
## OpenBossMenu
416

517
Opens a boss menu for a specific player and job.

‎pages/community-bridge/modules/clothing/client.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Clothing — Client
22

3+
## GetResourceName
4+
5+
Returns the clothing resource name.
6+
7+
```lua
8+
local name = Bridge.Clothing.GetResourceName()
9+
-- Returns: string (always "default")
10+
```
11+
12+
**Description:**
13+
Returns the name of the Clothing module resource. Used for internal identification. Always returns `"default"` for the built-in Clothing module.
14+
315
## OpenMenu
416

517
Opens the clothing/appearance customization menu.

‎pages/community-bridge/modules/clothing/server.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Clothing — Server
22

3+
## GetResourceName
4+
5+
Returns the clothing resource name.
6+
7+
```lua
8+
local name = Bridge.Clothing.GetResourceName()
9+
-- Returns: string (always "default")
10+
```
11+
12+
**Description:**
13+
Returns the name of the Clothing module resource. Used for internal identification. Always returns `"default"` for the built-in Clothing module.
14+
315
## IsMale
416

517
Returns whether a player's character is male.

‎pages/community-bridge/modules/dialogue/client.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@ The Dialogue module provides a client-side NPC dialogue system with branching co
33

44
## Client Functions
55

6+
### GetResourceName
7+
8+
Returns the dialogue resource name.
9+
10+
```lua
11+
local name = Bridge.Dialogue.GetResourceName()
12+
-- Returns: string (always "default")
13+
```
14+
15+
**Description:**
16+
Returns the name of the Dialogue module resource. Used for internal identification. Always returns `"default"` for the built-in Dialogue module.
17+
618
### Open
719

820
Opens a dialogue with an NPC or character.

‎pages/community-bridge/modules/dispatch/client.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Dispatch — Client
22

3+
## GetResourceName
4+
5+
Returns the dispatch resource name.
6+
7+
```lua
8+
local name = Bridge.Dispatch.GetResourceName()
9+
-- Returns: string (always "default")
10+
```
11+
12+
**Description:**
13+
Returns the name of the Dispatch module resource. Used for internal identification. Always returns `"default"` for the built-in Dispatch module.
14+
315
## SendAlert
416

517
Sends a dispatch alert from the client.

‎pages/community-bridge/modules/dispatch/server.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Dispatch — Server
22

3+
## GetResourceName
4+
5+
Returns the dispatch resource name.
6+
7+
```lua
8+
local name = Bridge.Dispatch.GetResourceName()
9+
-- Returns: string (always "default")
10+
```
11+
12+
**Description:**
13+
Returns the name of the Dispatch module resource. Used for internal identification. Always returns `"default"` for the built-in Dispatch module.
14+
315
## SendAlert
416

517
Sends a dispatch alert from the server.

‎pages/community-bridge/modules/doorlock/client.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Doorlock — Client
22

3+
## GetResourceName
4+
5+
Returns the doorlock resource name.
6+
7+
```lua
8+
local name = Bridge.Doorlock.GetResourceName()
9+
-- Returns: string (always "default")
10+
```
11+
12+
**Description:**
13+
Returns the name of the Doorlock module resource. Used for internal identification. Always returns `"default"` for the built-in Doorlock module.
14+
315
## GetClosestDoor
416

517
Returns the closest door to the player.

‎pages/community-bridge/modules/doorlock/server.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Doorlock — Server
22

3+
## GetResourceName
4+
5+
Returns the doorlock resource name.
6+
7+
```lua
8+
local name = Bridge.Doorlock.GetResourceName()
9+
-- Returns: string (always "default")
10+
```
11+
12+
**Description:**
13+
Returns the name of the Doorlock module resource. Used for internal identification. Always returns `"default"` for the built-in Doorlock module.
14+
315
## ToggleDoorLock
416

517
Toggles a door's lock state.

0 commit comments

Comments
 (0)