All resources

rsg-lumberjack — Developer Docs#

Version 3.3.0. No ox_lib dependency — uses rsg-core and rsg-target only.

Dependencies#

rsg-core, rsg-target, rsg-inventory, oxmysql.

Framework functions used#

PurposeCall
Locales@rsg-core/shared/locale.lua + locale('key', ...) (language from setr rsg:locale <lang>)
Client notifyRSGCore.Functions.Notify({ title, description, type, duration })
Server notifyTriggerClientEvent('RSGCore:Client:Notify', src, data)
Progress barsRSGCore.Functions.ProgressBar({ duration, label, canCancel, disable, anim, prop })
Anim loadingRSGCore.Functions.RequestAnimDict / RequestAnimSet
Text UI (sell zone)exports['rsg-core']:DrawText(text, 'left') / HideText()
Targetingexports['rsg-target']:addModel / addLocalEntity / removeLocalEntity
CallbacksRSGCore.Functions.CreateCallback('rsg-lumberjack:server:requestChop', ...)

Server events (client → server)#

EventArgsNotes
rsg-lumberjack:server:requestSync—Rate-limited full state sync
rsg-lumberjack:server:cancelChop—Clears pending chop
rsg-lumberjack:server:completeChopkind, targetIdRe-validated against pending action + elapsed time
rsg-lumberjack:server:dropLog—Position from server ped
rsg-lumberjack:server:pickupLoglogId
rsg-lumberjack:server:pickupWoodwoodIdClaimed before reward
rsg-lumberjack:server:plantTreepos, headingRange-checked
rsg-lumberjack:server:waterTreeid
rsg-lumberjack:server:addLogToWagonwagonNetId
rsg-lumberjack:server:removeLogFromWagonwagonNetId
rsg-lumberjack:server:sellWagonLoad—Wagon/price resolved server-side

Callback#

rsg-lumberjack:server:requestChop(kind, targetId) → { ok, duration, reason, args }.

Database#

rsg_lumberjack_trees — auto-created on start; install/database.sql for manual install.

Config#

See shared/config.lua: Chopping, Planting, Items, Models, Carry, Wagon, WagonSellLocations, Trees.

Changelog#

  • 3.3.0 — Optional rsg-skills integration (Config.Skills): lumberjack XP and extra_yield perk on wood pickup.
  • 3.2.0 — Migrated off ox_lib to rsg-core (locale, notify, progress bar, anim loading, text UI); ox_target → rsg-target. Progress disable.car → disable.mount.

rsg-skills integration#

Config.Skills = { Enabled, Skill, WoodXP, ExtraYield }. In rsg-lumberjack:server:pickupWood, after the piece is claimed and added, the server calls AddXP(src, 'lumberjack', WoodXP, ...). When ExtraYield is on, it rolls math.random(100) <= GetPerk(src, 'lumberjack', 'extra_yield') and adds one more piece when CanAddItem allows it. Everything runs on the server; skipped when rsg-skills is not started.

<!-- BEGIN AUTO-REFERENCE (generated from the code; re-run the generator instead of editing by hand) -->

Technical reference#

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

Dependencies#

rsg-core, rsg-target, rsg-inventory, oxmysql

Database#

Tables: rsg_lumberjack_trees.

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 install/database.sql once.

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

Configuration#

