SignalObject.Once - Byte Documentation

event:Once(callback: function): SignalConnection

Aliases

SignalObject.once

Arguments

function

required

The callback to register. Keep the same function object for removal.

Returns

SignalConnection

A custom connection that disconnects before its first callback.

The connection disconnects before its first invocation is scheduled, preventing another firing from scheduling it again. Related types: Signals types & behavior · SignalObject.

Example

local event = Signal.new()
local connection = event:Once(function(value) print(value) end)
event:Fire("first")
event:Fire("second")
task.wait()
print(connection.Connected)

​Aliases

​Arguments

​Returns

​Example

Aliases

Arguments

Returns

Example