cutscenes; format python

malytomas · malytomas · commit 10351a2963bf · 2025-07-02T21:15:22.000+02:00
diff --git a/c/uwapi/uwapi/modules/botsConnection.h b/c/uwapi/uwapi/modules/botsConnection.h
@@ -71,6 +71,7 @@ extern "C"
 	UNNATURAL_API void uwSetForceColor(float r, float g, float b); // [0 .. 1]
 	UNNATURAL_API void uwSetForceRace(uint32 raceProto);
 	UNNATURAL_API void uwForceJoinTeam(uint32 team);
+	UNNATURAL_API void uwSkipCutscene(void);
 
 	typedef struct UwMyPlayer
 	{
diff --git a/c/uwapi/uwapi/modules/game.h b/c/uwapi/uwapi/modules/game.h
@@ -21,10 +21,10 @@ extern "C"
 		UwGameStateEnum_Preparation = 2,
 		UwGameStateEnum_Starting = 3,
 		UwGameStateEnum_Game = 4,
-		UwGameStateEnum_Finish = 5,
-		UwGameStateEnum_Pause = 6,
-		UwGameStateEnum_CutscenePaused = 7,
-		UwGameStateEnum_CutsceneRunning = 8,
+		UwGameStateEnum_Pause = 5,
+		UwGameStateEnum_CutscenePaused = 6,
+		UwGameStateEnum_CutsceneRunning = 7,
+		UwGameStateEnum_Finish = 8,
 	} UwGameStateEnum;
 #ifdef UNNATURAL_BOTS
 	typedef void (*UwGameStateCallbackType)(UwGameStateEnum state);
diff --git a/c/uwapi/uwapi/modules/scriptsServer.h b/c/uwapi/uwapi/modules/scriptsServer.h
@@ -44,9 +44,17 @@ extern "C"
 	UNNATURAL_API void uwSetForeignPolicy(uint32 force1, uint32 force2, UwForeignPolicyEnum policy);
 
 	UNNATURAL_API uint32 uwCreateAiPlayer(void);
-	// UNNATURAL_API void uwDestroyAiPlayer(uint32 player);
 	UNNATURAL_API void uwSetPlayerAiConfig(uint32 player, const UwPlayerAiConfigComponent *config);
 	UNNATURAL_API void uwSetPlayerForce(uint32 player, uint32 force);
+	UNNATURAL_API void uwPlayerCamera(uint32 player, uint32 tileIndex, bool resetToDefaultZoomAndOrientation, float duration, float smooth); // use -1 to send to all players, use NaN for default values
+	UNNATURAL_API void uwPlayerCameraPosition(uint32 player, uint32 tileIndex, float yaw, float pitch, float eyeDistance, float duration, float smooth); // use -1 to send to all players, use NaN for default values
+	UNNATURAL_API void uwPlayerCameraTransform(uint32 player, const float targetPosition[3], const float eyePosition[3], const float eyeUp[3], float duration, float smooth); // use -1 to send to all players, use NaN for default values
+	UNNATURAL_API float uwPlayerDialogue(uint32 player, uint32 avatarId, uint32 voicelineId, uint32 translatedTextId); // use -1 to send to all players, use 0 for no avatar/voice/text, returns duration of the voice/text
+
+	UNNATURAL_API void uwCutsceneBegin(void);
+	UNNATURAL_API void uwCutsceneEnd(void);
+	UNNATURAL_API void uwCutsceneGameSimulation(bool runGameSimulation);
+	UNNATURAL_API float uwCutsceneTime(void); // seconds since start of the cutscene
 
 	UNNATURAL_API void uwStandardVictoryConditions(bool enable);
 	UNNATURAL_API void uwSendChat(const char *msg, UwChatTargetFlags flags, uint32 targetId);
diff --git a/csharp/uwapi/game.cs b/csharp/uwapi/game.cs
@@ -46,6 +46,11 @@ public static void ForceJoinTeam(uint team)
             Interop.uwForceJoinTeam(team);
         }
 
