roblox-opencode 1.0.0 → 1.0.2

package/vendor/rbxutil/comm/Client/ClientRemoteProperty.luau

@@ -1,156 +1,156 @@
--- ClientRemoteProperty
--- Stephen Leitnick
--- December 20, 2021
-
-local Promise = require(script.Parent.Parent.Parent.Promise)
-local Signal = require(script.Parent.Parent.Parent.Signal)
-local ClientRemoteSignal = require(script.Parent.ClientRemoteSignal)
-local Types = require(script.Parent.Parent.Types)
-
---[=[
-	@within ClientRemoteProperty
-	@prop Changed Signal<any>
-
-	Fires when the property receives an updated value
-	from the server.
-
-	```lua
-	clientRemoteProperty.Changed:Connect(function(value)
-		print("New value", value)
-	end)
-	```
-]=]
-
---[=[
-	@class ClientRemoteProperty
-	@client
-	Created via `ClientComm:GetProperty()`.
-]=]
-local ClientRemoteProperty = {}
-ClientRemoteProperty.__index = ClientRemoteProperty
-
-function ClientRemoteProperty.new(
-	re: RemoteEvent,
-	inboundMiddleware: Types.ClientMiddleware?,
-	outboudMiddleware: Types.ClientMiddleware?
-)
-	local self = setmetatable({}, ClientRemoteProperty)
-	self._rs = ClientRemoteSignal.new(re, inboundMiddleware, outboudMiddleware)
-	self._ready = false
-	self._value = nil
-	self.Changed = Signal.new()
-	self._rs:Fire()
-
-	local resolveOnReadyPromise
-	self._readyPromise = Promise.new(function(resolve)
-		resolveOnReadyPromise = resolve
-	end)
-	self._changed = self._rs:Connect(function(value)
-		local changed = value ~= self._value
-		self._value = value
-		if not self._ready then
-			self._ready = true
-			resolveOnReadyPromise(value)
-		end
-		if changed then
-			self.Changed:Fire(value)
-		end
-	end)
-
-	return self
-end
-
---[=[
-	Gets the value of the property object.
-
-	:::caution
-	This value might not be ready right away. Use `OnReady()` or `IsReady()`
-	before calling `Get()`. If not ready, this value will return `nil`.
-	:::
-]=]
-function ClientRemoteProperty:Get(): any
-	return self._value
-end
-
---[=[
-	@return Promise<any>
-	Returns a Promise which resolves once the property object is
-	ready to be used. The resolved promise will also contain the
-	value of the property.
-
-	```lua
-	-- Use andThen clause:
-	clientRemoteProperty:OnReady():andThen(function(initialValue)
-		print(initialValue)
-	end)
-
-	-- Use await:
-	local success, initialValue = clientRemoteProperty:OnReady():await()
-	if success then
-		print(initialValue)
-	end
-	```
-]=]
-function ClientRemoteProperty:OnReady()
-	return self._readyPromise
-end
-
---[=[
-	Returns `true` if the property object is ready to be
-	used. In other words, it has successfully gained
-	connection to the server-side version and has synced
-	in the initial value.
-
-	```lua
-	if clientRemoteProperty:IsReady() then
-		local value = clientRemoteProperty:Get()
-	end
-	```
-]=]
-function ClientRemoteProperty:IsReady(): boolean
-	return self._ready
-end
-
---[=[
-	@param observer (any) -> nil
-	@return Connection
-	Observes the value of the property. The observer will
-	be called right when the value is first ready, and
-	every time the value changes. This is safe to call
-	immediately (i.e. no need to use `IsReady` or `OnReady`
-	before using this method).
-
-	Observing is essentially listening to `Changed`, but
-	also sends the initial value right away (or at least
-	once `OnReady` is completed).
-
-	```lua
-	local function ObserveValue(value)
-		print(value)
-	end
-
-	clientRemoteProperty:Observe(ObserveValue)
-	```
-]=]
-function ClientRemoteProperty:Observe(observer: (any) -> ())
-	if self._ready then
-		task.defer(observer, self._value)
-	end
-	return self.Changed:Connect(observer)
-end
-
---[=[
-	Destroys the ClientRemoteProperty object.
-]=]
-function ClientRemoteProperty:Destroy()
-	self._rs:Destroy()
-	if self._readyPromise then
-		self._readyPromise:cancel()
-	end
-	if self._changed then
-		self._changed:Disconnect()
-	end
-	self.Changed:Destroy()
-end
-
-return ClientRemoteProperty
+-- ClientRemoteProperty
+-- Stephen Leitnick
+-- December 20, 2021
+
+local Promise = require(script.Parent.Parent.Parent.Promise)
+local Signal = require(script.Parent.Parent.Parent.Signal)
+local ClientRemoteSignal = require(script.Parent.ClientRemoteSignal)
+local Types = require(script.Parent.Parent.Types)
+
+--[=[
+	@within ClientRemoteProperty
+	@prop Changed Signal<any>
+
+	Fires when the property receives an updated value
+	from the server.
+
+	```lua
+	clientRemoteProperty.Changed:Connect(function(value)
+		print("New value", value)
+	end)
+	```
+]=]
+
+--[=[
+	@class ClientRemoteProperty
+	@client
+	Created via `ClientComm:GetProperty()`.
+]=]
+local ClientRemoteProperty = {}
+ClientRemoteProperty.__index = ClientRemoteProperty
+
+function ClientRemoteProperty.new(
+	re: RemoteEvent,
+	inboundMiddleware: Types.ClientMiddleware?,
+	outboudMiddleware: Types.ClientMiddleware?
+)
+	local self = setmetatable({}, ClientRemoteProperty)
+	self._rs = ClientRemoteSignal.new(re, inboundMiddleware, outboudMiddleware)
+	self._ready = false
+	self._value = nil
+	self.Changed = Signal.new()
+	self._rs:Fire()
+
+	local resolveOnReadyPromise
+	self._readyPromise = Promise.new(function(resolve)
+		resolveOnReadyPromise = resolve
+	end)
+	self._changed = self._rs:Connect(function(value)
+		local changed = value ~= self._value
+		self._value = value
+		if not self._ready then
+			self._ready = true
+			resolveOnReadyPromise(value)
+		end
+		if changed then
+			self.Changed:Fire(value)
+		end
+	end)
+
+	return self
+end
+
+--[=[
+	Gets the value of the property object.
+
+	:::caution
+	This value might not be ready right away. Use `OnReady()` or `IsReady()`
+	before calling `Get()`. If not ready, this value will return `nil`.
+	:::
+]=]
+function ClientRemoteProperty:Get(): any
+	return self._value
+end
+
+--[=[
+	@return Promise<any>
+	Returns a Promise which resolves once the property object is
+	ready to be used. The resolved promise will also contain the
+	value of the property.
+
+	```lua
+	-- Use andThen clause:
+	clientRemoteProperty:OnReady():andThen(function(initialValue)
+		print(initialValue)
+	end)
+
+	-- Use await:
+	local success, initialValue = clientRemoteProperty:OnReady():await()
+	if success then
+		print(initialValue)
+	end
+	```
+]=]
+function ClientRemoteProperty:OnReady()
+	return self._readyPromise
+end
+
+--[=[
+	Returns `true` if the property object is ready to be
+	used. In other words, it has successfully gained
+	connection to the server-side version and has synced
+	in the initial value.
+
+	```lua
+	if clientRemoteProperty:IsReady() then
+		local value = clientRemoteProperty:Get()
+	end
+	```
+]=]
+function ClientRemoteProperty:IsReady(): boolean
+	return self._ready
+end
+
+--[=[
+	@param observer (any) -> nil
+	@return Connection
+	Observes the value of the property. The observer will
+	be called right when the value is first ready, and
+	every time the value changes. This is safe to call
+	immediately (i.e. no need to use `IsReady` or `OnReady`
+	before using this method).
+
+	Observing is essentially listening to `Changed`, but
+	also sends the initial value right away (or at least
+	once `OnReady` is completed).
+
+	```lua
+	local function ObserveValue(value)
+		print(value)
+	end
+
+	clientRemoteProperty:Observe(ObserveValue)
+	```
+]=]
+function ClientRemoteProperty:Observe(observer: (any) -> ())
+	if self._ready then
+		task.defer(observer, self._value)
+	end
+	return self.Changed:Connect(observer)
+end
+
+--[=[
+	Destroys the ClientRemoteProperty object.
+]=]
+function ClientRemoteProperty:Destroy()
+	self._rs:Destroy()
+	if self._readyPromise then
+		self._readyPromise:cancel()
+	end
+	if self._changed then
+		self._changed:Disconnect()
+	end
+	self.Changed:Destroy()
+end
+
+return ClientRemoteProperty

