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,12 +12,18 @@ 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
 import com.typewritermc.engine.paper.events.AsyncCinematicTickEvent
 import com.typewritermc.engine.paper.interaction.*
+import com.typewritermc.engine.paper.utils.GenericPlayerStateProvider
+import com.typewritermc.engine.paper.utils.PlayerState
+import com.typewritermc.engine.paper.utils.restore
+import com.typewritermc.engine.paper.utils.state
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.coroutineScope
 import kotlinx.coroutines.joinAll
@@ -37,6 +43,7 @@ class TemporalInteraction(
         private set
     private var playTime = Duration.ofMillis(-1)
     val frame: Int get() = (playTime.toMillis() / 50).toInt()
+    private var savedVelocityState: PlayerState? = null
 
     override val priority by lazy { Query.findPageById(pageId)?.priority ?: 0 }
 
@@ -54,6 +61,7 @@ class TemporalInteraction(
 
         if (settings.blockChatMessages) player.startBlockingMessages()
         if (settings.blockActionBarMessages) player.startBlockingActionBar()
+        if (settings.restoreVelocity) savedVelocityState = player.state(GenericPlayerStateProvider.VELOCITY)
 
         actions = Query.findWhereFromPage<CinematicEntry>(pageId) {
             it.criteria.matches(player, context)
@@ -113,6 +121,7 @@ class TemporalInteraction(
             player.chatHistory.resendMessages(player)
         }
         if (settings.blockActionBarMessages) player.stopBlockingActionBar()
+        if (settings.restoreVelocity) player.restore(savedVelocityState)
 
         actions.forEach {
             try {
@@ -164,6 +173,7 @@ data class TemporalStartTrigger(
 data class TemporalSettings(
     val blockChatMessages: Boolean = true,
     val blockActionBarMessages: Boolean = true,
+    val restoreVelocity: Boolean = false,
 )
 
 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() {}
 }