All resources

rsg-bathing – Docs (v3.0.0)#

Contents#

  1. Files
  2. How it works
  3. Configuration
  4. Exports and events
  5. Security
  6. Server owner how-tos
  7. Troubleshooting

1. Files#

FilePurpose
fxmanifest.luaManifest; depends on rsg-core, rsg-wardrobe
config.luaPrices, effects, speech, rewards, bathing zones, prompts
client/client.luaPrompts, anim scenes, camera, effects, speech
client/structs.jsNative struct helper
server/server.luaPayment, sessions, undress/redress, cleanliness
server/versionchecker.luaGitHub version check
locales/*.jsonen, de, el, es, fr, ja, nl, pl, pt-br, ro, ru

2. How it works#

  • Bathhouses: Saint Denis, Valentine, Annesburg, Strawberry, Blackwater, Van Horn, Rhodes and Tumbleweed (own Pbl_Regular_Outro).
  • Walk to the tub for the bath prompt. A standard bath scrubs yourself with the RDR2 bathing animations; a deluxe bath adds an NPC attendant.
  • Tub steam and per-part soap foam effects, attendant voice lines and player sighs.
  • On exit: health/stamina cores refilled and stress cleared (deluxe also fortifies cores), dirt, blood, decals and wetness cleared, cleanliness metadata set to 100 server-side.
  • The player is invincible while bathing. Clothes come off and back on through rsg-wardrobe.
  • One player per tub and one bath per player. Sessions free on exit, disconnect or resource stop.

3. Configuration#

config.lua:

OptionDefaultMeaning
NormalBathPrice1Cash, standard bath
DeluxeBathPrice5Cash, deluxe bath
InteractDistance1.0Client prompt range
ServerMaxDistance3.0Server max distance when paying
ShowBlipstrueMap blips
Effectstablesteam, foam
Speechtableenabled, chatInterval (ms)
Rewardstableregular / deluxe: refillCores, fortify, clearStress
BathingZonestablePer town: dict, rag, consumer, lady, guy, maidVoice, door
BathingModes, PromptstablesModes and prompt labels

4. Exports and events#

NameSideNotes
IsBathingActive()client exportTrue while bathing
rsg-bathing:client:StartBathclient event(town)
rsg-bathing:client:StartDeluxeBathclient event(town)
rsg-bathing:client:ToggleInvincibilityclient event(state)
rsg-bathing:client:RestorePrompts / HideDeluxePromptclient eventsPrompt state
rsg-bathing:server:canEnterBathserver event(town); checks money, distance, tub free
rsg-bathing:server:canEnterDeluxeBathserver eventDeluxe once per session
rsg-bathing:server:setBathAsFreeserver eventReleases the tub
rsg-bathing:server:undressPlayer / dressPlayerserver eventsOnly in an active session

5. Security#

Payments are server-authorised (the RemoveMoney result is checked) with per-player rate limiting. Every paid request checks distance on the server. Deluxe can only be bought once per session. Undress/redress is only allowed during an active session.

6. How-tos#

  • Change prices: edit NormalBathPrice and DeluxeBathPrice.
  • Make deluxe stronger: raise Rewards.deluxe.fortify.
  • Optional: rsg-hud updates the cleanliness display.

7. Troubleshooting#

ProblemFix
No promptStand at the tub within InteractDistance; check the tub isn't in use
Player stays undressedCheck rsg-wardrobe is running; restart the resource
No steam/foamCheck Effects
Bath refusedNot enough cash, or too far from the tub

Support the Project : https://rexshack.tebex.store/

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

Technical reference#

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

Dependencies#

rsg-core, rsg-wardrobe

Configuration#

OptionDefaultNotes
Config.NormalBathPrice1cash, standard bath
Config.DeluxeBathPrice5cash, assisted (deluxe) bath
Config.InteractDistance1.0client: how close to the tub to see the prompt
Config.ServerMaxDistance3.0server: max distance allowed when paying
Config.ShowBlipstrue
Config.EffectstableEffects taken from the RDR2 bathing script (ptfx asset scr_mg_bathing)
Config.SpeechtableAttendant / player voice lines during the bath
Config.RewardstableHealth / stamina cores when leaving the bath
Config.BathingZonestable
Config.BathingModestable
Config.Promptstable

Exports#

Client

ExportArgumentsFile
IsBathingActive``client/client.lua
-- example
local result = exports['rsg-bathing']:IsBathingActive()

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-bathing:client:ToggleInvincibilityclientstateclient/client.lua
rsg-bathing:client:StartDeluxeBathclienttownclient/client.lua
rsg-bathing:client:RestorePromptsclient``client/client.lua
rsg-bathing:client:HideDeluxePromptclient``client/client.lua
rsg-bathing:client:StartBathclienttownclient/client.lua
rsg-bathing:server:canEnterBathservertownserver/server.lua
rsg-bathing:server:canEnterDeluxeBathserver``server/server.lua
rsg-bathing:server:setBathAsFreeserver``server/server.lua
rsg-bathing:server:undressPlayerserver``server/server.lua
rsg-bathing:server:dressPlayerserver``server/server.lua
-- from a client script
TriggerServerEvent('rsg-bathing:server:canEnterBath', town)
-- from a server script
TriggerClientEvent('rsg-bathing:client:ToggleInvincibility', source, state)

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 -->