[Suggestions] Add immutable methods to ScriptVector3f class

[MaratMadiev]

Suggestion Type

Others

Suggestion

• Current vector implementation is kind of inconvenient.

For example you have vectors A, B
To calculate 4*A + 3*B.rotateY(90*) you have to write something like

A.mul(4);
B.rotateY(90*)
B.mul(3);
A.add(B);
let result = A.copy()

Current methods return void so it's impossible to make method chaining
And vectors A and B will change so you won't be able to reuse it below without making copies first

• We can add dublicates of the methods which return a new object instead of changing the existing one
  This will allow vectors to be reused and the example above will be reduced to

let result = A.mul(4).add(B.rotateY(90*).mul(3))

Assets

No response

Implementation Details/References

No response

[zbx1425]

The interface exposed by NTE is designed to follow JOML's, which is the math library Minecraft currently uses

In JOML's documentation:
"All operations in JOML are designed to modify the object on which the operation is invoked. This helps in completely eliminating any object allocations, which the client could otherwise not control and which impact the GC performance resulting in small hickups."

That being said, the amount of operations in scripting isn't likely to make it make a huge difference, so that's a design choice issue

[AmberIsFrozen]

i am also a bit concerned about perf (though we don't have the numbers to compare against)
for method chaining, seems reasonable to add?

[MaratMadiev]

The interface exposed by NTE is designed to follow JOML's, which is the math library Minecraft currently uses
I think it makes sense on a larger scale, like the whole game scene but in

I thinks it makes sense on a larger scale, like the whole game scene, but in our case it will be ok to create bunch of new objects, i guess?

In fact, immutable methods are much easier to read, for example, I wrote this yesterday just to add and rotate a several vectors

	let thisCouplingPosGlobal = thisCarPos.copy();
	let thisCouplingLocalVec = new ScriptVector3f(0, 0, thisCouplingZ);
	thisCouplingLocalVec.rotX(-thisCarRot.x());
	thisCouplingLocalVec.rotY(thisCarRot.y());
	thisCouplingPosGlobal.add(thisCouplingLocalVec);

	let targetCouplingPosGlobal = targetCarPos.copy();
	let targetCouplingLocalVec = new ScriptVector3f(0, 0, targetCouplingZ);
	targetCouplingLocalVec.rotX(-targetCarRot.x());
	targetCouplingLocalVec.rotY(targetCarRot.y());
	targetCouplingPosGlobal.add(targetCouplingLocalVec);

uhmm so yeah I will be very grateful if they add immutable methods

[AmberIsFrozen]

Actually the current implementation of ScriptVector3f wraps around Minecraft's Vec3d instead of JOML, which is already immutable (It always returns a new copy of itself), we're just reassigning the impl variable.

Though I can't change the implementation as that'd break a lot of scripts, may need some creative naming...

[zbx1425]

Or, keep Vector3f as mutable, but allow chaining?
That is, to make the operation functions all return this.

let thisCouplingPosGlobal = thisCarPos.copy().add(new ScriptVector3f(0, 0, thisCouplingZ)
    .rotX(-thisCarRot.x()).rotY(thisCarRot.y()));
let targetCouplingPosGlobal = targetCarPos.copy().add(new ScriptVector3f(0, 0, targetCouplingZ)
    .rotX(-targetCarRot.x()).rotY(targetCarRot.y()));

This results in code nearly identical to as if we make Vector3f immutable, while you just need to remember to add copy() when needed.