Generate the Python stubs automatically

Scripts/Python/plasma/PlasmaConstants.py

@@ -40,6 +40,18 @@
       Mead, WA   99021
 
  *==LICENSE==* """
+
+# NOTE: This stub file was generated automatically from Plasma's Python interface.
+# Do not edit this file manually.
+# To change any of the docstrings or function signatures,
+# edit the corresponding C++ glue code in pfPython.
+# If the Python interface has changed, regenerate these stubs
+# by running the following call in the in-game Python console:
+# >>> __import__("generate_stubs").run()
+
+from __future__ import annotations
+from typing import *
+
 class Enum:
     """Enum base class"""
     def __init__(self):
@@ -104,9 +116,10 @@ class PtBrainModes:
     kGeneric = 0
     kLadder = 1
     kSit = 2
-    kEmote = 3
-    kAFK = 4
-    kNonGeneric = 5
+    kSitOnGround = 3
+    kEmote = 4
+    kAFK = 5
+    kNonGeneric = 6
 
 class PtButtonNotifyTypes:
     """(none)"""
@@ -125,6 +138,7 @@ class PtCCRPetitionType:
     kTechnical = 6
 
 class PtConfirmationResult:
+    """(none)"""
     Cancel = 0
     No = 0
     OK = 1
@@ -133,6 +147,7 @@ class PtConfirmationResult:
     Logout = 62
 
 class PtConfirmationType:
+    """(none)"""
     OK = 0
     ConfirmQuit = 1
     ForceQuit = 2
@@ -296,4 +311,3 @@ class PtStatusLogFlags:
     kStdout = 128
     kTimeInSeconds = 256
     kTimeAsDouble = 512
-

Scripts/Python/plasma/PlasmaGame.py

@@ -41,79 +41,150 @@
 
  *==LICENSE==* """
 
+# NOTE: This stub file was generated automatically from Plasma's Python interface.
+# Do not edit this file manually.
+# To change any of the docstrings or function signatures,
+# edit the corresponding C++ glue code in pfPython.
+# If the Python interface has changed, regenerate these stubs
+# by running the following call in the in-game Python console:
+# >>> __import__("generate_stubs").run()
+
 from __future__ import annotations
 from typing import *
 
 class ptGameCli:
     """Abstract bass class for legacy game clients."""
 
-    gameID: int = ...
+    gameID: int
+    """The ID of the game instance on the server."""
+
+    handler: Any
+    """The game event handler."""
+
+    isLocallyOwned: bool
+    """Whether or not we are the owner of this game instance."""
+
+    ownerID: int
+    """The ID of the player who owns this game instance."""
+
+    def __init__(self):
+        """None"""
+        pass
+
+    def leaveGame(self) -> None:
+        """Explicitly ask the server to allow us to leave the game."""
+        pass
+
+class ptGmBlueSpiral(ptGameCli):
+    """Legacy blue spiral game client."""
+
+    gameID: int
     """The ID of the game instance on the server."""
 
-    handler: Any = ...
+    handler: Any
     """The game event handler."""
 
-    isLocallyOwned: bool = ...
+    isLocallyOwned: bool
     """Whether or not we are the owner of this game instance."""
 
-    ownerID: int = ...
+    ownerID: int
     """The ID of the player who owns this game instance."""
 
+    def __init__(self):
+        """None"""
+        pass
+
+    def hitCloth(self):
+        """Request for the server to hit a specific cloth index and validate the correct sequence of cloth inputs."""
+        pass
+
+    @staticmethod
+    def isSupported():
+        """Checks for the presence of a server-side blue spiral game manager."""
+        pass
+
+    @staticmethod
+    def join():
+        """Join a common blue spiral game in the current Age."""
+        pass
+
     def leaveGame(self) -> None:
         """Explicitly ask the server to allow us to leave the game."""
-        ...
+        pass
 
+    def startGame(self):
+        """Request for the server to start the game timer."""
+        pass
 
 class ptGmMarker(ptGameCli):
     """Legacy marker game client."""
 
-    def addMarker(self, x: float, y: float, z: float, name: str, age: str) -> None:
+    gameID: int
+    """The ID of the game instance on the server."""
+
+    handler: Any
+    """The game event handler."""
+
+    isLocallyOwned: bool
+    """Whether or not we are the owner of this game instance."""
+
+    ownerID: int
+    """The ID of the player who owns this game instance."""
+
+    def __init__(self):
+        """None"""
+        pass
+
+    def addMarker(self,x: float, y: float, z: float, name: str, age: str) -> None:
         """Request for the server to add a new marker to the game."""
-        ...
+        pass
 
-    def captureMarker(self, markerId: int) -> None:
+    def captureMarker(self,markerId: int) -> None:
         """Request for the server to register a capture of the specified marker for our team."""
