refactor: Fix OOP inheritance

Author: Quenty

src/acceltween/src/Shared/AccelTween.lua

@@ -103,10 +103,10 @@ function AccelTween:__index(index)
 	if AccelTween[index] then
 		return AccelTween[index]
 	elseif index == "p" then
-		local pos, _ = self:_getstate(os.clock())
+		local pos, _ = self:_getState(os.clock())
 		return pos
 	elseif index == "v" then
-		local _, vel = self:_getstate(os.clock())
+		local _, vel = self:_getState(os.clock())
 		return vel
 	elseif index == "a" then
 		return self._accel
@@ -122,21 +122,21 @@ end
 
 function AccelTween:__newindex(index, value)
 	if index == "p" then
-		self:_setstate(value, nil, nil, nil)
+		self:_setState(value, nil, nil, nil)
 	elseif index == "v" then
-		self:_setstate(nil, value, nil, nil)
+		self:_setState(nil, value, nil, nil)
 	elseif index == "a" then
-		self:_setstate(nil, nil, value, nil)
+		self:_setState(nil, nil, value, nil)
 	elseif index == "t" then
-		self:_setstate(nil, nil, nil, value)
+		self:_setState(nil, nil, nil, value)
 	elseif index == "pt" then
-		self:_setstate(value, 0, nil, value)
+		self:_setState(value, 0, nil, value)
 	else
 		error(string.format("Bad index %q", tostring(index)))
 	end
 end
 
-function AccelTween:_getstate(time)
+function AccelTween:_getState(time)
 	if time < (self._t0 + self._t1) / 2 then
 		local t = time - self._t0
 		return self._y0 + t * t / 2 * self._a0, t * self._a0
@@ -148,9 +148,9 @@ function AccelTween:_getstate(time)
 	end
 end
 
-function AccelTween:_setstate(newpos, newvel, newaccel, newtarg)
+function AccelTween:_setState(newpos, newvel, newaccel, newtarg)
 	local time = os.clock()
-	local pos, vel = self:_getstate(time)
+	local pos, vel = self:_getState(time)
 	pos = newpos or pos
 	vel = newvel or vel
 	self._accel = newaccel or self._accel

src/adorneeboundingbox/src/Shared/AdorneeBoundingBox.lua

@@ -20,9 +20,16 @@ local AdorneeBoundingBox = setmetatable({}, BaseObject)
 AdorneeBoundingBox.ClassName = "AdorneeBoundingBox"
 AdorneeBoundingBox.__index = AdorneeBoundingBox
 
-export type AdorneeBoundingBox = typeof(setmetatable({}, AdorneeBoundingBox))
-
-function AdorneeBoundingBox.new(initialAdornee: Instance): AdorneeBoundingBox
+export type AdorneeBoundingBox = typeof(setmetatable(
+	{} :: {
+		_adornee: ValueObject.ValueObject<Instance?>,
+		_bbCFrame: ValueObject.ValueObject<CFrame?>,
+		_bbSize: ValueObject.ValueObject<Vector3?>,
+	},
+	{} :: typeof({ __index = AdorneeBoundingBox })
+)) & BaseObject.BaseObject
+
+function AdorneeBoundingBox.new(initialAdornee: Instance?): AdorneeBoundingBox
 	local self = setmetatable(BaseObject.new() :: any, AdorneeBoundingBox)
 
 	self._adornee = self._maid:Add(ValueObject.new(initialAdornee))
@@ -45,7 +52,7 @@ function AdorneeBoundingBox.new(initialAdornee: Instance): AdorneeBoundingBox
 	return self
 end
 
-function AdorneeBoundingBox:SetAdornee(adornee: Instance?): () -> ()
+function AdorneeBoundingBox.SetAdornee(self: AdorneeBoundingBox, adornee: Instance?): () -> ()
 	assert(typeof(adornee) == "Instance" or adornee == nil, "Bad adornee")
 
 	self._adornee.Value = adornee
@@ -66,7 +73,7 @@ export type BoundingBoxData = {
 	Observes the bounding box of the adornee
 	@return Observable<BoundingBoxData>
 ]=]
-function AdorneeBoundingBox:ObserveBoundingBox(): _Observable.Observable<BoundingBoxData>
+function AdorneeBoundingBox.ObserveBoundingBox(self: AdorneeBoundingBox): _Observable.Observable<BoundingBoxData>
 	return Rx.combineLatest({
 		CFrame = self:ObserveCFrame(),
 		Size = self:ObserveSize(),
@@ -81,7 +88,7 @@ end
 	Gets the bounding box of the adornee
 	@return BoundingBoxData?
 ]=]
