Exports

🧩

Developer API

Open, query and control the guidebook from your own scripts via client/server exports and server events.

OpenGuidebook OpenGuidebookPage OpenGuidebookCategory CloseGuidebook IsGuidebookUIOpen NavigateToPoint ServerExports

Client Exports

OpenGuidebook

Opens the guidebook UI.


exports['mizu_guidebook']:OpenGuidebook()

OpenGuidebookPage

Opens the guidebook on a specific page.


exports['mizu_guidebook']:OpenGuidebookPage('server_rules')

OpenGuidebookCategory

Opens the guidebook filtered to a category.


exports['mizu_guidebook']:OpenGuidebookCategory('jobs')

CloseGuidebook

Closes the guidebook UI if it is open.


exports['mizu_guidebook']:CloseGuidebook()

IsGuidebookUIOpen

Returns a boolean indicating whether the UI is currently open.


local isOpen = exports['mizu_guidebook']:IsGuidebookUIOpen()

NavigateToPoint

Sets a GPS waypoint to a help point by its key (if the point allows navigation). Returns a boolean.


local ok = exports['mizu_guidebook']:NavigateToPoint('city_hall')

ℹ️

Resource Name

All exports are keyed by the resource name mizu_guidebook. If you renamed the folder, the exports will not resolve.

Server Exports

Export	Parameters	Returns	Description
`OpenGuidebook(playerId)`	`playerId: number`	-	Open the guidebook for a player
`OpenSpecificPage(playerId, pageKey)`	`playerId: number, pageKey: string`	-	Open a specific page for a player
`GetCategories()`	-	`table[]`	Get all categories
`GetPages()`	-	`table[]`	Get all pages
`GetPoints()`	-	`table[]`	Get all help points
`GetCategoryByKey(key)`	`key: string`	`table/nil`	Get a single category
`GetPageByKey(key)`	`key: string`	`table/nil`	Get a single page
`GetPointByKey(key)`	`key: string`	`table/nil`	Get a single point


-- Open the rules page for a player after they spawn
exports['mizu_guidebook']:OpenSpecificPage(source, 'server_rules')
 
-- Read all pages server-side
local pages = exports['mizu_guidebook']:GetPages()

💡

Notes

Server exports/events run job and permission filters automatically, so a player without access to a restricted page will not see it. The Get* exports return raw data tables suitable for building your own integrations.