-        ...
+        pass
 
-    def changeGameName(self, name: str) -> None:
+    def changeGameName(self,name: str) -> None:
         """Request for the server to change the internal marker game name."""
-        ...
+        pass
 
-    def changeMarkerName(self, markerID: int) -> None:
+    def changeMarkerName(self,markerID: int) -> None:
         """Request for the server to change the name of a specific marker from the game."""
-        ...
+        pass
 
-    def changeTimeLimit(self, timeLimit: int) -> None:
+    def changeTimeLimit(self,timeLimit: int) -> None:
         """Request for the server to change the marker game's time limit."""
-        ...
+        pass
 
     @staticmethod
     def create(handler: Any, gameType: int, templateId: Optional[str]) -> None:
         """Initialize a new marker game client with the server."""
-        ...
+        pass
 
     def deleteGame(self) -> None:
-        """Request for the server to delete all data associated with this game, including
-           the marker definitions and game name.
-        """
-        ...
+        """Request for the server to delete all data associated with this game, including the marker definitions and game name."""
+        pass
 
-    def deleteMarker(self, markerID: int) -> None:
+    def deleteMarker(self,markerID: int) -> None:
         """Request for the server to delete a specific marker from the game."""
-        ...
+        pass
 
     @staticmethod
     def isSupported() -> bool:
-        ...
+        """Checks for the presence of a server-side marker game manager."""
+        pass
+
+    def leaveGame(self) -> None:
+        """Explicitly ask the server to allow us to leave the game."""
+        pass
 
     def pauseGame(self) -> None:
         """Request for the server to pause the marker game."""
-        ...
+        pass
 
     def resetGame(self) -> None:
         """Request for the server to clear all markers to the uncaptured state."""
-        ...
+        pass
 
     def startGame(self) -> None:
         """Request for the server to start the marker game."""
-        ...
+        pass

Scripts/Python/plasma/PlasmaGameConstants.py

@@ -41,10 +41,19 @@
 
  *==LICENSE==* """
 
+# NOTE: This stub file was generated automatically from Plasma's Python interface.
+# Do not edit this file manually.
+# To change any of the docstrings or function signatures,
+# edit the corresponding C++ glue code in pfPython.
+# If the Python interface has changed, regenerate these stubs
+# by running the following call in the in-game Python console:
+# >>> __import__("generate_stubs").run()
+
 from __future__ import annotations
+from typing import *
 
 class PtGameJoinError:
-    kGameJoinPending = -1
+    """(none)"""
     kGameJoinSuccess = 0
     kGameJoinErrNotExist = 1
     kGameJoinErrInitFailed = 2
@@ -54,11 +63,11 @@ class PtGameJoinError:
     kGameJoinErrAlreadyJoined = 6
     kGameJoinErrNoInvite = 7
     kNumGameJoinErrors = 8
-
+    kGameJoinPending = 4294967295
 
 class PtMarkerGameType:
+    """(none)"""
     kMarkerGameQuest = 0
     kMarkerGameCGZ = 1
     kMarkerGameCapture = 2
     kMarkerGameCaptureAndHold = 3
-    kNumMarkerGameTypes = 4

Scripts/Python/plasma/PlasmaNetConstants.py

@@ -40,6 +40,18 @@
       Mead, WA   99021
 
  *==LICENSE==* """
+
+# NOTE: This stub file was generated automatically from Plasma's Python interface.
+# Do not edit this file manually.
+# To change any of the docstrings or function signatures,
+# edit the corresponding C++ glue code in pfPython.
+# If the Python interface has changed, regenerate these stubs
+# by running the following call in the in-game Python console:
+# >>> __import__("generate_stubs").run()
+
+from __future__ import annotations
+from typing import *
+
 class PtLinkingRules:
     """(none)"""
     kBasicLink = 0
@@ -48,4 +60,3 @@ class PtLinkingRules:
     kOwnedBook = 3
     kVisitBook = 4
     kChildAgeBook = 5
-

Scripts/Python/plasma/PlasmaVaultConstants.py

@@ -40,6 +40,18 @@
       Mead, WA   99021
 
  *==LICENSE==* """
+
+# NOTE: This stub file was generated automatically from Plasma's Python interface.
+# Do not edit this file manually.
+# To change any of the docstrings or function signatures,
+# edit the corresponding C++ glue code in pfPython.
+# If the Python interface has changed, regenerate these stubs
+# by running the following call in the in-game Python console:
+# >>> __import__("generate_stubs").run()
+
+from __future__ import annotations
+from typing import *
+
 class PtVaultCallbackTypes:
     """(none)"""
     kVaultConnected = 1
@@ -112,4 +124,3 @@ class PtVaultTextNoteTypes:
     """(none)"""
     kGeneric = 0
     kCCRPetition = 1
-