Server

For Server-sided

.Server

Create new Warp event.

Variable

(
	Identifier: string,
	rateLimit: {
		maxEntrance: number,
		interval: number,
	}?
)

Example

local Remote = Warp.new("Remote")

:Connect

Connect event to receive incoming from client way.

Variable

(
	player: Player,
	callback: (...any) -> ()
): string

Example

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

:Once

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

Variable

(
	player: Player,
	callback: (...any) -> ()
)

Example

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

:Disconnect

Disconnect the event connection.

Variable

(
	key: string
)

Example

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

Remote:Disconnect(connection)

:DisconnectAll

Disconnect All the event connection.

Remote:DisconnectAll()

:Fire

Fire the event to a client.

Variable

(
	reliable: boolean,
    player: Player,
	...: any
)

Example

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

:Fires Server Only

Fire the event to all clients.

Variable

(
	reliable: boolean,
	...: any
)

Example

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

:Invoke

Semiliar to :InvokeClient, its for Invoke to a client.

Variable

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

Example

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

WARNING

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

:Wait

Wait the event being triggered.

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.

Remote:Destroy()