Backporting 1.20.1

Author: TechTastic

.gitignore

@@ -7,7 +7,6 @@ out/
 .gradle/
 output/
 bin/
-libs/
 
 .classpath
 .project
@@ -16,4 +15,10 @@ classes/
 .metadata
 .vscode
 .settings
-*.launch
+*.launch
+
+quaternion.lua
+matrix.lua
+quaternion.txt
+matrix.txt
+pid.lua

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "libs/advanced_math"]
+	path = libs/advanced_math
+	url = https://github.com/TechTastic/Advanced-Math

changelog.md

@@ -1,8 +1,17 @@
 # Changes
-- Removed the `getEulerAngles***` methods in favor of a `quaternion` Lua library in-game
-- Added `quaternion` Lua library as an in-game API
-- Changed the `physics_tick` event to `physics_ticks` and updated how it works
-  - `physics_ticks` now saves up previous ticks of data THEN, on game tick, send out the event with the queued physics data
-- Updated config documentation
-- Added `ship` help page in-game
-- Added new methods to both Ship and Extended Ship API that take vectors
+### Ship API
+- Made `getOmega`, `getScale`, `getShipyardPosition`, `getVelocity`, `getWorldspacePosition`, and `transformPositionToWorld` output proper `vector`s with correct metatable
+- Made `getQuaternion` output a proper `quaternion` with correct metatable
+- Made `getTransformationMatrix` output a proper `matrix` with correct metatable
+- Made `getConstraints` output use proper `vector`s and `quaternion`s where applicable
+- Re-added `getEulerAnglesZYX"`, `getEulerAnglesZXY`, `getEulerAnglesYXZ`, `getEulerAnglesXYZ`, `getRoll`, `getYaw`, `getPitch`, and `getRotationMatrix` ***only*** so they throw a more useful error redirecting to the new methods.
+- Updated Ship API help page
+- Iproved `physics_ticks` event output
+- Moved `physics_ticks` event to Ship API
+- Added `pullPhysicsTicks` to utilize `physics_ticks` with proper `vector` and `quaternion` support
+### Quaternion API
+- Moved to [CC: Advanced Math Library](https://github.com/TechTastic/Advanced-Math)
+### Extended Ship API
+- Moved `physics_ticks` event to Ship API
+### New APIs
+- [CC: Advanced Math Library](https://github.com/TechTastic/Advanced-Math) created and included to handle pure Lua math including `quaternion` and `matrix` APIs, as well as a new `pid` module

common/build.gradle

@@ -28,6 +28,23 @@ dependencies {
     modImplementation("curse.maven:forge-config-api-547434:3943250")
 }
 
+tasks.register('updateSubmodules', Exec) {
+    commandLine 'git', 'submodule', 'update', '--recursive', '--remote'
+}
+
+tasks.register('copyMathLibrary', Copy) {
+    dependsOn('updateSubmodules')
+    from '../libs/advanced_math/datapack/data/computercraft/lua/rom/'
+    into 'src/main/resources/data/computercraft/lua/rom/'
+    include '**/*.lua'
+    include '*/*.txt'
+}
+processResources.dependsOn('copyMathLibrary')
+
+tasks.named("sourcesJar") {
+    dependsOn("copyMathLibrary")
+}
+
 publishing {
     publications {
         mavenCommon(MavenPublication) {

common/src/main/kotlin/io/github/techtastic/cc_vs/CCVSMod.kt

@@ -1,10 +1,14 @@
 package io.github.techtastic.cc_vs
 
+import io.github.techtastic.cc_vs.ship.PhysTickEventHandler
+import org.valkyrienskies.core.impl.hooks.VSEvents
+
 object CCVSMod {
     const val MOD_ID = "cc_vs"
 
     @JvmStatic
     fun init() {
+        VSEvents.shipLoadEvent.on { huh -> huh.ship.setAttachment(PhysTickEventHandler::class.java, null) }
     }
 
     @JvmStatic

common/src/main/kotlin/io/github/techtastic/cc_vs/apis/ExtendedShipAPI.kt

@@ -3,38 +3,28 @@ package io.github.techtastic.cc_vs.apis
 import dan200.computercraft.api.lua.IArguments
 import dan200.computercraft.api.lua.LuaException
 import dan200.computercraft.api.lua.LuaFunction
-import dan200.computercraft.core.apis.IAPIEnvironment
 import io.github.techtastic.cc_vs.PlatformUtils
-import io.github.techtastic.cc_vs.ship.PhysTickEventHandler
 import io.github.techtastic.cc_vs.ship.QueuedForcesApplier
 import io.github.techtastic.cc_vs.util.CCVSUtils.toVector
+import net.minecraft.core.BlockPos
 import net.minecraft.server.level.ServerLevel
-import org.checkerframework.common.reflection.qual.NewInstance
 import org.joml.Quaterniond
 import org.joml.Quaterniondc
 import org.joml.Vector3d
 import org.joml.Vector3dc
-import org.valkyrienskies.core.api.ships.ServerShip
 import org.valkyrienskies.core.impl.game.ShipTeleportDataImpl
 import org.valkyrienskies.mod.common.shipObjectWorld
 import org.valkyrienskies.mod.common.vsCore
 
-class ExtendedShipAPI(private val api: IAPIEnvironment, ship: ServerShip, level: ServerLevel) : ShipAPI(ship, level) {
-    var control: QueuedForcesApplier = QueuedForcesApplier.getOrCreateControl(this.ship)
-
-    init {
-        if (PlatformUtils.exposePhysTick())
-            PhysTickEventHandler.getOrCreateControl(this.ship).addComputer(api.computerID)
-    }
-
+class ExtendedShipAPI(level: ServerLevel, pos: BlockPos) : ShipAPI(level, pos) {
     @LuaFunction
     fun applyInvariantForce(args: IArguments) {
         val newForce =
             if (args.count() == 1)
                 args.getTable(0).toVector()
             else
                 Vector3d(args.getDouble(0), args.getDouble(1), args.getDouble(2))
-        this.control.applyInvariantForce(newForce)
+        QueuedForcesApplier.getOrCreateControl(getShip()).applyInvariantForce(newForce)
     }
 
     @LuaFunction
@@ -44,7 +34,7 @@ class ExtendedShipAPI(private val api: IAPIEnvironment, ship: ServerShip, level:
                 args.getTable(0).toVector()
             else
                 Vector3d(args.getDouble(0), args.getDouble(1), args.getDouble(2))
-        this.control.applyInvariantTorque(newTorque)
+        QueuedForcesApplier.getOrCreateControl(getShip()).applyInvariantTorque(newTorque)
     }
 
     @LuaFunction
@@ -57,7 +47,7 @@ class ExtendedShipAPI(private val api: IAPIEnvironment, ship: ServerShip, level:
                     Vector3d(args.getDouble(0), args.getDouble(1), args.getDouble(2)),
                     Vector3d(args.getDouble(3), args.getDouble(4), args.getDouble(5))
                 )
-        this.control.applyInvariantForceToPos(newForce, newPos)
+        QueuedForcesApplier.getOrCreateControl(getShip()).applyInvariantForceToPos(newForce, newPos)
     }
 
     @LuaFunction
@@ -67,7 +57,7 @@ class ExtendedShipAPI(private val api: IAPIEnvironment, ship: ServerShip, level:
                 args.getTable(0).toVector()
             else
                 Vector3d(args.getDouble(0), args.getDouble(1), args.getDouble(2))
-        this.control.applyRotDependentForce(newForce)
+        QueuedForcesApplier.getOrCreateControl(getShip()).applyRotDependentForce(newForce)
     }
 
     @LuaFunction
@@ -77,7 +67,7 @@ class ExtendedShipAPI(private val api: IAPIEnvironment, ship: ServerShip, level:
                 args.getTable(0).toVector()
             else
                 Vector3d(args.getDouble(0), args.getDouble(1), args.getDouble(2))
-        this.control.applyRotDependentTorque(newTorque)
+        QueuedForcesApplier.getOrCreateControl(getShip()).applyRotDependentTorque(newTorque)
     }
 
     @LuaFunction
@@ -90,17 +80,17 @@ class ExtendedShipAPI(private val api: IAPIEnvironment, ship: ServerShip, level:
                     Vector3d(args.getDouble(0), args.getDouble(1), args.getDouble(2)),
                     Vector3d(args.getDouble(3), args.getDouble(4), args.getDouble(5))
                 )
-        this.control.applyRotDependentForceToPos(newForce, newPos)
+        QueuedForcesApplier.getOrCreateControl(getShip()).applyRotDependentForceToPos(newForce, newPos)
     }
 
     @LuaFunction
     fun setStatic(b: Boolean) {
-        this.control.setStatic(b)
+        QueuedForcesApplier.getOrCreateControl(getShip()).setStatic(b)
     }
 
     @LuaFunction
     fun setScale(scale: Double) {
-        vsCore.scaleShip(level.shipObjectWorld, ship, scale)
+        vsCore.scaleShip(level.shipObjectWorld, getShip(), scale)
     }
 
     @LuaFunction
@@ -110,36 +100,36 @@ class ExtendedShipAPI(private val api: IAPIEnvironment, ship: ServerShip, level:
 
         val input = args.getTable(0)
 
-        var pos = this.ship.transform.positionInWorld
+        var pos = getShip().transform.positionInWorld
         if (input.containsKey("pos"))
             pos = getVectorFromTable(input, "pos")
 
-        var rot = this.ship.transform.shipToWorldRotation
+        var rot = getShip().transform.shipToWorldRotation
         if (input.containsKey("rot"))
             rot = getQuaternionFromTable(input).normalize(Quaterniond())
 
-        var vel = this.ship.velocity
+        var vel = getShip().velocity
         if (input.containsKey("vel"))
             vel = getVectorFromTable(input, "vel")
 
-        var omega = this.ship.omega
+        var omega = getShip().omega
         if (input.containsKey("omega"))
             omega = getVectorFromTable(input, "omega")
 
         var dimension: String? = null
         if (input.containsKey("dimension"))
             dimension = (input["dimension"] ?: throwMalformedSectionError("dimension")) as String
 
-        var scale = this.ship.transform.shipToWorldScaling.x()
+        var scale = getShip().transform.shipToWorldScaling.x()
         if (input.containsKey("scale"))
             scale = (input["scale"] ?: throwMalformedSectionError("scale")) as Double
 
         val teleportData = ShipTeleportDataImpl(pos, rot, vel, omega, dimension, scale)
 
         println("Rot: ${teleportData.newRot}\n")
 
-        //vsCore.teleportShip(this.level.shipObjectWorld, this.ship, teleportData)
-        this.level.shipObjectWorld.teleportShip(this.ship, teleportData)
+        //vsCore.teleportShip(this.level.shipObjectWorld, getShip(), teleportData)
+        level.shipObjectWorld.teleportShip(getShip(), teleportData)
     }
 
     private fun getVectorFromTable(input: Map<*, *>, section: String): Vector3dc {

common/src/main/kotlin/io/github/techtastic/cc_vs/apis/LuaPhysShip.kt

@@ -2,48 +2,54 @@ package io.github.techtastic.cc_vs.apis
 
 import dan200.computercraft.api.lua.LuaFunction
 import io.github.techtastic.cc_vs.util.CCVSUtils.toLua
+import org.valkyrienskies.core.api.VSBeta
+import org.valkyrienskies.core.api.ships.ShipForcesInducer
+import org.valkyrienskies.core.impl.game.ships.PhysInertia
 import org.valkyrienskies.core.impl.game.ships.PhysShipImpl
 
-class LuaPhysShip(private val physShip: PhysShipImpl) {
+data class LuaPhysShip(
+    private val buoyantFactor: Double,
+    private val static: Boolean,
+    private val fluidDrag: Boolean,
+    private val inertia: Map<String, Any>,
+    private val poseVel: Map<String, Map<String, Double>>,
+    private val forceInducers: List<String>
+) {
+    @OptIn(VSBeta::class)
+    constructor(physShip: PhysShipImpl): this(
+        physShip.buoyantFactor, physShip.isStatic, physShip.doFluidDrag,
+        physShip.inertia.let { inertia ->
+            mapOf(
+                Pair("momentOfInertiaTensor", inertia.momentOfInertiaTensor.toLua()),
+                Pair("mass", inertia.shipMass)
+            )
+        },
+        physShip.poseVel.let { poseVel ->
+            mapOf(
+                Pair("vel", poseVel.vel.toLua()),
+                Pair("omega", poseVel.omega.toLua()),
+                Pair("pos", poseVel.pos.toLua()),
+                Pair("rot", poseVel.rot.toLua())
+            )
+        },
+        physShip.forceInducers.map(ShipForcesInducer::toString)
+    )
 
     @LuaFunction
-    fun getBuoyantFactor() = this.physShip.buoyantFactor
+    fun getBuoyantFactor() = this.buoyantFactor
 
     @LuaFunction
-    fun isStatic() = this.physShip.isStatic
+    fun isStatic() = this.static
 
     @LuaFunction
-    fun doFluidDrag() = this.physShip.doFluidDrag
+    fun doFluidDrag() = this.fluidDrag
 
     @LuaFunction
-    fun getInertia(): Map<String, Any> {
-        val inertia = this.physShip.inertia
-        return mapOf(
-            Pair("momentOfInertiaTensor", inertia.momentOfInertiaTensor.toLua()),
-            Pair("mass", inertia.shipMass)
-        )
-    }
+    fun getInertia() = this.inertia
 
     @LuaFunction
-    fun getPoseVel(): Map<String, Map<String, Double>> {
-        val poseVel = this.physShip.poseVel
-        return mapOf(
-            Pair("vel", poseVel.vel.toLua()),
-            Pair("omega", poseVel.omega.toLua()),
-            Pair("pos", poseVel.pos.toLua()),
-            Pair("rot", poseVel.rot.toLua())
-        )
-    }
+    fun getPoseVel() = this.poseVel
 
     @LuaFunction
-    fun getForcesInducers(): List<String> {
-        val inducers = this.physShip.forceInducers
-
-        val list = mutableListOf<String>()
-        inducers.forEach {
-            list.add(it.toString())
-        }
-
-        return list
-    }
+    fun getForcesInducers() = this.forceInducers
 }