-function AdorneeBoundingBox:GetBoundingBox(): BoundingBoxData?
+function AdorneeBoundingBox.GetBoundingBox(self: AdorneeBoundingBox): BoundingBoxData?
 	local cframe = self._bbCFrame.Value
 	local size = self._bbSize.Value
 
@@ -99,35 +106,35 @@ end
 	Observes the cframe of the adornee
 	@return Observable<Vector3>
 ]=]
-function AdorneeBoundingBox:ObserveCFrame(): _Observable.Observable<CFrame>
+function AdorneeBoundingBox.ObserveCFrame(self: AdorneeBoundingBox): _Observable.Observable<CFrame?>
 	return self._bbCFrame:Observe()
 end
 
 --[=[
 	Gets the CFrame of the adornee
 	@return Vector3
 ]=]
-function AdorneeBoundingBox:GetCFrame(): CFrame?
+function AdorneeBoundingBox.GetCFrame(self: AdorneeBoundingBox): CFrame?
 	return self._bbCFrame.Value
 end
 
 --[=[
 	Observes the size of the adornee
 	@return Observable<Vector3>
 ]=]
-function AdorneeBoundingBox:ObserveSize(): _Observable.Observable<Vector3>
+function AdorneeBoundingBox.ObserveSize(self: AdorneeBoundingBox): _Observable.Observable<Vector3?>
 	return self._bbSize:Observe()
 end
 
 --[=[
 	Gets the size of the adornee
 	@return Vector3
 ]=]
-function AdorneeBoundingBox:GetSize(): Vector3
+function AdorneeBoundingBox.GetSize(self: AdorneeBoundingBox): Vector3?
 	return self._bbSize.Value
 end
 
-function AdorneeBoundingBox:_setup(maid: Maid.Maid, adornee: Instance)
+function AdorneeBoundingBox._setup(self: AdorneeBoundingBox, maid: Maid.Maid, adornee: Instance)
 	if adornee:IsA("BasePart") then
 		maid:GiveTask(self:_setupPart(adornee))
 	elseif adornee:IsA("Model") then
@@ -150,7 +157,7 @@ function AdorneeBoundingBox:_setup(maid: Maid.Maid, adornee: Instance)
 	end
 end
 
-function AdorneeBoundingBox:_setupTool(tool: Tool): Maid.Maid
+function AdorneeBoundingBox._setupTool(self: AdorneeBoundingBox, tool: Tool): Maid.Maid
 	assert(typeof(tool) == "Instance" and tool:IsA("Tool"), "Bad tool")
 
 	local topMaid = Maid.new()
@@ -160,17 +167,16 @@ function AdorneeBoundingBox:_setupTool(tool: Tool): Maid.Maid
 			return
 		end
 
-		local maid = brio:ToMaid()
-		local handle = brio:GetValue()
+		local maid, handle = brio:ToMaidAndValue()
 
 		-- TODO: Something smarter? But we'll need to change the AdorneeUtils contract too
-		maid:GiveTask(self:_setupPart(handle))
+		maid:GiveTask(self:_setupPart(handle :: BasePart))
 	end))
 
 	return topMaid
 end
 
-function AdorneeBoundingBox:_setupModel(model: Model): Maid.Maid
+function AdorneeBoundingBox._setupModel(self: AdorneeBoundingBox, model: Model): Maid.Maid
 	assert(typeof(model) == "Instance" and model:IsA("Model"), "Bad model")
 
 	local topMaid = Maid.new()
@@ -186,7 +192,7 @@ function AdorneeBoundingBox:_setupModel(model: Model): Maid.Maid
 	return topMaid
 end
 
-function AdorneeBoundingBox:_setupHumanoid(humanoid: Humanoid): Maid.Maid
+function AdorneeBoundingBox._setupHumanoid(self: AdorneeBoundingBox, humanoid: Humanoid): Maid.Maid
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 
 	local topMaid = Maid.new()
@@ -206,7 +212,7 @@ function AdorneeBoundingBox:_setupHumanoid(humanoid: Humanoid): Maid.Maid
 	return topMaid
 end
 
