Skip to content

# Client ​

For Client-sided

## `.Client` ​

Create new Warp event.

VariableExample
lua

    (
    	Identifier: string
    )

lua

    local Remote = Warp.new("Remote")

## `:Connect` ​

Connect event to receive incoming from server way.

VariableExample
lua

    (
    	callback: (...any) -> ()
    )

lua

    Remote:Connect(function(...)
    	print(...)
    end)

## `:Once` ​

This function likely `:Connect` but it disconnect the event once it fired.

VariableExample
lua

    (
    	callback: (...any) -> ()
    )

lua

    Remote:Once(function(...)
    	print(...)
    end)

## `:Disconnect` ​

Disconnect the event connection.

VariableExample
lua

    (
    	key: string
    )

lua

    local connection = Remote:Connect(function(player, ...) end) -- store the key

    Remote:Disconnect(connection)

## `:DisconnectAll` ​

Disconnect All the event connection.

lua

    Remote:DisconnectAll()

## `:Fire` ​

Fire the event to the spesific server with data.

VariableExample
lua

    (
    	reliable: boolean,
    	...: any
    )

lua

    Remote:Fire(true, "Hello World!")

WARNING

This function have rate limiting it self and configured from server.

## `:Invoke` ​

Semiliar to `:InvokeServer`, its for Invoke to a server.

VariableExample
lua

    (
    	timeout: number,
    	...: any
    ) -> (...any)

lua

    local Request = Remote:Invoke(2, "Hello World!")

WARNING

This function is yielded, once it timeout it will return nil.

## `:Wait` ​

Wait the event being triggered.

lua

    Remote:Wait()

WARNING

This function is yielded, Invoke might also ping this one and also causing error.

## `:Destroy` ​

Disconnect all connection of event and remove the event from Warp

lua

    Remote:Destroy()