Source:Documentation Index
Fetch the complete documentation index at: https://docs.apex-services.site/llms.txt
Use this file to discover all available pages before exploring further.
apex-fishing/hooks.lua (unencrypted).
Client hooks
Hooks.ShowHelpPrompt(key, text)
Hooks.ShowHelpPrompt(key, text)
Default
lib.showTextUI.Hooks.HideHelpPrompt(key)
Hooks.HideHelpPrompt(key)
Default
lib.hideTextUI.Hooks.ClientAlert(title, message, duration, alertType)
Hooks.ClientAlert(title, message, duration, alertType)
Default
lib.notify. alertType ∈ success | error | info | warning.Hooks.IsPlayerCarryingOrBeingCarried()
Hooks.IsPlayerCarryingOrBeingCarried()
Return true to suppress fishing. Wire into your carry/kidnap resource.
Hooks.OpenFishmarket()
Hooks.OpenFishmarket()
Default
TriggerEvent('apex-fishing:openFishmarket'). Wire into your sell UI.Server hooks
Hooks.GetPlayerLevel(source)
Hooks.GetPlayerLevel(source)
Default returns
1. Wire into your progression / fishmarket level system.Hooks.HasFishingBoost(xPlayer)
Hooks.HasFishingBoost(xPlayer)
Default delegates to
xPlayer.hasFishingBoost() if present, otherwise false.Hooks.AddFishingBoost(xPlayer, durationSeconds)
Hooks.AddFishingBoost(xPlayer, durationSeconds)
Default delegates to
xPlayer.addFishingBoost(durationSeconds).Hooks.GetFishingBoostLeftInSeconds(xPlayer)
Hooks.GetFishingBoostLeftInSeconds(xPlayer)
Default delegates to
xPlayer.getFishingBoostLeftInSeconds().Hooks.BanPlayer(source, reason)
Hooks.BanPlayer(source, reason)
Default prints a warning. Wire into your anti-cheat.
Hooks.OnCatch(source, fishItem, fishCount, isIllegal)
Hooks.OnCatch(source, fishItem, fishCount, isIllegal)
Called after a successful catch. Wire into your quest / progression system.
Hooks.IsPlayerOnline(source)
Hooks.IsPlayerOnline(source)
Default
GetPlayerName(source) ~= nil.Hooks.CanCarryItem / AddInventoryItem / RemoveInventoryItem / HasItem
Hooks.CanCarryItem / AddInventoryItem / RemoveInventoryItem / HasItem
ox_inventory bridge — defaults delegate to
xPlayer methods.