-function AdorneeBoundingBox:_setupAttachment(attachment: Attachment): Maid.Maid
+function AdorneeBoundingBox._setupAttachment(self: AdorneeBoundingBox, attachment: Attachment): Maid.Maid
 	assert(typeof(attachment) == "Instance" and attachment:IsA("Attachment"), "Bad attachment")
 
 	local maid = Maid.new()
@@ -217,7 +223,7 @@ function AdorneeBoundingBox:_setupAttachment(attachment: Attachment): Maid.Maid
 		return parent ~= nil
 	end)
 		:Pipe({
-			RxBrioUtils.switchMapBrio(function(parent)
+			RxBrioUtils.switchMapBrio(function(parent): any
 				if parent:IsA("BasePart") then
 					return Rx.combineLatest({
 						partCFrame = RxPartBoundingBoxUtils.observePartCFrame(parent),
@@ -240,7 +246,7 @@ function AdorneeBoundingBox:_setupAttachment(attachment: Attachment): Maid.Maid
 	return maid
 end
 
-function AdorneeBoundingBox:_setupPart(part: BasePart): Maid.Maid
+function AdorneeBoundingBox._setupPart(self: AdorneeBoundingBox, part: BasePart): Maid.Maid
 	assert(typeof(part) == "Instance" and part:IsA("BasePart"), "Bad part")
 
 	local maid = Maid.new()

src/adorneevalue/src/Shared/AdorneeValue.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Helper class to transform a an adornee into relative positions/information
 	@class AdorneeValue
@@ -12,21 +13,32 @@ local BaseObject = require("BaseObject")
 local Blend = require("Blend")
 local ValueObject = require("ValueObject")
 local _Observable = require("Observable")
+local _Signal = require("Signal")
 
 local AdorneeValue = setmetatable({}, BaseObject)
 AdorneeValue.ClassName = "AdorneeValue"
 AdorneeValue.__index = AdorneeValue
 
+export type AdorneeValueOption = Instance | CFrame | Vector3
+
+export type AdorneeValue = typeof(setmetatable(
+	{} :: {
+		_adornee: ValueObject.ValueObject<AdorneeValueOption?>,
+		Value: AdorneeValueOption?,
+		Changed: _Signal.Signal<(AdorneeValueOption?, AdorneeValueOption?)>,
+	},
+	{} :: typeof({ __index = AdorneeValue })
+)) & BaseObject.BaseObject
+
 --[=[
 	Constructs a new AdorneeValue
 
 	@return AdorneeValue
 ]=]
-function AdorneeValue.new()
-	local self = setmetatable(BaseObject.new(), AdorneeValue)
+function AdorneeValue.new(): AdorneeValue
+	local self: AdorneeValue = setmetatable(BaseObject.new() :: any, AdorneeValue)
 
-	self._adornee = ValueObject.new()
-	self._maid:GiveTask(self._adornee)
+	self._adornee = self._maid:Add(ValueObject.new())
 
 	return self
 end
@@ -36,7 +48,7 @@ end
 
 	@return Instance | CFrame | Vector3 | nil
 ]=]
-function AdorneeValue:GetAdornee(): (Instance | CFrame | Vector3)?
+function AdorneeValue.GetAdornee(self: AdorneeValue): (Instance | CFrame | Vector3)?
 	return self._adornee.Value
 end
 
@@ -45,7 +57,7 @@ end
 
 	@return Observable<Instance | CFrame | Vector3 | nil>
 ]=]
-function AdorneeValue:Observe(): _Observable.Observable<(Instance | CFrame | Vector3)?>
+function AdorneeValue.Observe(self: AdorneeValue): _Observable.Observable<(Instance | CFrame | Vector3)?>
 	return self._adornee:Observe()
 end
 
@@ -61,7 +73,7 @@ end
 	@prop Value Instance | CFrame | Vector3 | nil
 	@within AdorneeValue
 ]=]
-function AdorneeValue:__index(index)
+(AdorneeValue :: any).__index = function(self, index)
 	if index == "Value" then
 		return self._adornee.Value
 	elseif index == "Changed" then
@@ -76,7 +88,7 @@ function AdorneeValue:__index(index)
 	end
 end
 
-function AdorneeValue:__newindex(index, value)
+function AdorneeValue.__newindex(self, index, value)
 	if index == "Value" then
 		assert(
 			typeof(value) == "Instance" or typeof(value) == "Vector3" or typeof(value) == "CFrame" or value == nil,
@@ -100,7 +112,7 @@ end
 
 	@return Observable<CFrame | nil>
 ]=]
