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
@@ -163,7 +165,7 @@ data class TemporalStartTrigger(
 
 data class TemporalSettings(
     val blockChatMessages: Boolean = true,
-    val blockActionBarMessages: Boolean = true,
+    val blockActionBarMessages: Boolean = true
 )
 
 data object TemporalStopTrigger : EventTrigger {

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

@@ -23,6 +23,7 @@ import org.bukkit.inventory.EquipmentSlot
 import org.bukkit.inventory.ItemStack
 import org.bukkit.potion.PotionEffect
 import org.bukkit.potion.PotionEffectType
+import org.bukkit.util.Vector
 
 interface PlayerStateProvider {
     fun store(player: Player): Any
@@ -45,6 +46,7 @@ enum class GenericPlayerStateProvider(private val store: Player.() -> Any, priva
         resetPlayerTime()
         WrapperPlayServerTimeUpdate(world.gameTime, playerTime).sendPacketTo(this)
     }),
+    VELOCITY({ velocity }, { velocity = it as Vector }),
 
     // All Players that are visible to the player
     VISIBLE_PLAYERS({

extensions/BasicExtension/src/main/kotlin/com/typewritermc/basic/entries/action/CinematicEntry.kt

@@ -45,10 +45,13 @@ class CinematicEntry(
     val blockChatMessages: Boolean = true,
     @Default("true")
     @Help("Whether to block actionbar messages from showing to the player while in the cinematic.")
-    val blockActionBarMessages: Boolean = true
+    val blockActionBarMessages: Boolean = true,
+    @Default("false")
+    @Help("Whether to restore the player's velocity after the cinematic finishes.")
+    val restoreVelocity: Boolean = false
 ) : ActionEntry {
     override val eventTriggers: List<EventTrigger>
-        get() = listOf(TemporalStartTrigger(pageId, super.eventTriggers, TemporalSettings(blockChatMessages, blockActionBarMessages)))
+        get() = listOf(TemporalStartTrigger(pageId, super.eventTriggers, TemporalSettings(blockChatMessages, blockActionBarMessages, restoreVelocity)))
 
     override fun ActionTrigger.execute() {}
 }

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,10 @@ data class CameraSegment(
     val path: List<PathPoint> = emptyList(),
 ) : Segment
 
+data class AdvancedCameraSettings(
+    val restoreVelocity: Boolean = false
+)
+
 data class PathPoint(
     @WithRotation
     val location: Var<Position> = ConstVar(Position.ORIGIN),
@@ -187,12 +192,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 }
+                ).toTypedArray()
             )
             context[PlayerPositionOverride] = position
         }