package/vendor/rbxutil/comm/Client/ClientRemoteSignal.luau

@@ -1,109 +1,109 @@
--- ClientRemoteSignal
--- Stephen Leitnick
--- December 20, 2021
-
-local Signal = require(script.Parent.Parent.Parent.Signal)
-local Types = require(script.Parent.Parent.Types)
-
---[=[
-	@class ClientRemoteSignal
-	@client
-	Created via `ClientComm:GetSignal()`.
-]=]
-local ClientRemoteSignal = {}
-ClientRemoteSignal.__index = ClientRemoteSignal
-
---[=[
-	@within ClientRemoteSignal
-	@interface Connection
-	.Disconnect () -> ()
-
-	Represents a connection.
-]=]
-
-function ClientRemoteSignal.new(
-	re: RemoteEvent | UnreliableRemoteEvent,
-	inboundMiddleware: Types.ClientMiddleware?,
-	outboudMiddleware: Types.ClientMiddleware?
-)
-	local self = setmetatable({}, ClientRemoteSignal)
-	self._re = re
-	if outboudMiddleware and #outboudMiddleware > 0 then
-		self._hasOutbound = true
-		self._outbound = outboudMiddleware
-	else
-		self._hasOutbound = false
-	end
-	if inboundMiddleware and #inboundMiddleware > 0 then
-		self._directConnect = false
-		self._signal = Signal.new()
-		self._reConn = self._re.OnClientEvent:Connect(function(...)
-			local args = table.pack(...)
-			for _, middlewareFunc in inboundMiddleware do
-				local middlewareResult = table.pack(middlewareFunc(args))
-				if not middlewareResult[1] then
-					return
-				end
-				args.n = #args
-			end
-			self._signal:Fire(table.unpack(args, 1, args.n))
-		end)
-	else
-		self._directConnect = true
-	end
-	return self
-end
-
-function ClientRemoteSignal:_processOutboundMiddleware(...: any)
-	local args = table.pack(...)
-	for _, middlewareFunc in self._outbound do
-		local middlewareResult = table.pack(middlewareFunc(args))
-		if not middlewareResult[1] then
-			return table.unpack(middlewareResult, 2, middlewareResult.n)
-		end
-		args.n = #args
-	end
-	return table.unpack(args, 1, args.n)
-end
-
---[=[
-	@param fn (...: any) -> ()
-	@return Connection
-	Connects a function to the remote signal. The function will be
-	called anytime the equivalent server-side RemoteSignal is
-	fired at this specific client that created this client signal.
-]=]
-function ClientRemoteSignal:Connect(fn: (...any) -> ())
-	if self._directConnect then
-		return self._re.OnClientEvent:Connect(fn)
-	else
-		return self._signal:Connect(fn)
-	end
-end
-
---[=[
-	Fires the equivalent server-side signal with the given arguments.
-
-	:::note Outbound Middleware
-	All arguments pass through any outbound middleware before being
-	sent to the server.
-	:::
-]=]
-function ClientRemoteSignal:Fire(...: any)
-	if self._hasOutbound then
-		self._re:FireServer(self:_processOutboundMiddleware(...))
-	else
-		self._re:FireServer(...)
-	end
-end
-
---[=[
-	Destroys the ClientRemoteSignal object.
-]=]
-function ClientRemoteSignal:Destroy()
-	if self._signal then
-		self._signal:Destroy()
-	end
-end
-
-return ClientRemoteSignal
+-- ClientRemoteSignal
+-- Stephen Leitnick
+-- December 20, 2021
+
+local Signal = require(script.Parent.Parent.Parent.Signal)
+local Types = require(script.Parent.Parent.Types)
+
+--[=[
+	@class ClientRemoteSignal
+	@client
+	Created via `ClientComm:GetSignal()`.
+]=]
+local ClientRemoteSignal = {}
+ClientRemoteSignal.__index = ClientRemoteSignal
+
+--[=[
+	@within ClientRemoteSignal
+	@interface Connection
+	.Disconnect () -> ()
+
+	Represents a connection.
+]=]
+
+function ClientRemoteSignal.new(
+	re: RemoteEvent | UnreliableRemoteEvent,
+	inboundMiddleware: Types.ClientMiddleware?,
+	outboudMiddleware: Types.ClientMiddleware?
+)
+	local self = setmetatable({}, ClientRemoteSignal)
+	self._re = re
+	if outboudMiddleware and #outboudMiddleware > 0 then
+		self._hasOutbound = true
+		self._outbound = outboudMiddleware
+	else
+		self._hasOutbound = false
+	end
+	if inboundMiddleware and #inboundMiddleware > 0 then
+		self._directConnect = false
+		self._signal = Signal.new()
+		self._reConn = self._re.OnClientEvent:Connect(function(...)
+			local args = table.pack(...)
+			for _, middlewareFunc in inboundMiddleware do
+				local middlewareResult = table.pack(middlewareFunc(args))
+				if not middlewareResult[1] then
+					return
+				end
+				args.n = #args
+			end
+			self._signal:Fire(table.unpack(args, 1, args.n))
+		end)
+	else
+		self._directConnect = true
+	end
+	return self
+end
+
+function ClientRemoteSignal:_processOutboundMiddleware(...: any)
+	local args = table.pack(...)
+	for _, middlewareFunc in self._outbound do
+		local middlewareResult = table.pack(middlewareFunc(args))
+		if not middlewareResult[1] then
+			return table.unpack(middlewareResult, 2, middlewareResult.n)
+		end
+		args.n = #args
+	end
+	return table.unpack(args, 1, args.n)
+end
+
+--[=[
+	@param fn (...: any) -> ()
+	@return Connection
+	Connects a function to the remote signal. The function will be
+	called anytime the equivalent server-side RemoteSignal is
+	fired at this specific client that created this client signal.
+]=]
+function ClientRemoteSignal:Connect(fn: (...any) -> ())
+	if self._directConnect then
+		return self._re.OnClientEvent:Connect(fn)
+	else
+		return self._signal:Connect(fn)
+	end
+end
+
+--[=[
+	Fires the equivalent server-side signal with the given arguments.
+
+	:::note Outbound Middleware
+	All arguments pass through any outbound middleware before being
+	sent to the server.
+	:::
+]=]
+function ClientRemoteSignal:Fire(...: any)
+	if self._hasOutbound then
+		self._re:FireServer(self:_processOutboundMiddleware(...))
+	else
+		self._re:FireServer(...)
+	end
+end
+
+--[=[
+	Destroys the ClientRemoteSignal object.
+]=]
+function ClientRemoteSignal:Destroy()
+	if self._signal then
+		self._signal:Destroy()
+	end
+end
+
+return ClientRemoteSignal