Add altimeter peripheral

Author: blockninja124

common/src/main/kotlin/org/valkyrienskies/clockwork/integration/cc/AltMeterPeripheral.kt

@@ -0,0 +1,60 @@
+@file:Suppress("unused")
+
+package org.valkyrienskies.clockwork.integration.cc
+
+import dan200.computercraft.api.lua.LuaException
+import dan200.computercraft.api.lua.LuaFunction
+import dan200.computercraft.api.peripheral.IPeripheral
+import org.valkyrienskies.clockwork.content.curiosities.altmeter.AltMeterBlockEntity
+import org.valkyrienskies.mod.api.toJOML
+import org.valkyrienskies.mod.common.getLoadedShipManagingPos
+
+class AltMeterPeripheral(private val be: AltMeterBlockEntity): IPeripheral {
+    @LuaFunction
+    fun getHeight(): Double {
+        val ship = be.level.getLoadedShipManagingPos(be.blockPos)
+        val pos = be.blockPos.center
+        val height = ship?.transform?.shipToWorld?.transformPosition(pos.toJOML())?.y ?: pos.y
+        return height
+    }
+
+    @LuaFunction
+    fun getOutput(): Int = be.signalStrength
+
+    @LuaFunction
+    fun getTargetHeight(): Int = be.triggerHeight
+
+    @LuaFunction
+    fun setTargetHeight(height: Int) {
+        be.triggerHeight = height
+        be.notifyUpdate()
+    }
+
+    @LuaFunction
+    fun getSensitivity(): Int = be.triggerSensitivity
+
+    @LuaFunction
+    fun setSensitivity(sensitivity: Int) {
+        be.triggerSensitivity = sensitivity
+        be.notifyUpdate()
+    }
+
+    @LuaFunction
+    fun getDirection(): String = be.triggerDirection.name
+
+    @LuaFunction
+    fun setDirection(direction: String) {
+        try {
+            be.triggerDirection = AltMeterBlockEntity.AltMeterDirection.valueOf(direction.uppercase())
+            be.notifyUpdate()
+        } catch (e: IllegalArgumentException) {
+            throw LuaException(
+                "Direction must be one of: " +
+                        AltMeterBlockEntity.AltMeterDirection.entries.joinToString(", ") { it.name }
+            )
+        }
+    }
+
+    override fun equals(p0: IPeripheral?): Boolean = be.blockPos == (p0 as? AltMeterPeripheral)?.be?.blockPos
+    override fun getType(): String = "cw_alt_meter"
+}

common/src/main/kotlin/org/valkyrienskies/clockwork/integration/cc/getPeripheralCommon.kt

@@ -7,13 +7,15 @@ import net.minecraft.world.level.block.entity.BlockEntityType
 import org.valkyrienskies.clockwork.ClockworkBlockEntities
 import org.valkyrienskies.clockwork.content.contraptions.flap.FlapBearingBlockEntity
 import org.valkyrienskies.clockwork.content.contraptions.phys.bearing.PhysBearingBlockEntity
+import org.valkyrienskies.clockwork.content.curiosities.altmeter.AltMeterBlockEntity
 import org.valkyrienskies.clockwork.content.logistics.gas.pockets.nozzle.GasNozzleBlockEntity
 
 val PERIPHERALS = mapOf<BlockEntityType<*>, (BlockEntity, Direction?) -> IPeripheral>(
     ClockworkBlockEntities.PHYS_BEARING.get() to {be, _ -> PhysBearingPeripheral(be as PhysBearingBlockEntity)},
     ClockworkBlockEntities.GAS_NOZZLE.get() to {be, _ -> GasNozzlePeripheral(be as GasNozzleBlockEntity)},
     ClockworkBlockEntities.FLAP_BEARING.get() to {be, _ -> FlapBearingPeripheral(be as FlapBearingBlockEntity)},
-    ClockworkBlockEntities.SMART_FLAP_BEARING.get() to {be, _ -> FlapBearingPeripheral(be as FlapBearingBlockEntity)}
+    ClockworkBlockEntities.SMART_FLAP_BEARING.get() to {be, _ -> FlapBearingPeripheral(be as FlapBearingBlockEntity)},
+    ClockworkBlockEntities.ALT_METER.get() to {be, _ -> AltMeterPeripheral(be as AltMeterBlockEntity)}
 )
 
 fun getPeripheralCommon(be: BlockEntity, direction: Direction?): IPeripheral? = PERIPHERALS[be.type]?.invoke(be, direction)

peripherals.md

@@ -394,6 +394,79 @@ Returns `true`, unless the bearing was already disassembled, in which case it wi
 
 ---
 
+## Altimeter peripheral
+
+Peripheral type: `cw_alt_meter`
+
+---
+
+```lua
+getHeight() -> number
+```
+
+Returns the current height the altimeter is at. 
+If the altimeter is on a ship, the height is automatically transformed from the shipyard into worldspace.
+
+---
+
+```lua
+getOutput() -> number
+```
+
+Gets the current redstone signal strength the altimeter is outputting, in the range `0..15`.
+
+---
+
+```lua
+getTargetHeight() -> number
+```
+
+Returns the target height the altimeter is currently set to.
+
+---
+
+```lua
+setTargetHeight(height: number)
+```
+
+Sets the target height of the altimeter. If `height` has decimals, they will be truncated.
+
+---
+
+```lua
+getSensitivity() -> number
+```
+
+Returns the sensitivity the altimeter is currently set to.
+
+---
+
+```lua
+setSensitivity(sensitivity: number)
+```
+
+Sets the sensitivity of the altimeter. If `sensitivity` has decimals, they will be truncated.
+
+---
+
+```lua
+getDirection() -> string
+```
+
+Returns the current direction mode of the altimeter. Will be one of: `UP`, `DOWN` or `BOTH`.
+
+---
+
+```lua
+setDirection(direction: string)
+```
+
+Sets the current direction mode of the altimeter. Not uppercase sensitive.
+
+Throws if `direction` is not one of: `UP`, `DOWN` or `BOTH`. 
+
+---
+
 This page is still a work in progress. 
 
 Spot an error, or want to add extra information?