-function AdorneeValue:ObserveBottomCFrame()
+function AdorneeValue.ObserveBottomCFrame(self: AdorneeValue)
 	return Blend.Computed(self._adornee, function(adornee: Instance): CFrame?
 		if typeof(adornee) == "CFrame" then
 			return adornee
@@ -128,7 +140,7 @@ end
 
 	@return Observable<Vector3 | nil>
 ]=]
-function AdorneeValue:ObserveCenterPosition()
+function AdorneeValue.ObserveCenterPosition(self: AdorneeValue): _Observable.Observable<Vector3?>
 	return Blend.Computed(self._adornee, function()
 		return self:GetCenterPosition()
 	end)
@@ -139,7 +151,7 @@ end
 
 	@return Vector3 | nil
 ]=]
-function AdorneeValue:GetCenterPosition(): Vector3?
+function AdorneeValue.GetCenterPosition(self: AdorneeValue): Vector3?
 	local adornee = self._adornee.Value
 
 	if typeof(adornee) == "CFrame" then
@@ -162,7 +174,7 @@ end
 
 	@return Observable<number?>
 ]=]
-function AdorneeValue:ObserveRadius()
+function AdorneeValue.ObserveRadius(self: AdorneeValue)
 	return Blend.Computed(self._adornee, function()
 		return self:GetRadius()
 	end)
@@ -173,7 +185,7 @@ end
 
 	@return number?
 ]=]
-function AdorneeValue:GetRadius(): number?
+function AdorneeValue.GetRadius(self: AdorneeValue): number?
 	local adornee = self._adornee.Value
 
 	if typeof(adornee) == "CFrame" then
@@ -204,7 +216,7 @@ end
 	@param observeRadius Observable<number>
 	@return Observable
 ]=]
-function AdorneeValue:ObservePositionTowards(observeTargetPosition, observeRadius)
+function AdorneeValue.ObservePositionTowards(self: AdorneeValue, observeTargetPosition, observeRadius)
 	-- TODO: Some sort of de-duplication/multicast.
 
 	return Blend.Computed(
@@ -226,16 +238,21 @@ end
 	@param center Vector3
 	@return Vector3
 ]=]
-function AdorneeValue:GetPositionTowards(target: Vector3, radius: number, center: Vector3): Vector3?
+function AdorneeValue.GetPositionTowards(self: AdorneeValue, target: Vector3, radius: number, center: Vector3): Vector3?
 	assert(typeof(target) == "Vector3", "Bad target")
 
-	center = center or self:GetCenterPosition()
-	radius = radius or self:GetRadius()
+	center = center or assert(self:GetCenterPosition(), "Bad center")
+	radius = radius or assert(self:GetRadius(), "Bad radius")
 
 	return self:_getPositionTowards(target, radius, center)
 end
 
-function AdorneeValue:_getPositionTowards(target: Vector3, radius: number, center: Vector3): Vector3?
+function AdorneeValue._getPositionTowards(
+	_self: AdorneeValue,
+	target: Vector3,
+	radius: number,
+	center: Vector3
+): Vector3?
 	if not (radius and target and center) then
 		return nil
 	end
@@ -245,7 +262,7 @@ function AdorneeValue:_getPositionTowards(target: Vector3, radius: number, cente
 		return nil
 	end
 
-	return center + offset.unit * radius
+	return center + offset.Unit * radius
 end
 
 --[=[
@@ -254,7 +271,7 @@ end
 
 	@return Observable<Instance?>
 ]=]
-function AdorneeValue:ObserveAttachmentParent()
+function AdorneeValue.ObserveAttachmentParent(self: AdorneeValue)
 	return Blend.Computed(self._adornee, function(adornee): Instance?
 		if typeof(adornee) == "Instance" then
 			-- TODO: Nearest bounding box stuff.
@@ -283,7 +300,7 @@ end
 	@param props {} -- Takes [Blend.Children] as an option
 	@return Observable<Instance?>
 ]=]
-function AdorneeValue:RenderPositionAttachment(props)
+function AdorneeValue.RenderPositionAttachment(self: AdorneeValue, props)
 	props = props or {}
 
 	local observeWorldPosition = props.WorldPosition or self:ObserveCenterPosition()