Hunting

Exports

All client- & serversided exports included within this script. Exports provide callable functions that allow other resources to interact with this script's functionality.

If additional exports are required for your implementation, please submit a formal request through our ticketing system on the official Discord server.

Server Exports

GiveHuntingLicense

Gives a hunting license to a player.

exports['RxHunting']:GiveHuntingLicense(playerId)

playerId

number required

Source of the player that should receive the hunting license.

RemoveHuntingLicense

Removes a hunting license from a player.

exports['RxHunting']:RemoveHuntingLicense(playerId)

playerId

number required

Source of the player where the hunting license should be removed.

HasHuntingLicense

Checks if a player has a hunting license.

exports['RxHunting']:HasHuntingLicense(playerId)

playerId

number required

Source of the player to check for hunting license.

GetHunterLevel

Returns hunter level from a player.

exports['RxHunting']:GetHunterLevel(playerId)

playerId

number required

Source of the player to get the hunter level from.

GetHunterXp

Returns hunter xp from a player.

exports['RxHunting']:GetHunterXp(playerId)

playerId

number required

Source of the player to get the hunter xp from.

SetHunterLevel

Sets the hunter level for a player directly.

exports['RxHunting']:SetHunterLevel(playerId, level)

playerId

number required

Source of the player to set the hunter level for.

level

number required

The level to set for the hunter.

SetHunterXP

Sets the hunter XP for a player directly.

exports['RxHunting']:SetHunterXP(playerId, xp)

playerId

number required

Source of the player to set the hunter XP for.

number required

The XP amount to set for the hunter.

AddHunterXP

Adds XP to a hunter.

exports['RxHunting']:AddHunterXP(playerId, xp)

playerId

number required

Source of the player to add XP to.

number required

The amount of XP to add.

GetHunterData

Returns the full hunter data object for a player.

exports['RxHunting']:GetHunterData(playerId)

playerId

number required

Source of the player to get hunter data from.

Returns a table containing: level, xp, license, kills, cuts, missions, name or false if player not found.

GetHunterKills

Returns the total number of animal kills for a hunter.

exports['RxHunting']:GetHunterKills(playerId)

playerId

number required

Source of the player to get kill count from.

GetHunterCuts

Returns the total number of animal cuts for a hunter.

exports['RxHunting']:GetHunterCuts(playerId)

playerId

number required

Source of the player to get cut count from.

GetAllHunters

Returns a table containing all hunters data.

exports['RxHunting']:GetAllHunters()

IsPlayerInZone

Checks if a player is currently inside any hunting zone.

exports['RxHunting']:IsPlayerInZone(playerId)

playerId

number required

Source of the player to check zone status for.

GetPlayerZone

Returns the name of the hunting zone a player is currently in.

exports['RxHunting']:GetPlayerZone(playerId)

playerId

number required

Source of the player to get zone name from.

Returns the zone name as a string or nil if player is not in any zone.

GetAnimals

Returns a table containing all currently spawned animals.

exports['RxHunting']:GetAnimals()

GetBaits

Returns a table containing all currently placed baits.

exports['RxHunting']:GetBaits()

Client Exports

No client-sided exports available at this time.

Installation

Full installation guide to get this script up & running in no time.

Events

All client- & serversided events included within this script. Events serve as listeners that capture and respond to actions executed by this script.