better explain area queries

Author: malytomas

c/uwapi/uwapi/modules/botsConnection.h

@@ -56,7 +56,7 @@ extern "C"
 	// connect
 
 	UNNATURAL_API void uwSetConnectStartGui(bool enabled, const char *extraCmdParams);
-	UNNATURAL_API void uwSetConnectAsync(bool async);
+	UNNATURAL_API void uwSetConnectAsync(bool enabled);
 	UNNATURAL_API bool uwConnectFindLan(uint64 timeoutMicroseconds);
 	UNNATURAL_API void uwConnectDirect(const char *address, uint16 port);
 	UNNATURAL_API void uwConnectLobbyId(uint64 lobbyId);

csharp/uwapi/interop.cs

@@ -154,7 +154,7 @@ public static extern void uwSetConnectStartGui([MarshalAs(UnmanagedType.I1)] boo
                                                        [MarshalAs(UnmanagedType.LPStr)] string extraCmdParams);
 
         [DllImport(LibName, CallingConvention = CallingConvention.Cdecl)]
-        public static extern void uwSetConnectAsync([MarshalAs(UnmanagedType.I1)] bool async);
+        public static extern void uwSetConnectAsync([MarshalAs(UnmanagedType.I1)] bool enabled);
 
         [DllImport(LibName, CallingConvention = CallingConvention.Cdecl)]
         [return:MarshalAs(UnmanagedType.I1)]

python/uwapi/bots.h

@@ -131,7 +131,7 @@ void uwSetConnectionStateCallback(UwConnectionStateCallbackType callback);
 UwConnectionStateEnum uwConnectionState(void);
 
 void uwSetConnectStartGui(bool enabled, const char *extraCmdParams);
-void uwSetConnectAsync(bool async);
+void uwSetConnectAsync(bool enabled);
 bool uwConnectFindLan(uint64 timeoutMicroseconds);
 void uwConnectDirect(const char *address, uint16 port);
 void uwConnectLobbyId(uint64 lobbyId);

python/uwapi/interop.py

@@ -642,8 +642,8 @@ def uwSetConnectStartGui(self, enabled: bool, extraCmdParams: str) -> None:
         extraCmdParams_ = self._str_pytoc(extraCmdParams)
         self._api.uwSetConnectStartGui(enabled, extraCmdParams_)
 
-    def uwSetConnectAsync(self, async: bool) -> None:
-        self._api.uwSetConnectAsync(async)
+    def uwSetConnectAsync(self, enabled: bool) -> None:
+        self._api.uwSetConnectAsync(enabled)
 
     def uwConnectFindLan(self, timeoutMicroseconds: int) -> bool:
         ret = self._api.uwConnectFindLan(timeoutMicroseconds)

sphinx/source/bots/programOverview.rst

@@ -106,6 +106,9 @@ The game is designed for multiplayer, and always plays over network, even in sin
 
 Any actions that you do in your program are first send to the game server, then processed, and then the results are send back to your client.
 
+.. important::
+   Some actions will *not* appear until after round-trip to server. Eg. placing a construction.
+
 Example: you call a function to place a construction.
 After that you look through all the entities and the construction is not there, as expected.
 You will not know the id of the entity either.

sphinx/source/concepts/map.rst

@@ -56,6 +56,8 @@ There are multiple functions for finding tiles within some distance.
 
          **Area Range**
 
+         Given *3D coordinates* and a radius, returns all tiles within the defined sphere, including tiles that may appear opposite of the rest.
+
    .. grid-item::
 
       .. card::
@@ -64,6 +66,8 @@ There are multiple functions for finding tiles within some distance.
 
          **Area Connected**
 
+         Given *tile-index* as center, and a radius, returns tiles that are connected to the center within the radius.
+
    .. grid-item::
 
       .. card::
@@ -72,6 +76,8 @@ There are multiple functions for finding tiles within some distance.
 
          **Area Neighborhood**
 
+         Returns tiles that are direct neighbors of area connected query. Usually looks like a ring.
+
    .. grid-item::
 
       .. card::
@@ -80,6 +86,8 @@ There are multiple functions for finding tiles within some distance.
 
          **Area Extended**
 
+         Returns a union of the connected and the neighboring tiles.
+
 .. tab-set::
    :sync-group: language