Linkage reworks #419

LengthenedGradient · 2024-07-18T21:11:24Z

Introduces changes to how links are represented in the code. Backwards compatibility has been maintained, so RegisterClassLink/RegisterClassUnlink calls made previously still work. RegisterNewLink was replaced GetLinkDataSafe with to safely initialize tables, where each RegisterClass<something> function uses this internally. It can also be used to retrieve information about a link, e.g. GetLinkDataSafe("Class1","Class2").Link. This was done for future proofing reasons, as its now much easier to add new properties to links.

GetClassLink and GetClassUnlink were removed as you can do the same thing from the example above.

RegisterClassCheck was added, which allows you to optionally specify a check function. If specified, links will happen only if the check passes. Similar to the (now old) format where link functions returned a success and message variable, the Check function follows the same format. It is not applied to unlink functions because you should always be allowed to unlink.

RegisterClassDelay was also added, which allows you to optionally specify a delay for links to be applied when called from a chip (SF/E2). This can greatly reduce the benefits that can arise from on the fly link manipulation.

RegisterClassStore1 and RegisterclassStore2 can be used to optionally specify a LinkData table. If specified, a table on the entity will be automatically managed to contain the current linkages an entity of Class1 has of Class2. This is intended to make it much cleaner to maintain ordered and unordered links.

ACF.AD2SaveLinks and ACF.AD2LoadLinks makes it easier to interface links with AD2

ACF.UnlinkAll just unlinks all links of a given type; just for convenience.

Added/Current link functions:
ACF.GetLinkDataSafe
ACF.RegisterClassLink
ACF.RegisterClassUnlink
ACF.RegisterClassCheck
ACF.RegisterClassDelay
ACF.RegisterClassStore1
ACF.RegisterClassStore2
ACF.AD2SaveLinks
ACF.AD2LoadLinks
ACF.UnlinkAll

Removed link functions:
RegisterNewLink
GetClassLink
GetClassUnlink

TwistedTail

Besides avoiding sequential links as a thing, it only needs a few readability changes, along with clarifying some stuff I couldn't really grasp why it was done the way it was.

TwistedTail · 2024-08-24T06:11:04Z

lua/acf/core/utilities/util_sv.lua

-			Data2[Class1] = function(Ent2, Ent1)
-				return Function(Ent1, Ent2)
-			end
+		local LinkData2 = ACF.GetLinkDataSafe(Class1,Class2)


Wouldn't this be the same as line 451?

Right, it should be reversed to

local LinkData2 = ACF.GetLinkDataSafe(Class2,Class1)

TwistedTail · 2024-08-24T06:12:30Z

lua/acf/core/utilities/util_sv.lua

-		return ClassLink.Link[Class1][Class2]
+	--- @param Function fun(Entity1:table, Entity2:table, FromChip:boolean) The checking function defined between an entity of Class1 and an entity of Class2
+	function ACF.RegisterClassCheck(Class1, Class2, Function)
+		ACF.GetLinkDataSafe(Class1,Class2).Check = function(Ent1, Ent2, FromChip) return Function(Ent1, Ent2, FromChip) end


Readability, localize the result from ACF.GetLinkDataSafe and then assign it's Check value.

TwistedTail · 2024-08-24T06:12:39Z

lua/acf/core/utilities/util_sv.lua

+	function ACF.RegisterClassCheck(Class1, Class2, Function)
+		ACF.GetLinkDataSafe(Class1,Class2).Check = function(Ent1, Ent2, FromChip) return Function(Ent1, Ent2, FromChip) end
+		if Class1 == Class2 then return end
+		ACF.GetLinkDataSafe(Class2,Class1).Check = function(Ent2, Ent1, FromChip) return Function(Ent1, Ent2, FromChip) end


Readability, localize the result from ACF.GetLinkDataSafe and then assign it's Check value.

TwistedTail · 2024-08-24T06:13:26Z

lua/acf/core/utilities/util_sv.lua

-		RegisterNewLink("Unlink", Class1, Class2, Function)
+	--- @param ChipDelay number If the link happens from the chip, then delay it by this amount
+	function ACF.RegisterClassDelay(Class1, Class2, ChipDelay)
+		ACF.GetLinkDataSafe(Class1,Class2).ChipDelay = ChipDelay


Readability, localize the result from ACF.GetLinkDataSafe and then assign it's ChipDelay value.

TwistedTail · 2024-08-24T06:13:39Z

lua/acf/core/utilities/util_sv.lua

+	function ACF.RegisterClassDelay(Class1, Class2, ChipDelay)
+		ACF.GetLinkDataSafe(Class1,Class2).ChipDelay = ChipDelay
+		if Class1 == Class2 then return end
+		ACF.GetLinkDataSafe(Class2,Class1).ChipDelay = ChipDelay


Readability, localize the result from ACF.GetLinkDataSafe and then assign it's ChipDelay value.

TwistedTail · 2024-08-24T06:15:02Z

lua/acf/core/utilities/util_sv.lua

-	function ACF.GetClassUnlink(Class1, Class2)
-		if not ClassLink.Unlink[Class1] then return end
+	function ACF.RegisterClassStore1(Class1, Class2, LinkStore)
+		ACF.GetLinkDataSafe(Class1,Class2).LinkStore1 = LinkStore


Readability, same reason as before.

TwistedTail · 2024-08-24T06:15:06Z

lua/acf/core/utilities/util_sv.lua

+	function ACF.RegisterClassStore1(Class1, Class2, LinkStore)
+		ACF.GetLinkDataSafe(Class1,Class2).LinkStore1 = LinkStore
+		if Class1 == Class2 then return end
+		ACF.GetLinkDataSafe(Class2,Class1).LinkStore2 = LinkStore