+        public static void SkipCutscene()
+        {
+            Interop.uwSkipCutscene();
+        }
+
         public static void SetConnectStartGui(bool startGui, string extraParams = "--observer 1")
         {
             Interop.uwSetConnectStartGui(startGui, extraParams);
diff --git a/csharp/uwapi/interop.cs b/csharp/uwapi/interop.cs
@@ -190,6 +190,9 @@ public static extern void uwConnectNewServer(uint visibility, [MarshalAs(Unmanag
         [DllImport(LibName, CallingConvention = CallingConvention.Cdecl)]
         public static extern void uwForceJoinTeam(uint team);
 
+        [DllImport(LibName, CallingConvention = CallingConvention.Cdecl)]
+        public static extern void uwSkipCutscene();
+
         [StructLayout(LayoutKind.Sequential)]
         public struct UwMyPlayer
         {
@@ -698,10 +701,10 @@ public enum UwGameStateEnum
             Preparation = 2,
             Starting = 3,
             Game = 4,
-            Finish = 5,
-            Pause = 6,
-            CutscenePaused = 7,
-            CutsceneRunning = 8,
+            Pause = 5,
+            CutscenePaused = 6,
+            CutsceneRunning = 7,
+            Finish = 8,
         }
 
         [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
diff --git a/python/uwapi/admin.py b/python/uwapi/admin.py
@@ -1,5 +1,6 @@
 from .interop import *
 
+
 class Admin:
     _instance = None
 
@@ -68,4 +69,5 @@ def send_chat(self, msg: str, flags, id: int = INVALID) -> None:
     def send_ping(self, position: int, ping, id: int) -> None:
         uw_interop.uwAdminSendPing(position, ping, id)
 
+
 uw_admin = Admin()
diff --git a/python/uwapi/bots.h b/python/uwapi/bots.h
@@ -147,6 +147,7 @@ void uwPlayerJoinForce(uint32 force);
 void uwSetForceColor(float r, float g, float b);
 void uwSetForceRace(uint32 raceProto);
 void uwForceJoinTeam(uint32 team);
+void uwSkipCutscene(void);
 
 typedef struct UwMyPlayer
 {
@@ -433,10 +434,10 @@ typedef enum UwGameStateEnum
 	UwGameStateEnum_Preparation = 2,
 	UwGameStateEnum_Starting = 3,
 	UwGameStateEnum_Game = 4,
-	UwGameStateEnum_Finish = 5,
-	UwGameStateEnum_Pause = 6,
-	UwGameStateEnum_CutscenePaused = 7,
-	UwGameStateEnum_CutsceneRunning = 8,
+	UwGameStateEnum_Pause = 5,
+	UwGameStateEnum_CutscenePaused = 6,
+	UwGameStateEnum_CutsceneRunning = 7,
+	UwGameStateEnum_Finish = 8,
 } UwGameStateEnum;
 
 typedef void (*UwGameStateCallbackType)(UwGameStateEnum state);
diff --git a/python/uwapi/commands.py b/python/uwapi/commands.py
@@ -1,5 +1,6 @@
 from .interop import *
 
+
 class Commands:
     _instance = None
 
@@ -54,14 +55,16 @@ def place_construction(
         position: int,
         yaw: float = 0,
         recipe_proto: int = 0,
-        priority: UwPriorityEnum = UwPriorityEnum.Normal
+        priority: UwPriorityEnum = UwPriorityEnum.Normal,
     ) -> None:
-        uw_interop.uwCommandPlaceConstruction(construction_proto, position, yaw, recipe_proto, priority)
+        uw_interop.uwCommandPlaceConstruction(
+            construction_proto, position, yaw, recipe_proto, priority
+        )
 
     def set_recipe(self, unit_id: int, recipe_proto: int) -> None:
         uw_interop.uwCommandSetRecipe(unit_id, recipe_proto)
 
-    def set_priority(self, unit_id: int, priority : UwPriorityEnum) -> None:
+    def set_priority(self, unit_id: int, priority: UwPriorityEnum) -> None:
         uw_interop.uwCommandSetPriority(unit_id, priority)
 
     def load(self, unit_id: int, resource_proto: int) -> None:
@@ -83,6 +86,9 @@ def self_destruct(self, entity_id: int) -> None:
         uw_interop.uwCommandSelfDestruct(entity_id)
 
     def _default_order(self) -> UwOrder:
-        return UwOrder(INVALID, INVALID, UwOrderTypeEnum.Nothing, UwOrderPriorityFlags.User)
+        return UwOrder(
+            INVALID, INVALID, UwOrderTypeEnum.Nothing, UwOrderPriorityFlags.User
+        )
+
 
 uw_commands = Commands()
diff --git a/python/uwapi/entity.py b/python/uwapi/entity.py
@@ -3,9 +3,11 @@
 from .interop import *
 from .prototypes import uw_prototypes, Prototype
 
+
 def _make_empty_UwUnitUpgrades() -> UwUnitUpgrades:
     return UwUnitUpgrades(0, 0, 0, 0, 0, 0, 0)
 
+
 @dataclass
 class Entity:
     id: int
@@ -40,10 +42,16 @@ def pos(self) -> int:
 
     def policy(self) -> UwForeignPolicyEnum:
         from .world import uw_world
-        return uw_world.policy(self.Owner.force) if self.Owner is not None else UwForeignPolicyEnum.Nothing
+
+        return (
+            uw_world.policy(self.Owner.force)
+            if self.Owner is not None
+            else UwForeignPolicyEnum.Nothing
+        )
 
     def own(self) -> bool:
         from .world import uw_world
+
         return self.Owner is not None and self.Owner.force == uw_world.my_force_id()
 
     def ally(self) -> bool:
@@ -53,7 +61,11 @@ def enemy(self) -> bool:
         return self.policy() == UwForeignPolicyEnum.Enemy
 
     def type(self) -> UwPrototypeTypeEnum:
-        return uw_prototypes.type(self.Proto.proto) if self.Proto is not None else UwPrototypeTypeEnum.Nothing
+        return (
+            uw_prototypes.type(self.Proto.proto)
+            if self.Proto is not None
+            else UwPrototypeTypeEnum.Nothing
+        )
 
     def proto(self) -> Prototype:
         if self.Proto is not None:
@@ -63,4 +75,9 @@ def proto(self) -> Prototype:
 
     def unit_upgrades(self) -> UwUnitUpgrades:
         from .world import uw_world
-        return uw_world.unit_upgrades(self.id) if self.type() == UwPrototypeTypeEnum.Unit else _make_empty_UwUnitUpgrades()
+
+        return (
+            uw_world.unit_upgrades(self.id)
+            if self.type() == UwPrototypeTypeEnum.Unit
+            else _make_empty_UwUnitUpgrades()
+        )
diff --git a/python/uwapi/events.py b/python/uwapi/events.py
@@ -2,6 +2,7 @@
 from typing import Callable, List
 from .interop import *
 
+
 class Events:
     _instance = None
     _connection_state_listeners: List[Callable[[UwConnectionStateEnum], None]] = []
@@ -33,7 +34,9 @@ def initialize(self) -> None:
 
     # ---------------------
 
-    def on_connection_state(self, listener: Callable[[UwConnectionStateEnum], None]) -> None:
+    def on_connection_state(
+        self, listener: Callable[[UwConnectionStateEnum], None]
+    ) -> None:
         self._connection_state_listeners.append(listener)
 
     def on_game_state(self, listener: Callable[[UwGameStateEnum], None]) -> None:
@@ -87,15 +90,20 @@ def _force_eliminated_callback(self, force: int) -> None:
         for listener in self._force_eliminated_listeners:
             listener(force)
 
-    def _chat_callback(self, message: str, sender: int, flags: UwChatTargetFlags) -> None:
+    def _chat_callback(
+        self, message: str, sender: int, flags: UwChatTargetFlags
+    ) -> None:
         for listener in self._chat_listeners:
             listener(message, sender, flags)
 
-    def _task_completed_callback(self, task_user_data: int, type: UwTaskTypeEnum) -> None:
-        pass # todo
+    def _task_completed_callback(
+        self, task_user_data: int, type: UwTaskTypeEnum
+    ) -> None:
+        pass  # todo
 
     def _map_state_callback(self, state: UwMapStateEnum) -> None:
         for listener in self._map_state_listeners:
             listener(state)
 
+
 uw_events = Events()
diff --git a/python/uwapi/game.py b/python/uwapi/game.py
@@ -1,5 +1,6 @@
 from .interop import *
 
+
 class Game:
     _instance = None
 
@@ -32,7 +33,12 @@ def set_force_race(self, race_proto: int) -> None:
     def force_join_team(self, team: int) -> None:
         uw_interop.uwForceJoinTeam(team)
 
-    def set_connect_start_gui(self, start_gui: bool, extra_params: str = "--observer 1") -> None:
+    def skip_cutscene(self) -> None:
+        uw_interop.uwSkipCutscene()
+
+    def set_connect_start_gui(
+        self, start_gui: bool, extra_params: str = "--observer 1"
+    ) -> None:
         uw_interop.uwSetConnectStartGui(start_gui, extra_params)
 
     def connect_find_lan(self, timeout_microseconds: int = 1000000) -> bool:
@@ -47,7 +53,9 @@ def connect_lobby_id(self, lobby_id: int) -> None:
     def connect_environment(self) -> bool:
         return uw_interop.uwConnectEnvironment()
 
-    def connect_new_server(self, visibility: int = 0, name: str = "", extra_params: str = "") -> None:
+    def connect_new_server(
+        self, visibility: int = 0, name: str = "", extra_params: str = ""
+    ) -> None:
         uw_interop.uwConnectNewServer(visibility, name, extra_params)
 
     def try_reconnect(self) -> bool:
@@ -80,4 +88,5 @@ def profiling_event_begin(self) -> int:
     def profiling_event_end(self, name: str, event_start_time: int) -> None:
         uw_interop.uwProfilingEventEnd(name, event_start_time)
 
+
 uw_game = Game()
diff --git a/python/uwapi/interop.py b/python/uwapi/interop.py
@@ -121,10 +121,10 @@ class UwGameStateEnum(Enum):
     Preparation = 2
     Starting = 3
     Game = 4
-    Finish = 5
-    Pause = 6
-    CutscenePaused = 7
-    CutsceneRunning = 8
+    Pause = 5
+    CutscenePaused = 6
+    CutsceneRunning = 7
+    Finish = 8
 
 class UwTaskTypeEnum(Enum):
     Nothing = 0
@@ -707,6 +707,9 @@ def uwSetForceRace(self, raceProto: int) -> None:
     def uwForceJoinTeam(self, team: int) -> None:
         self._api.uwForceJoinTeam(team)
 
+    def uwSkipCutscene(self) -> None:
+        self._api.uwSkipCutscene()
+
     def uwMyPlayer(self) -> Tuple[bool, UwMyPlayer]:
         data = self._ffi.new("UwMyPlayer *")
         ret = self._api.uwMyPlayer(data)
diff --git a/python/uwapi/library.py b/python/uwapi/library.py
@@ -4,6 +4,7 @@
 from .interop import *
 from .events import uw_events
 
+
 class UwapiLibrary:
     _instance = None
 
@@ -24,7 +25,9 @@ def __exit__(self, exc_type, exc_value, traceback):
         self.dispose()
 
     def initialize(self) -> None:
-        api_def = open(os.path.join(os.path.split(os.path.abspath(__file__))[0], "bots.h"), "r").read()
+        api_def = open(
+            os.path.join(os.path.split(os.path.abspath(__file__))[0], "bots.h"), "r"
+        ).read()
 
         steam_path = os.path.expanduser(self.library_path())
         print("looking for uw library in: " + steam_path, flush=True)
@@ -35,7 +38,7 @@ def initialize(self) -> None:
         self._api = self._ffi.dlopen(os.path.join(steam_path, self.library_name()))
 
         uw_interop.initialize(self._ffi, self._api)
-        uw_interop.uwInitialize(self._api.UW_VERSION) # type: ignore
+        uw_interop.uwInitialize(self._api.UW_VERSION)  # type: ignore
         uw_interop.uwInitializeConsoleLogger()
         uw_events.initialize()
 
@@ -45,12 +48,12 @@ def dispose(self) -> None:
         # attempting graceful closing causes the process to hung somewhere in steam shutdown code
         # we will instead terminate the process, skipping most of python's clean-up code
         print("terminating the process")
-        os._exit(0) # this is considered a success
+        os._exit(0)  # this is considered a success
 
-        #print("disposing of uwapi library")
-        #self._ffi = None
-        #self._api = None
-        #uw_interop.initialize(self._ffi, self._api)
+        # print("disposing of uwapi library")
+        # self._ffi = None
+        # self._api = None
+        # uw_interop.initialize(self._ffi, self._api)
 
     def library_path(self) -> str:
         steam_path = os.environ.get("UNNATURAL_ROOT", "")
diff --git a/python/uwapi/map.py b/python/uwapi/map.py
diff --git a/python/uwapi/prototypes.py b/python/uwapi/prototypes.py
diff --git a/python/uwapi/world.py b/python/uwapi/world.py
diff --git a/sphinx/source/concepts/programState.rst b/sphinx/source/concepts/programState.rst

Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,7 @@ extern "C"`
`71`	`71`	`UNNATURAL_API void uwSetForceColor(float r, float g, float b); // [0 .. 1]`
`72`	`72`	`UNNATURAL_API void uwSetForceRace(uint32 raceProto);`
`73`	`73`	`UNNATURAL_API void uwForceJoinTeam(uint32 team);`
	`74`	`+ UNNATURAL_API void uwSkipCutscene(void);`
`74`	`75`
`75`	`76`	`typedef struct UwMyPlayer`
`76`	`77`	`{`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,11 @@ public static void ForceJoinTeam(uint team)`
`46`	`46`	`Interop.uwForceJoinTeam(team);`
`47`	`47`	`}`
`48`	`48`
	`49`	`+ public static void SkipCutscene()`
	`50`	`+ {`
	`51`	`+ Interop.uwSkipCutscene();`
	`52`	`+ }`
	`53`	`+`
`49`	`54`	`public static void SetConnectStartGui(bool startGui, string extraParams = "--observer 1")`
`50`	`55`	`{`
`51`	`56`	`Interop.uwSetConnectStartGui(startGui, extraParams);`