Merge pull request #24 from TechTastic/1.19.x/update

1.19.x/update

Author: TechTastic

changelog.md

@@ -1,7 +1,8 @@
-Fixes
-- Removed the thorns in my side (getRoll, getPitch, getYaw)
-- Welcome to Quaternion to Euler conversions (added the following methods)
-  - getEulerAnglesXYZ
-  - getEulerAnglesYXZ
-  - getEulerAnglesZXY
-  - getEulerAnglesZYX
+# 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

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

@@ -7,7 +7,9 @@ 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.server.level.ServerLevel
+import org.checkerframework.common.reflection.qual.NewInstance
 import org.joml.Quaterniond
 import org.joml.Quaterniondc
 import org.joml.Vector3d
@@ -26,33 +28,69 @@ class ExtendedShipAPI(private val api: IAPIEnvironment, ship: ServerShip, level:
     }
 
     @LuaFunction
-    fun applyInvariantForce(xForce: Double, yForce: Double, zForce: Double) {
-        this.control.applyInvariantForce(Vector3d(xForce, yForce, zForce))
+    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)
     }
 
     @LuaFunction
-    fun applyInvariantTorque(xTorque: Double, yTorque: Double, zTorque: Double) {
-        this.control.applyInvariantTorque(Vector3d(xTorque, yTorque, zTorque))
+    fun applyInvariantTorque(args: IArguments) {
+        val newTorque =
+            if (args.count() == 1)
+                args.getTable(0).toVector()
+            else
+                Vector3d(args.getDouble(0), args.getDouble(1), args.getDouble(2))
+        this.control.applyInvariantTorque(newTorque)
     }
 
     @LuaFunction
-    fun applyInvariantForceToPos(xForce: Double, yForce: Double, zForce: Double, xPos: Double, yPos: Double, zPos: Double) {
-        this.control.applyInvariantForceToPos(Vector3d(xForce, yForce, zForce), Vector3d(xPos, yPos, zPos))
+    fun applyInvariantForceToPos(args: IArguments) {
+        val (newForce, newPos) =
+            if (args.count() == 2)
+                Pair(args.getTable(0).toVector(), args.getTable(1).toVector())
+            else
+                Pair(
+                    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)
     }
 
     @LuaFunction
-    fun applyRotDependentForce(xForce: Double, yForce: Double, zForce: Double) {
-        this.control.applyRotDependentForce(Vector3d(xForce, yForce, zForce))
+    fun applyRotDependentForce(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.applyRotDependentForce(newForce)
     }
 
     @LuaFunction
-    fun applyRotDependentTorque(xTorque: Double, yTorque: Double, zTorque: Double) {
-        this.control.applyRotDependentTorque(Vector3d(xTorque, yTorque, zTorque))
+    fun applyRotDependentTorque(args: IArguments) {
+        val newTorque =
+            if (args.count() == 1)
+                args.getTable(0).toVector()
+            else
+                Vector3d(args.getDouble(0), args.getDouble(1), args.getDouble(2))
+        this.control.applyRotDependentTorque(newTorque)
     }
 
     @LuaFunction
-    fun applyRotDependentForceToPos(xForce: Double, yForce: Double, zForce: Double, xPos: Double, yPos: Double, zPos: Double) {
-        this.control.applyRotDependentForceToPos(Vector3d(xForce, yForce, zForce), Vector3d(xPos, yPos, zPos))
+    fun applyRotDependentForceToPos(args: IArguments) {
+        val (newForce, newPos) =
+            if (args.count() == 2)
+                Pair(args.getTable(0).toVector(), args.getTable(1).toVector())
+            else
+                Pair(
+                    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)
     }
 
     @LuaFunction

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

@@ -1,16 +1,23 @@
 package io.github.techtastic.cc_vs.apis
 
+import dan200.computercraft.api.lua.IArguments
 import dan200.computercraft.api.lua.ILuaAPI
+import dan200.computercraft.api.lua.LuaException
 import dan200.computercraft.api.lua.LuaFunction
 import io.github.techtastic.cc_vs.mixin.ShipObjectWorldAccessor
+import io.github.techtastic.cc_vs.util.CCVSUtils
 import io.github.techtastic.cc_vs.util.CCVSUtils.toLua
+import io.github.techtastic.cc_vs.util.CCVSUtils.toVector
 import net.minecraft.server.level.ServerLevel
+import net.minecraft.world.phys.Vec3
 import org.joml.Vector3d
 import org.joml.Vector4d
 import org.joml.primitives.AABBi
 import org.valkyrienskies.core.api.ships.ServerShip
+import org.valkyrienskies.core.apigame.constraints.VSAttachmentConstraint
 import org.valkyrienskies.core.apigame.constraints.VSConstraintAndId
 import org.valkyrienskies.mod.common.shipObjectWorld
+import org.valkyrienskies.mod.common.util.toJOML
 import kotlin.math.asin
 import kotlin.math.atan2
 
@@ -42,7 +49,7 @@ open class ShipAPI(val ship: ServerShip, val level: ServerLevel) : ILuaAPI {
         this.ship.inertiaData.momentOfInertiaTensor.toLua()
 
     @LuaFunction
-    fun getName(): String = this.ship.slug ?: "no-name"
+    fun getSlug(): String = this.ship.slug ?: "no-name"
 
     @LuaFunction
     fun getOmega(): Map<String, Double> =
@@ -52,22 +59,6 @@ open class ShipAPI(val ship: ServerShip, val level: ServerLevel) : ILuaAPI {
     fun getQuaternion(): Map<String, Double> =
         this.ship.transform.shipToWorldRotation.toLua()
 
-    @LuaFunction
-    fun getEulerAnglesXYZ() =
-        this.ship.transform.shipToWorldRotation.getEulerAnglesXYZ(Vector3d()).toLua()
-
-    @LuaFunction
-    fun getEulerAnglesYXZ() =
-        this.ship.transform.shipToWorldRotation.getEulerAnglesYXZ(Vector3d()).toLua()
-
-    @LuaFunction
-    fun getEulerAnglesZXY() =
-        this.ship.transform.shipToWorldRotation.getEulerAnglesZXY(Vector3d()).toLua()
-
-    @LuaFunction
-    fun getEulerAnglesZYX() =
-        this.ship.transform.shipToWorldRotation.getEulerAnglesZYX(Vector3d()).toLua()
-
     @LuaFunction
     fun getScale(): Map<String, Double> =
         this.ship.transform.shipToWorldScaling.toLua()
@@ -95,14 +86,20 @@ open class ShipAPI(val ship: ServerShip, val level: ServerLevel) : ILuaAPI {
         this.ship.transform.positionInWorld.toLua()
 
     @LuaFunction
-    fun transformPositionToWorld(x: Double, y: Double, z: Double): Map<String, Double> =
-        this.ship.shipToWorld.transformPosition(Vector3d(x, y, z)).toLua()
+    fun transformPositionToWorld(args: IArguments): Map<String, Double> {
+        val pos =
+            if (args.count() == 1)
+                Vector3d(args.getTable(0).toVector())
+            else
+                Vector3d(args.getDouble(0), args.getDouble(1), args.getDouble(2))
+        return this.ship.shipToWorld.transformPosition(pos).toLua()
+    }
 
     @LuaFunction
     fun isStatic(): Boolean = this.ship.isStatic
 
     @LuaFunction
-    fun setName(name: String) {
+    fun setSlug(name: String) {
         this.ship.slug = name
     }
 

common/src/main/kotlin/io/github/techtastic/cc_vs/ship/PhysTickEventHandler.kt

@@ -5,34 +5,38 @@ import io.github.techtastic.cc_vs.PlatformUtils
 import io.github.techtastic.cc_vs.apis.LuaPhysShip
 import org.valkyrienskies.core.api.ships.*
 import org.valkyrienskies.core.impl.game.ships.PhysShipImpl
+import java.util.concurrent.ConcurrentLinkedQueue
 
-class PhysTickEventHandler: ShipForcesInducer {
+class PhysTickEventHandler: ShipForcesInducer, ServerTickListener {
     @JsonIgnore
     private val computers = mutableListOf<Int>()
+    private val queuedData = ConcurrentLinkedQueue<LuaPhysShip>()
 
     override fun applyForces(physShip: PhysShip) {
         if (!PlatformUtils.exposePhysTick())
             return
 
-        val physShip = physShip as PhysShipImpl
-
-        this.computers.removeIf { PlatformUtils.getComputerByID(it) == null }
-
-        this.computers.forEach {
-            PlatformUtils.getComputerByID(it)?.queueEvent("physics_tick", arrayOf(LuaPhysShip(physShip)))
-        }
+        this.queuedData.add(LuaPhysShip(physShip as PhysShipImpl))
     }
 
     fun addComputer(id: Int) {
         this.computers.add(id)
     }
 
+    override fun onServerTick() {
+        this.computers.removeIf { PlatformUtils.getComputerByID(it) == null }
+        this.computers.forEach {
+            PlatformUtils.getComputerByID(it)?.queueEvent("physics_ticks", this.queuedData.toTypedArray())
+        }
+        this.queuedData.clear()
+    }
+
     companion object {
         fun getOrCreateControl(ship: ServerShip): PhysTickEventHandler {
-            var control = ship.getAttachment(PhysTickEventHandler::class.java)
+            var control = ship.getAttachment<PhysTickEventHandler>()
             if (control == null) {
                 control = PhysTickEventHandler()
-                ship.saveAttachment(PhysTickEventHandler::class.java, control)
+                ship.saveAttachment<PhysTickEventHandler>(control)
             }
 
             return control

common/src/main/kotlin/io/github/techtastic/cc_vs/util/CCVSUtils.kt

@@ -1,5 +1,6 @@
 package io.github.techtastic.cc_vs.util
 
+import dan200.computercraft.api.lua.LuaException
 import dan200.computercraft.shared.computer.core.ComputerFamily
 import dan200.computercraft.shared.computer.core.ServerComputer
 import io.github.techtastic.cc_vs.PlatformUtils
@@ -121,4 +122,11 @@ object CCVSUtils {
 
         return constraint
     }
+
+    fun Map<*, *>.toVector(): Vector3dc {
+        val posTable = this as? Map<String, Double>
+            ?: throw LuaException("Invalid Argument! Expects either a vector or a table with x, y, and z keys!")
+
+        return Vector3d(posTable["x"] ?: 0.0, posTable["y"] ?: 0.0, posTable["z"] ?: 0.0)
+    }
 }