API reference

Three server functions, a state bag, one client export.

Commands

/tunit is open to any driver, /tunitedit needs tlib.admin, and tunit_diag is registered restricted so FiveM's own ACE covers it.

tUnit.source(name, fn)

Registers a named value your server computes, which an element names instead of a literal. Call it from config/sv_sources.lua, which is escrow_ignored and loaded after tUnit's own files.

tUnit.source('callsign', function(src, vehicle)
    return exports['my-mdt']:GetCallsign(src)
end)

name is letters, digits, - and _, 48 characters max. fn gets the driver's server id and the server-side vehicle, and returns a string, a number or nil.

What happens to the return value

Values are filtered, not escaped: A–Z, 0–9, - . _ / # and single spaces survive, everything else is dropped — including the whole of a non-Latin callsign. The set cannot be widened from config.lua.

tUnit.userValue(src, name)

What that player typed for a driver-set source, or nil:

tUnit.source('full', function(src)
    local unit = tUnit.userValue(src, 'unit')
    if not unit then return nil end
    return ('METRO %s'):format(unit)
end)

tUnit.sourceNames()

Every registered source name, sorted — what the editor's Shows dropdown offers.

exports.tUnit:atlasTexture()

Client-side.

local atlas = exports.tUnit:atlasTexture()
-- { txd = 'tunit_atlas', tex = 'tunit_cells_1849203', ready = true }

ready is false until the atlas has rendered. Do not construct tex yourself — the name changes on every bind, so a hardcoded one draws nothing after a restart.

The state bag

Entity(vehicle).state.tunit = { unit = '114', callsign = '1A-12' }

Sources resolve when the driver changes. The same player re-seating resolves nothing; an empty seat clears the bag. Text can be up to a second late.

The element record

As stored in Config.layouts, in data.json and in a shared layout. chars entries are { dx, dy, rz }.

Only the keys above are kept, so an extra field of your own is gone on the next read. A record with no usable id is dropped, and so is a duplicate id — it is not renamed.

Per-character positioning

perChar = true gives the element one plane per character — an arced wordmark, hand-kerned lettering, a marking no rectangle fits. It costs N cells and N planes against the maxPropsOnScreen ceiling.

chars[i] is a nudge from the automatic layout, not an absolute position, so perChar with no nudges looks identical to plain text. dx/dy are metres in the element's own plane, capped at ±1.0 m; rz is extra spin.

Nudges are addressed by index, not by character identity, and survive perChar being turned off. When the resolved text changes length, a nudge stays on its index rather than following its character.

Net events

Internal, with their gates: