Configuration

Signal

Config.Signal, the relay poles and Config.Towns: where the book has signal, and how the separate fx-radio back radio adds to it.

All keys on this page are in config.lua.

#How signal works

The book shows 0 to 5 bars. The server works them out every time the client asks:

  1. Inside a town listed in Config.Towns: 5 bars.
  2. Otherwise the best of the relay poles in the same routing bucket. A pole gives 5 bars next to it, falling to 1 bar at the edge of its Range, and 0 beyond.
  3. With the separate fx-radio resource started, a worn back radio with a charged battery counts too. The best of the poles and the radio wins.

Apps and actions that need a connection compare the bars with ReceiveBars (receiving) or SendBars (sending). Notes and the calculator work without signal. With Config.Signal.Enabled = false the book always has 5 bars and no poles are drawn.

#Config.Signal

Setting Default What it does
Enabled true Signal rules on. false: always full signal
UpdateInterval 2000 ms between the client's signal checks while the book is open. At least 1000
IdleInterval 10000 ms between signal checks while the book is closed. Held notifications and nearby relay poles still need them. At least 2000
ReceiveBars 2 Bars needed to receive
SendBars 1 Bars needed to send

Opening the book, or walking into or out of a town, asks the server at once. With no answer for three check intervals the bars drop to 0: 6 seconds while the book is open and 30 seconds while it is closed, with the defaults. On the server a town report counts for IdleInterval × 3 ms, at least 6 seconds.

#Relay poles: Config.Signal.Pole

A player uses the relay item, sees a preview of the pole and places it. The item is used up. Poles are saved in fx_pocketbook_relays and stay after a restart. Players near a pole see its model.

Setting Default What it does
Item 'pocketbook_relay' The item that places a pole
Model 'p_pierpolenbx01x' Pole model
Range 50.0 Signal radius in metres
PlaceDistance 8.0 How far from the player a pole may be placed
StreamDistance 150.0 Players within this distance see the pole
MaxPerCharacter 3 Poles one character can have
MinSpacing 3.0 Smallest distance between two poles

There is no pick-up for players. An admin removes a pole with pocketbook_remove_relay <id>, which gives no item back.

#Config.Towns

Town zones that count as full signal. The client reads the zone it stands in and reports its name; the server gives 5 bars only for names in this table. The value is the game's zone hash.

luaConfig.Towns = {
    AguasdulcesFarm=1654810713, AguasdulcesRuins=201158410, AguasdulcesVilla=-1207133769,
    Annesburg=7359335, Armadillo=-744494798, BeechersHope=-1708386982,
    Blackwater=1053078005, Braithwaite=1778899666, Butcher=-1947415645,
    Caliga=1862420670, cornwall=-1851305682, Emerald=-473051294, lagras=406627834,
    Manicato=1299204683, Manzanita=1463094051, Rhodes=2046780049, Siska=2147354003,
    StDenis=-765540529, Strawberry=427683330, Tumbleweed=-1524959147,
    valentine=459833523, VANHORN=2126321341, Wallace=-872622034, wapiti=1663398575
}

Remove a town to take its free signal away. The town is reported by the client, so it is used only for signal, never to approve money.

#The back radio: fx-radio

The back radio set is no longer part of fx-pocketbook. It is its own resource, fx-radio: a voice radio on pma-voice channels that is also a signal source for the book. The notebook works without it; then signal comes only from towns and relay poles.

When fx-radio is started, a worn radio with a charged battery gives the book the bars set in fx-radio's own config.lua (4 by default), anywhere, also outside towns and away from poles. The notebook notices when fx-radio starts or stops, so the start order does not matter. While fx-radio is not started the radio costs the notebook nothing.

The radio's items, battery, charger, commands and settings are described in the fx-radio documentation.