Skip to main content

PacketSizeCounter

The main class for calculating the size of packets.

Properties​

BaseRemoteOverhead​

This item is read only and cannot be modified. Read Only
</>
PacketSizeCounter.BaseRemoteOverhead: number

The byte overhead of a remote event, in bytes.

RemoteFunctionOverhead​

This item is read only and cannot be modified. Read Only
</>
PacketSizeCounter.RemoteFunctionOverhead: number

The additional byte overhead of a remote function, in bytes.

ClientToServerOverhead​

This item is read only and cannot be modified. Read Only
</>
PacketSizeCounter.ClientToServerOverhead: number

The additional byte overhead of a client-to-server remote, in bytes.

TypeOverhead​

This item is read only and cannot be modified. Read Only
</>
PacketSizeCounter.TypeOverhead: number

The byte overhead of a type, in bytes.

Functions​

GetPacketSize​

</>
PacketSizeCounter.GetPacketSize(CounterData: {
RunContext: "Server" | "Client",
RemoteType: "RemoteEvent" | "RemoteFunction",
PacketData: {any}
}) → number

Returns the byte size of a packet from the given data. Remote overhead is automatically added, and is different based on the remote type and run context.

GetDataByteSize​

</>
PacketSizeCounter.GetDataByteSize(Data: any) → number

Returns the byte size of a single data object type. Supports most types.

Show raw api
{
    "functions": [
        {
            "name": "GetPacketSize",
            "desc": "Returns the byte size of a packet from the given data. Remote overhead is automatically added, and is different based on the remote type and run context.",
            "params": [
                {
                    "name": "CounterData",
                    "desc": "",
                    "lua_type": "{\r\n\tRunContext: \"Server\" | \"Client\",\r\n\tRemoteType: \"RemoteEvent\" | \"RemoteFunction\",\r\n\tPacketData: {any}\r\n}"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number\r\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 168,
                "path": "src/init.luau"
            }
        },
        {
            "name": "GetDataByteSize",
            "desc": "Returns the byte size of a single data object type. Supports most types.",
            "params": [
                {
                    "name": "Data",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number\r\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 190,
                "path": "src/init.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "BaseRemoteOverhead",
            "desc": "The byte overhead of a remote event, in bytes.",
            "lua_type": "number",
            "readonly": true,
            "source": {
                "line": 144,
                "path": "src/init.luau"
            }
        },
        {
            "name": "RemoteFunctionOverhead",
            "desc": "The additional byte overhead of a remote function, in bytes.",
            "lua_type": "number",
            "readonly": true,
            "source": {
                "line": 151,
                "path": "src/init.luau"
            }
        },
        {
            "name": "ClientToServerOverhead",
            "desc": "The additional byte overhead of a client-to-server remote, in bytes.",
            "lua_type": "number",
            "readonly": true,
            "source": {
                "line": 158,
                "path": "src/init.luau"
            }
        },
        {
            "name": "TypeOverhead",
            "desc": "The byte overhead of a type, in bytes.",
            "lua_type": "number",
            "readonly": true,
            "source": {
                "line": 165,
                "path": "src/init.luau"
            }
        }
    ],
    "types": [],
    "name": "PacketSizeCounter",
    "desc": "The main class for calculating the size of packets.",
    "source": {
        "line": 138,
        "path": "src/init.luau"
    }
}