OptionDefaultNotes
Config.AutoDatabasetruebuild the database tables automatically on start (set false and import the SQL file for a manual install)
Config.DebugfalseDebug Settings
Config.Choppingtable============================================================================
Config.RequireAxetrue
Config.AxeItem'axe'
Config.AxeBreakChance10
Config.TreeChopDuration7000
Config.LogChopDuration5000
Config.ChopCooldownMs10000
Config.InteractDistance1.5
Config.ServerDistance4.0
Config.RaycastDistance3.0
Config.ActionTimeoutMs20000
Config.Plantingtable============================================================================
Config.SeedItem'tree_seeds'
Config.WaterItem'fullbucket'
Config.RequireWatertrue
Config.MaxTreesPerPlayer10
Config.MinPlantDistance3.0
Config.PlantDuration5000
Config.WaterDuration8000
Config.RenderDistance40.0
Config.ProgressBarDistance12.0
Config.GrowthTickSeconds10
Config.GrowthDurationstable
Config.StageModelstable
Config.Itemstable============================================================================
Config.Wood'resource_wood'
Config.WoodAmountFromLog4
Config.SpawnRadius3.0
Config.GroundDespawnMinutes30
Config.Modelstable
Config.GroundLogp_cedar_log_06x
Config.WoodPropp_cs_woodpile01x
Config.CarryLogp_cedar_log_06x
Config.CarrytableCarry settings
Config.AnimDict'amb_wander@code_human_hay_bale_wander@male_a@base'
Config.AnimClip'base'
Config.AnimFlag25
Config.MoveClipset''
Config.AttachBoxtable
Config.Wagontable============================================================================
Config.ModelLOGWAGON
Config.MaxLogsOnWagon5
Config.LogStackModelp_cedar_log_06x
Config.LoadDistance4.0
Config.LogPositionstable
Config.WagonSellLocationstable============================================================================
Config.Treestable============================================================================
Config.Skillstablersg-skills integration (optional). Needs the rsg-skills resource; does nothing when it is not started.
Config.Enabledtrue
Config.Skill'lumberjack'
Config.WoodXP5
Config.ExtraYieldtrue

Callbacks#

CallbackSideArgumentsFile
rsg-lumberjack:server:requestChopserversource, cb, kind, targetIdserver/main.lua
-- client side
RSGCore.Functions.TriggerCallback('rsg-lumberjack:server:requestChop', function(result)
    -- use result
end, kind, targetId)

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
RSGCore:Client:OnPlayerLoadedclient``client/main.lua
RSGCore:Client:OnPlayerUnloadclient``client/main.lua
rsg-lumberjack:client:startCarryingclient``client/main.lua
rsg-lumberjack:client:stopCarryingclient``client/main.lua
rsg-lumberjack:client:syncGroundLogsclientlogsclient/main.lua
rsg-lumberjack:client:addGroundLogclient``client/main.lua
rsg-lumberjack:client:removeGroundLogclient``client/main.lua
rsg-lumberjack:client:syncWoodPiecesclientwoodsclient/main.lua
rsg-lumberjack:client:addWoodPiececlient``client/main.lua
rsg-lumberjack:client:removeWoodPiececlient``client/main.lua
rsg-lumberjack:client:useSeedclient``client/main.lua
rsg-lumberjack:client:useWaterclient``client/main.lua
rsg-lumberjack:client:updateTreeVisualclienttreeclient/main.lua
rsg-lumberjack:client:setTreesclientlistclient/main.lua
rsg-lumberjack:client:removeTreeclientidclient/main.lua
rsg-lumberjack:server:requestSyncserver``server/main.lua
rsg-lumberjack:server:cancelChopserver``server/main.lua
rsg-lumberjack:server:completeChopserverkind, targetIdserver/main.lua
rsg-lumberjack:server:dropLogserver``server/main.lua
rsg-lumberjack:server:pickupLogserverlogIdserver/main.lua
rsg-lumberjack:server:pickupWoodserverwoodIdserver/main.lua
rsg-lumberjack:server:plantTreeserverpos, headingserver/main.lua
rsg-lumberjack:server:waterTreeserveridserver/main.lua
rsg-lumberjack:server:addLogToWagonserverwagonNetIdserver/main.lua
rsg-lumberjack:server:removeLogFromWagonserverwagonNetIdserver/main.lua
rsg-lumberjack:server:sellWagonLoadserver``server/main.lua
-- from a client script
TriggerServerEvent('rsg-lumberjack:server:requestSync')
-- from a server script
TriggerClientEvent('RSGCore:Client:OnPlayerLoaded', source)

Commands#

CommandNotesFile
/spawnwagonclient/main.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 -->