Readability, same reason as before.

TwistedTail · 2024-08-24T06:15:11Z

lua/acf/core/utilities/util_sv.lua


-		return ClassLink.Unlink[Class1][Class2]
+	function ACF.RegisterClassStore2(Class1, Class2, LinkStore)
+		ACF.GetLinkDataSafe(Class1,Class2).LinkStore2 = LinkStore


Readability, same reason as before.

TwistedTail · 2024-08-24T06:15:16Z

lua/acf/core/utilities/util_sv.lua

+	function ACF.RegisterClassStore2(Class1, Class2, LinkStore)
+		ACF.GetLinkDataSafe(Class1,Class2).LinkStore2 = LinkStore
+		if Class1 == Class2 then return end
+		ACF.GetLinkDataSafe(Class2,Class1).LinkStore1 = LinkStore


Readability, same reason as before.

TwistedTail · 2024-08-24T06:16:49Z

lua/acf/core/utilities/util_sv.lua

+
+	local ClassLink = { }
+
+	function ACF.GetLinkDataSafe(Class1, Class2)


In terms of naming convention, returning a "Safe" value often means a copy of it. In this case, the actual real value is being returned.

Renamed to GetLinkData since its usage requires it to return a real value

Originally called it "Safe" since it safely checks if the table exists and creates a new one if it doesn't already exist.

This reverts commit ef731d1.

This reverts commit bdc5c6d.

This reverts commit e91eae9.

- Removes LinkStore variables - Link information is now stored in the direction registered, but retrieval will try either so to keep the way we link things the same - Link functions will now be called with an additional `FromChip` parameter which specifies if the linkage comes from a chip. - Links will now support a `ChipDelay` property which will apply the linkage a set time after the initial call. This should be used with the `RegisterClassCheck` function.

TwistedTail

It's just minor changes, everything else seems alright.

TwistedTail · 2024-08-29T23:55:09Z

lua/acf/core/utilities/util_sv.lua

+	--- @return LinkData? LinkData The returned link
+	--- @return boolean Reversed Whether you should reverse your entity arguments when calling with entities
+	function ACF.GetClassLink(Class1, Class2)
+		if ClassLink[Class1] ~= nil and ClassLink[Class1][Class2] ~= nil then return ClassLink[Class1][Class2], false end


Does ClassLink store any booleans that could end up being false? If not, comparing if X ~= nil is unnecesary, you can just do if X on that case

I think I hallucinated this not working but it seems it works now. The other ones with ~= nil will be fixed.

TwistedTail · 2024-08-29T23:56:43Z

lua/entities/acf_base_scalable/init.lua

-		local Function = ACF.GetClassLink(self:GetClass(), Class)
+		local LinkData, Reversed = ACF.GetClassLink(self:GetClass(), Class)
+
+		if LinkData == nil then return false, "Links between these two entities are impossible" end


If LinkData never actually receives a false value as a valid result, then you could just change this condition to if not LinkData

TwistedTail · 2024-08-29T23:57:02Z

lua/entities/acf_base_scalable/init.lua

-		elseif self.DefaultLink then
-			return self:DefaultLink(Target)
+			if Check then
+				local result, message = Check(A, B)


Inconsistent capitalization

TwistedTail · 2024-08-29T23:57:42Z

lua/entities/acf_base_scalable/init.lua

+		local LinkData, Reversed = ACF.GetClassLink(self:GetClass(), Class)
+		local Function = LinkData.Unlink
+
+		if LinkData == nil then return false, "Links between these two entities are impossible" end


If LinkData never actually receives a false value as a valid result, then you could just change this condition to if not LinkData

LengthenedGradient added 3 commits July 16, 2024 23:47

WIP

e91eae9

Finished

bdc5c6d

Silence Linter

ef731d1

TwistedTail requested changes Aug 24, 2024

View reviewed changes

LengthenedGradient added 6 commits August 28, 2024 15:38

Revert "Silence Linter"

de253ca

This reverts commit ef731d1.

Revert "Finished"

ce719e8

This reverts commit bdc5c6d.

Revert "WIP"

ac3b9e9

This reverts commit e91eae9.

Fix Linter

6479163

One More Try

209e5c1

TwistedTail requested changes Aug 29, 2024

View reviewed changes

LengthenedGradient added 3 commits August 29, 2024 20:16

Fix Style Issues

e6c6a4b

One More Thing

730c197

Update init.lua

c2c2d24

TwistedTail approved these changes Aug 30, 2024

View reviewed changes

TwistedTail merged commit 3bde914 into ACF-Team:dev Aug 30, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Linkage reworks #419

Linkage reworks #419

LengthenedGradient commented Jul 18, 2024

TwistedTail left a comment

TwistedTail Aug 24, 2024

LengthenedGradient Aug 24, 2024

TwistedTail Aug 24, 2024

TwistedTail Aug 24, 2024

TwistedTail Aug 24, 2024

TwistedTail Aug 24, 2024

TwistedTail Aug 24, 2024

TwistedTail Aug 24, 2024

TwistedTail Aug 24, 2024

TwistedTail Aug 24, 2024

TwistedTail Aug 24, 2024

LengthenedGradient Aug 24, 2024

LengthenedGradient Aug 24, 2024

TwistedTail left a comment

TwistedTail Aug 29, 2024

LengthenedGradient Aug 30, 2024

TwistedTail Aug 29, 2024

TwistedTail Aug 29, 2024

TwistedTail Aug 29, 2024


		local ClassLink = { }

		function ACF.GetLinkDataSafe(Class1, Class2)

Linkage reworks #419

Linkage reworks #419

Conversation

LengthenedGradient commented Jul 18, 2024

TwistedTail left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TwistedTail left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment