All resources

rsg-huntingpets — Developer Docs#

Dependencies#

  • rsg-core (locales, notifications, core object)
  • rsg-target (pet shop NPC and dog interaction targets)
  • oxmysql

ox_lib is not used (migrated to rsg-core in 3.1.x).

Locales#

fxmanifest.lua loads @rsg-core/shared/locale.lua in shared_scripts; strings live in locales/*.json (en, de, el, es, fr, ja, nl, pl, pt-br, ro, ru) and are read with locale('key', ...). Language: setr rsg:locale "<code>" in server.cfg (falls back to ox:locale, then en). The NUI receives a resolved string bundle from client/client_shop.lua (GetUiLocale()).

Notifications#

  • Client: Notify(title, message, template, duration) in client/client_shop.lua wraps RSGCore.Functions.Notify. Templates ERROR, SUCCESS, TIP (inform), WARNING.
  • Server: TriggerClientEvent('RSGCore:Client:Notify', src, { title, description, duration, type }).

Files#

PathPurpose
client/client_shop.luaShop NUI, notify helper, locale bundle
client/npcs.luaShop NPCs + rsg-target
client/client_dogs.lua / client_birds.luaPet behaviour, prompts, hunt modes
server/server_dogs.lua / server_birds.luaBuying/selling/feeding, validation
server/database.luaAuto-creates tables (manual SQL in installation/rsg_huntingpets.sql)
shared/config_*.luaConfig
<!-- BEGIN AUTO-REFERENCE (generated from the code; re-run the generator instead of editing by hand) -->

Technical reference#

Generated from the source of rsg-huntingpets 3.1.1. Names, arguments and defaults below are read straight from the code.

Dependencies#

rsg-core, rsg-target

Database#

Tables: is, player_dogs, player_birds, player_selected_pets.

Tables are created automatically on start while Config.AutoDatabase = true (default). Nothing is ever dropped or overwritten. For a manual install set Config.AutoDatabase = false and import installation/rsg_huntingpets.sql once.

-- shared/config.lua
Config.AutoDatabase = true -- false = import the SQL file yourself

Configuration#

OptionDefaultNotes
Config.SellingBirdJob{"birdtrainer", "wapiti"}for no job: Config.SellingBirdJob = false
Config.Promptstable
Config.ConfirmDeleteValue"delete"players must type this word in order to delete a bird from owned birds
Config.Textstable
Config.MaxBirdXP1000
Config.Huntingtable
Config.BirdGoForHuntTimer20--seconds - when the bird is flying away to hunt, after the timer ru
Config.HuntingTimer20--seconds - after the deletion, this timer starts and once its compl
Config.ParrotTalkingXPReq1required XP for parrot's talking ability
Config.ScavengerItemstable
Config.FishItemstable
Config.BirdShopstable
Config.BirdOfPreys{--for hunting
Config.Scavengers{--for scavenging
Config.FishingBirds{--for fishing
Config.Birdstable
Config.BirdAttach{--Options for attaching bird to player's ped
Config.Texturestable
Config.Areastable===========================================================--
Config.Districtstable===========================================================--
Config.Districts2table===========================================================--
Config.AudioBanktableMORE AUDIO BANKS: https://www.rdr2mods.com/wiki/speech/
Config.DogKeyBind'E'
Config.DogTrackingJob"leo"
Config.CallDogKeytrue
Config.DogTriggerKeystable
Config.AttackCommandtrueAttack command: send your dog to attack a locked-on target
Config.AttackOnlyPlayerstrue
Config.AttackOnlyAnimalstrue
Config.AttackOnlyNPCtrue
Config.TrackCommandtrueTrack command: send your dog to follow a locked-on target
Config.TrackOnlyPlayerstrue
Config.TrackOnlyAnimalstrue
Config.TrackOnlyNPCtrue
Config.DefensiveModetruePets hostile to anything you are in combat with
Config.NoFeartruePrevents horses from fearing your pet
Config.DogSearchRadius50.0How far the dog searches for hunted animals
Config.DogFeedInterval18001800 = 30 min, seconds between feeds
Config.RaiseAnimaltrueFeed to gain XP and grow
Config.DogFullGrownXp1000XP to be fully grown
Config.DogXpPerFeed20XP gained per feed
Config.NotifyWhenHungrytrue
Config.DogPetSearchDatabasetrue
Config.DogAllowedSearchTables{'player_outlawbench', 'player_cocainedry', 'player_cannabisdry', 'can
Config.DogPetAttributestable
Config.Dogstable
Config.DogRetrievableAnimalstable
Config.DogKeystable
Config.AutoDatabasetruebuild the database tables automatically on start (set false and import installation/rsg_huntingpets.sql for a
Config.Debugfalse
Config.FadeIntrue
Config.DistanceSpawn20.0
Config.AnimalFood'raw_meat'Food item for both dogs and birds
Config.AlwaysOpentrueif false, configure open/close times
Config.OpenTime8store opens
Config.CloseTime20store closes
Config.Bliptable
Config.Shopstable
Config.Checkpointstable

Callbacks#

CallbackSideArgumentsFile
rsg-huntingpets:server:getShopDataserversource, cbserver/server_dogs.lua
rsg-huntingpets:server:selectDogserversource, cb, dogIdserver/server_dogs.lua
rsg-huntingpets:server:selectBirdserversource, cb, birdIdserver/server_dogs.lua
rsg-huntingpets:server:getPetDataserversource, cb, petNameserver/server_dogs.lua
-- client side
RSGCore.Functions.TriggerCallback('rsg-huntingpets:server:getShopData', function(result)
    -- use result
end)

Events#

Server events can be fired by any client, so every handler re-validates the player, the arguments and any permission, distance or cooldown on the server. Never add a reward to a handler without those checks.

EventSideArgumentsFile
rsg-huntingpets:start_sellclient``client/client_birds.lua
rsg-huntingpets:client:spawnBirdclient``client/client_birds.lua
rsg-huntingpets:starthuntclient``client/client_birds.lua
rsg-huntingpets:sell:gotpoints_cclient``client/client_birds.lua
rsg-huntingpets:sell:updatepointsclient``client/client_birds.lua
rsg-huntingpets:sell:updatepoints1client``client/client_birds.lua
rsg-huntingpets:sell:finishsellclient``client/client_birds.lua
rsg-huntingpets:checktalkclient``client/client_birds.lua
rsg-huntingpets:client:dogAnimationsclient``client/client_dogs.lua
rsg-huntingpets:client:spawnDogclient``client/client_dogs.lua
rsg-huntingpets:client:putawayDogclient``client/client_dogs.lua
rsg-huntingpets:client:sellDogConfirmclient``client/client_dogs.lua
rsg-huntingpets:client:dogFedclient``client/client_dogs.lua
RSGCore:Client:OnPlayerLoadedclient``client/client_shop.lua
rsg-huntingpets:client:openShopclient``client/client_shop.lua
rsg-huntingpets:client:birdSoldclient``client/client_shop.lua
rsg-huntingpets:server:buyBirdserver``server/server_birds.lua
rsg-huntingpets:server:sellBirdserver``server/server_birds.lua
rsg-huntingpets:server:callBirdserver``server/server_birds.lua
rsg-huntingpets:server:loadBirdserver``server/server_birds.lua
rsg-huntingpets:checkhuntserver``server/server_birds.lua
rsg-huntingpets:addxpserver``server/server_birds.lua
rsg-huntingpets:addscavengeditemserver``server/server_birds.lua
rsg-huntingpets:check_sellserver``server/server_birds.lua
rsg-huntingpets:sell:createserver``server/server_birds.lua
rsg-huntingpets:sell:stopserver``server/server_birds.lua
rsg-huntingpets:sell:getpointsserver``server/server_birds.lua
rsg-huntingpets:sell:buyofferserver``server/server_birds.lua
rsg-huntingpets:server:buyDogserver``server/server_dogs.lua
rsg-huntingpets:server:sellDogserver``server/server_dogs.lua
rsg-huntingpets:server:callDogserver``server/server_dogs.lua
rsg-huntingpets:server:feedDogserver``server/server_dogs.lua
rsg-huntingpets:server:loadDogserver``server/server_dogs.lua
-- from a client script
TriggerServerEvent('rsg-huntingpets:server:buyBird')
-- from a server script
TriggerClientEvent('rsg-huntingpets:start_sell', source)

Commands#

CommandNotesFile
/callbirdclient/client_birds.lua
/fleebirdclient/client_birds.lua
/calldogclient/client_dogs.lua
/fleedogclient/client_dogs.lua

Locales#

Language files in locales/: de, el, en, es, fr, ja, nl, pl, pt-br, ro, ru. Set the language with setr rsg:locale "en".

<!-- END AUTO-REFERENCE -->