feat: add restore velocity option after cinematic finishes

Author: steveb05

engine/engine-paper/src/main/kotlin/com/typewritermc/engine/paper/entry/temporal/TemporalInteraction.kt

@@ -12,7 +12,9 @@ import com.typewritermc.engine.paper.entry.entries.CinematicAction
 import com.typewritermc.engine.paper.entry.entries.CinematicEntry
 import com.typewritermc.engine.paper.entry.entries.EventTrigger
 import com.typewritermc.engine.paper.entry.matches
-import com.typewritermc.engine.paper.entry.temporal.TemporalState.*
+import com.typewritermc.engine.paper.entry.temporal.TemporalState.ENDING
+import com.typewritermc.engine.paper.entry.temporal.TemporalState.PLAYING
+import com.typewritermc.engine.paper.entry.temporal.TemporalState.STARTING
 import com.typewritermc.engine.paper.entry.triggerFor
 import com.typewritermc.engine.paper.events.AsyncCinematicEndEvent
 import com.typewritermc.engine.paper.events.AsyncCinematicStartEvent

engine/engine-paper/src/main/kotlin/com/typewritermc/engine/paper/utils/PlayerState.kt

@@ -11,6 +11,7 @@ import com.github.retrooper.packetevents.util.Dummy
 import com.github.retrooper.packetevents.wrapper.play.server.WrapperPlayServerSetSlot
 import com.github.retrooper.packetevents.wrapper.play.server.WrapperPlayServerTimeUpdate
 import com.github.retrooper.packetevents.wrapper.play.server.WrapperPlayServerWindowItems
+import com.typewritermc.core.utils.point.Vector
 import com.typewritermc.engine.paper.extensions.packetevents.sendPacketTo
 import com.typewritermc.engine.paper.interaction.InterceptionBundle
 import com.typewritermc.engine.paper.plugin
@@ -45,6 +46,7 @@ enum class GenericPlayerStateProvider(private val store: Player.() -> Any, priva
         resetPlayerTime()
         WrapperPlayServerTimeUpdate(world.gameTime, playerTime).sendPacketTo(this)
     }),
+    VELOCITY({ velocity.toVector() }, { velocity = (it as Vector).toBukkitVector() }),
 
     // All Players that are visible to the player
     VISIBLE_PLAYERS({
@@ -125,6 +127,10 @@ fun Player.state(keys: Array<out PlayerStateProvider>): PlayerState {
     return PlayerState(keys.associateWith { it.store(this) })
 }
 
+fun Player.state(keys: List<PlayerStateProvider>): PlayerState {
+    return PlayerState(keys.associateWith { it.store(this) })
+}
+
 fun Player.restore(state: PlayerState?) {
     state?.state?.forEach { (key, value) -> key.restore(this, value) }
 }

extensions/BasicExtension/src/main/kotlin/com/typewritermc/basic/entries/cinematic/CameraCinematicEntry.kt

@@ -82,6 +82,7 @@ class CameraCinematicEntry(
     @Segments(icon = "fa6-solid:video")
     @InnerMin(Min(10))
     val segments: List<CameraSegment> = emptyList(),
+    val advancedCameraSettings: AdvancedCameraSettings = AdvancedCameraSettings(),
 ) : PrimaryCinematicEntry {
     override fun create(player: Player): CinematicAction {
         return CameraCinematicAction(
@@ -106,6 +107,16 @@ data class CameraSegment(
     val path: List<PathPoint> = emptyList(),
 ) : Segment
 
+/**
+ * Advanced settings for camera cinematics.
+ *
+ * @property restoreVelocity When true, restores the player's velocity to its pre-cinematic value
+ *                           after the cinematic finishes.
+ */
+data class AdvancedCameraSettings(
+    val restoreVelocity: Boolean = false
+)
+
 data class PathPoint(
     @WithRotation
     val location: Var<Position> = ConstVar(Position.ORIGIN),
@@ -187,12 +198,15 @@ class CameraCinematicAction(
 
         if (originalState == null) {
             originalState = state(
-                LOCATION,
-                ALLOW_FLIGHT,
-                FLYING,
-                VISIBLE_PLAYERS,
-                SHOWING_PLAYER,
-                EffectStateProvider(INVISIBILITY)
+                listOfNotNull(
+                    LOCATION,
+                    ALLOW_FLIGHT,
+                    FLYING,
+                    VISIBLE_PLAYERS,
+                    SHOWING_PLAYER,
+                    EffectStateProvider(INVISIBILITY),
+                    VELOCITY.takeIf { entry.advancedCameraSettings.restoreVelocity }
+                )
             )
             context[PlayerPositionOverride] = position
         }