Skip to main content

ClientNetWire

This item only works when running on the client. Client

Instance methods for ClientNetWire objects. These methods are available on created ClientNetWire instances.

Types​

ClientMiddleware​

</>
type ClientMiddleware = (args: {any}) → (
shouldContinue: boolean,
...any
)

Middleware function for client-side operations. Returns whether to continue processing and any modified arguments.

Functions​

new​

</>
ClientNetWire.new(nameSpace: string) → ClientNetWire

Creates a new ClientNetWire. If a ClientNetWire with the same nameSpace already exists, it will be returned instead.

onReady​

</>
ClientNetWire.onReady(clientNetWire: string | ClientNetWire) → Promise<ClientNetWire>

Returns a promise that resolves when the ClientNetWire is ready for use.

isReady​

</>
ClientNetWire.isReady(clientNetWire: ClientNetWire | string) → boolean

Can be used to check if a clientNetWire is ready for use. Accepts either a ClientNetWire instance or a string name of the wire. Returns true if the ClientNetWire is ready, false otherwise.

indexReady​

</>
ClientNetWire.indexReady(
wireOrName: ClientNetWire | string,
idx: string--

The index to wait for existence of

) → Promise<...any>

Returns a promise that resolves when the ClientNetWire is ready for use and the index exists. The resolved value is the value of the index.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new ClientNetWire. If a ClientNetWire with the same nameSpace already exists, it will be returned instead.",
            "params": [
                {
                    "name": "nameSpace",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ClientNetWire"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 173,
                "path": "lib/netwire/src/ClientWire.luau"
            }
        },
        {
            "name": "onReady",
            "desc": "Returns a promise that resolves when the ClientNetWire is ready for use.",
            "params": [
                {
                    "name": "clientNetWire",
                    "desc": "",
                    "lua_type": "string | ClientNetWire"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<ClientNetWire>\r\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 282,
                "path": "lib/netwire/src/ClientWire.luau"
            }
        },
        {
            "name": "isReady",
            "desc": "Can be used to check if a clientNetWire is ready for use.\nAccepts either a ClientNetWire instance or a string name of the wire.\nReturns `true` if the ClientNetWire is ready, `false` otherwise.",
            "params": [
                {
                    "name": "clientNetWire",
                    "desc": "",
                    "lua_type": "ClientNetWire | string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 311,
                "path": "lib/netwire/src/ClientWire.luau"
            }
        },
        {
            "name": "indexReady",
            "desc": "Returns a promise that resolves when the ClientNetWire is ready for use and the index exists.\nThe resolved value is the value of the index.",
            "params": [
                {
                    "name": "wireOrName",
                    "desc": "",
                    "lua_type": "ClientNetWire | string"
                },
                {
                    "name": "idx",
                    "desc": "The index to wait for existence of",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<...any>\r\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 331,
                "path": "lib/netwire/src/ClientWire.luau"
            }
        },
        {
            "name": "destroy",
            "desc": "Destroys a ClientNetWire, removing it from the cache.",
            "params": [
                {
                    "name": "clientNetWire",
                    "desc": "",
                    "lua_type": "ClientNetWire"
                }
            ],
            "returns": [],
            "function_type": "static",
            "private": true,
            "source": {
                "line": 352,
                "path": "lib/netwire/src/ClientWire.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "ClassName",
            "desc": "",
            "lua_type": "\"ClientNetWire\"",
            "private": true,
            "readonly": true,
            "source": {
                "line": 132,
                "path": "lib/netwire/src/ClientWire.luau"
            }
        },
        {
            "name": "Client",
            "desc": "",
            "lua_type": "ClientNetWire",
            "realm": [
                "Client"
            ],
            "private": true,
            "source": {
                "line": 386,
                "path": "lib/netwire/src/ClientWire.luau"
            }
        }
    ],
    "types": [
        {
            "name": "ClientMiddleware",
            "desc": "Middleware function for client-side operations.\nReturns whether to continue processing and any modified arguments.",
            "lua_type": "(args: {any}) -> (shouldContinue: boolean, ...any)",
            "source": {
                "line": 73,
                "path": "lib/netwire/src/NetWireTypes.luau"
            }
        }
    ],
    "name": "ClientNetWire",
    "desc": "Instance methods for ClientNetWire objects.\nThese methods are available on created ClientNetWire instances.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 143,
        "path": "lib/netwire/src/ClientWire.luau"
    }
}