Tooling Integration

Zap supports the ability to output a Lua file that can deseralise compressed data so that it can be read by plugins and/or scripts such as PacketProfiler.

Zap and PacketProfiler have created a common format for this interfacing as detailed below:

Tooling Format - Parameters

To deseralise this data, the function generated by Zap has the following parameters:

• The remote instance itself (RemoteEvent | UnreliableRemoteEvent)
• ALL arguments sent through the remote

An example is below:

DANGER

It is not intended behavior for you to run side effects if you deserialise the data yourself.

Tooling Format - Returns

The function then returns an array in this format:

Lua:

TS:

If the tooling_show_internal_data argument is true, then the first argument is of the type (although this type will respect your casing option):

Lua:

TS:

And then the next argument in the array is the data deserialised from the event itself (if it exists).