add python prototypes extractor; fix some docs

malytomas · malytomas · commit d4c4cf1a74ed · 2025-08-30T00:37:15.000+02:00
diff --git a/c/uwapi/uwapi/modules/common.h b/c/uwapi/uwapi/modules/common.h
@@ -34,7 +34,7 @@ extern "C"
 	typedef uint64_t uint64;
 	typedef int64_t sint64;
 
-	static const uint32 UW_VERSION = 42;
+	static const uint32 UW_VERSION = 43;
 	static const uint32 UW_GameTicksPerSecond = 20;
 
 	typedef struct UwIds
diff --git a/csharp/uwapi/interop.cs b/csharp/uwapi/interop.cs
@@ -317,7 +317,7 @@ public static extern void uwCommandPlaceConstruction(uint constructionProto, uin
         [DllImport(LibName, CallingConvention = CallingConvention.Cdecl)]
         public static extern void uwCommandSelfDestruct(uint entityId);
 
-        public const uint UW_VERSION = 42;
+        public const uint UW_VERSION = 43;
         public const uint UW_GameTicksPerSecond = 20;
         [StructLayout(LayoutKind.Sequential)]
         public struct UwIds
diff --git a/python/prototypes.py b/python/prototypes.py
@@ -0,0 +1,39 @@
+from uwapi import *
+
+class Extractor:    
+    def __init__(self):
+        uw_events.on_map_state(self.map_state)
+
+    def map_state(self, state: MapState):
+        if state == MapState.Loaded:
+            self.extract()
+            uw_game.disconnect()
+
+    def extract(self):
+        uw_game.log_info("extracting")
+
+        types = {}
+        for proto_id, prototype in uw_prototypes._all.items():
+            if prototype.type not in types:
+                types[prototype.type] = {}
+            types[prototype.type][proto_id] = prototype
+
+        output = ""
+        for type, mapping in types.items():
+            output += f"## {type.name}\n"
+            for id, prototype in sorted(mapping.items(), key=lambda x: x[1].name):
+                output += f"{prototype.name}: {id}\n"
+            output += f"\n\n"
+
+        with open("prototypes.md", "w") as f:
+            f.write(output)
+
+        uw_game.log_info("extraction done")
+
+    def run(self):
+        uw_game.set_connect_start_gui(True)
+        uw_game.connect_new_server()
+
+if __name__ == "__main__":
+    with UwapiLibrary():
+        Extractor().run()
diff --git a/python/uwapi/bots.h b/python/uwapi/bots.h
@@ -9,7 +9,7 @@ typedef int32_t sint32;
 typedef uint64_t uint64;
 typedef int64_t sint64;
 
-static const uint32 UW_VERSION = 42;
+static const uint32 UW_VERSION = 43;
 static const uint32 UW_GameTicksPerSecond = 20;
 
 typedef struct UwIds
diff --git a/sphinx/source/concepts/callbacks.rst b/sphinx/source/concepts/callbacks.rst
@@ -40,7 +40,7 @@ Make sure to carefully decode them, as shown in the example below.
               index = 0
               while index < len(data):
                   control = uw_events.shooting_control_data(data[index])
-                  if control.type == UwShootingEventEnum.Shooting:
+                  if control.type == ShootingEvent.Shooting:
                       shooter_id = data[index + 1]
                       for i in range(1, control.count):
                           target_id = data[index + i + 1]
@@ -80,22 +80,22 @@ Make sure to carefully decode them, as shown in the example below.
           extern "C"
           void uwShootingsCallback(const UwShootingsArray *data)
           {
-          	const auto shooting = uw::makeVector(data);
-          	uint32 index = 0;
-          	while (index < shooting.size())
-          	{
-          		const auto control = uw::shootingControlData(shooting[index]);
-          		if (control.type == UwShootingEventEnum_Shooting)
-          		{
-          			const uint32 shooterId = shooting[index + 1];
-          			for (uint32 i = 1; i < control.count; i++)
-          			{
-          				const uint32 targetId = shooting[index + i + 1];
-          				// handle shooting event
-          			}
-          		}
-          		index += control.count + 1;
-          	}
+              const auto shooting = uw::makeVector(data);
+              uint32 index = 0;
+              while (index < shooting.size())
+              {
+                  const auto control = uw::shootingControlData(shooting[index]);
+                  if (control.type == UwShootingEventEnum_Shooting)
+                  {
+                      const uint32 shooterId = shooting[index + 1];
+                      for (uint32 i = 1; i < control.count; i++)
+                      {
+                          const uint32 targetId = shooting[index + i + 1];
+                          // handle shooting event
+                      }
+                  }
+                  index += control.count + 1;
+              }
           }
 
 Task Completed Callback
diff --git a/sphinx/source/concepts/economy.rst b/sphinx/source/concepts/economy.rst
@@ -15,14 +15,14 @@ Producing units or researching upgrades works the same way as recipes.
           # find closest viable position for miner:
           p = uw_world.find_construction_placement(DRILL_CONSTRUCTION_ID, home_position, METAL_RECIPE_ID) # recipe id is optional
           if p == INVALID:
-            return
+              return
 
           # place construction:
-          uw_commands.place_construction(DRILL_CONSTRUCTION_ID, p, 0, METAL_RECIPE_ID, UwPriorityEnum.Normal) # yaw, recipe, and priority are optional
+          uw_commands.place_construction(DRILL_CONSTRUCTION_ID, p, 0, METAL_RECIPE_ID, Priority.High) # yaw, recipe, and priority are optional
           
           # recipe and priority can be changed later:
           uw_commands.set_recipe(own_id, ANOTHER_RECIPE_ID)
-          uw_commands.set_priority(own_id, UwPriorityEnum.High)
+          uw_commands.set_priority(own_id, Priority.Normal)
 
    .. tab-item:: C#
       :sync: csharp
@@ -32,14 +32,14 @@ Producing units or researching upgrades works the same way as recipes.
           // find closest viable position for miner:
           uint p = World.FindConstructionPlacement(DRILL_CONSTRUCTION_ID, homePosition, METAL_RECIPE_ID); // recipe id is optional
           if (p == Entity.Invalid):
-            return;
+              return;
 
           // place construction:
-          Commands.PlaceConstruction(DRILL_CONSTRUCTION_ID, p, 0, METAL_RECIPE_ID, Interop.UwPriorityEnum.Normal); // yaw, recipe, and priority are optional
+          Commands.PlaceConstruction(DRILL_CONSTRUCTION_ID, p, 0, METAL_RECIPE_ID, UwPriorityEnum.High); // yaw, recipe, and priority are optional
           
           // recipe and priority can be changed later:
           Commands.SetRecipe(own_id, ANOTHER_RECIPE_ID)
-          Commands.SetPriority(own_id, Interop.UwPriorityEnum.High)
+          Commands.SetPriority(own_id, UwPriorityEnum.Normal)
 
    .. tab-item:: C++
       :sync: cpp
diff --git a/sphinx/source/concepts/entities.rst b/sphinx/source/concepts/entities.rst
@@ -74,11 +74,17 @@ It is forbidden to change eg. from unit to resource.
 
           x = uw_world.entity(id)
 
+          # check if entity has Proto component:
+          x.Proto is not None
+
           # find type (unit, resource, construction, ...) of the entity:
           x.type()
 
-          # check if entity has Proto component:
-          x.Proto is not None
+          # check if entity is a unit:
+          x.type() == PrototypeType.Unit
+
+          # alternative check if entity is a unit (only units have the Unit component):
+          x.Unit is not None
 
           # find id of the prototype of an entity:
           x.Proto.proto # assumes that the entity actually has Proto component
@@ -93,12 +99,18 @@ It is forbidden to change eg. from unit to resource.
 
           Entity x = World.Entity(id);
 
-          // find type (unit, resource, construction, ...) of the entity:
-          x.type
-
           // check if entity has Proto component:
           x.Proto.HasValue
 
+          // find type (unit, resource, construction, ...) of the entity:
+          x.Type
+
+          // check if entity is a unit:
+          x.Type == UwPrototypeTypeEnum.Unit
+
+          // alternative check if entity is a unit (only units have the Unit component):
+          x.Unit.HasValue
+
           // find id of the prototype of an entity:
           x.Proto.Value.proto // assumes that the entity actually has Proto component
 
@@ -142,8 +154,8 @@ Immutable.
           x.Owner.Value.force
 
           // check if entity is own or enemy:
-          x.Own()
-          x.Enemy()
+          x.Own
+          x.Enemy
 
    .. tab-item:: C++
       :sync: cpp
@@ -212,7 +224,7 @@ Contains additional state for a unit (or building).
       .. code-block:: python
 
           # check if unit is Processing:
-          (x.Unit.state & UwUnitStateFlags.Processing) != 0
+          (x.Unit.state & UnitState.Processing) != 0
 
    .. tab-item:: C#
       :sync: csharp
diff --git a/sphinx/source/concepts/map.rst b/sphinx/source/concepts/map.rst
@@ -88,16 +88,16 @@ There are multiple functions for finding tiles within some distance.
 
       .. code-block:: python
 
-          # find all connected tiles around home position:
-          uw_map.area_connected(home_position, 300)
+          # find all connected tiles around a position, up to 300 meters:
+          uw_map.area_connected(tile_index, 300)
 
    .. tab-item:: C#
       :sync: csharp
 
       .. code-block:: csharp
 
-          // find all connected tiles around home position:
-          Map.AreaConnected(homePosition, 300)
+          // find all connected tiles around a position, up to 300 meters:
+          Map.AreaConnected(tileIndex, 300)
 
    .. tab-item:: C++
       :sync: cpp
diff --git a/sphinx/source/concepts/military.rst b/sphinx/source/concepts/military.rst
@@ -25,7 +25,7 @@ You can have multiple orders queued for each unit.
           
           # alternatively, enqueue attack order:
           o = uw_commands.fight_to_entity(enemy_id)
-          o.priority = o.priority | UwOrderPriorityFlags.Enqueue
+          o.priority = o.priority | OrderPriority.Enqueue
           uw_commands.order(own_id, o)
 
    .. tab-item:: C#
@@ -41,7 +41,7 @@ You can have multiple orders queued for each unit.
           
           // alternatively, enqueue attack order:
           Order o = Commands.FightToEntity(enemy_id);
-          o.priority |= Interop.UwOrderPriorityFlags.Enqueue;
+          o.priority |= UwOrderPriorityFlags.Enqueue;
           Commands.Order(own_id, o);
 
    .. tab-item:: C++
