This page documents the Python classes and functions in the 'ba' module, which are the ones most relevant to modding in Ballistica. If you come across something you feel should be included here or could be better explained, please let me know. Happy modding!
create_default_game_settings_ui(self, gameclass: Type[ba.GameActivity], sessionclass: Type[ba.Session], config: Optional[dict], completion_call: Callable[[Optional[dict]], None]) -> None
+create_default_game_settings_ui(self, gameclass: Type[ba.GameActivity], sessiontype: Type[ba.Session], settings: Optional[dict], completion_call: Callable[[Optional[dict]], None]) -> None
Launch a UI to configure the given game config.
@@ -1733,7 +1734,7 @@ and it should begin its actual game logic. high score lists.The position of the player, as defined by its current ba.Actor.
-This value is undefined when the player has no Actor.
+If the player currently has no actor, raises a ba.ActorNotFoundError.
create_settings_ui(sessionclass: Type[ba.Session], settings: Optional[dict], completion_call: Callable[[Optional[dict]], None]) -> None
+create_settings_ui(sessiontype: Type[ba.Session], settings: Optional[dict], completion_call: Callable[[Optional[dict]], None]) -> None
Launch an in-game UI to configure settings for a game type.
-'sessionclass' should be the ba.Session class the game will be used in.
+'sessiontype' should be the ba.Session class the game will be used in.
-'config' should be an existing config dict (specifies 'edit' ui mode) - or None (specifies 'add' ui mode).
+'settings' should be an existing settings dict (implies 'edit' + ui mode) or None (implies 'add' ui mode).
'completion_call' will be called with a filled-out settings dict on success or None on cancel.
@@ -2439,11 +2440,11 @@ will replace the old.end_game(self) -> None
-Tells the game to wrap itself up and call ba.Activity.end() -immediately. This method should be overridden by subclasses.
+Tell the game to wrap up and call ba.Activity.end() immediately.
-A game should always be prepared to end and deliver results, even if -there is no 'winner' yet; this way things like the standard time-limit +
This method should be overridden by subclasses. A game should always +be prepared to end and deliver results, even if there is no 'winner' +yet; this way things like the standard time-limit (ba.GameActivity.setup_standard_time_limit()) will work with the game.
get_available_settings(sessiontype: Type[ba.Session]) -> List[ba.Setting]
-Called by the default ba.GameActivity.create_settings_ui() -implementation; should return a dict of config options to be presented -to the user for the given ba.Session type.
- -The format for settings is a list of 2-member tuples consisting -of a name and a dict of options.
- -Available Setting Options:
- -'default': This determines the default value as well as the - type (int, float, or bool)
- -'min_value': Minimum value for int/float settings.
- -'max_value': Maximum value for int/float settings.
- -'choices': A list of name/value pairs the user can choose from by name.
- -'increment': Value increment for int/float settings.
- -# example get_available_settings() for a capture-the-flag game:
-@classmethod
-def get_available_settings(cls, sessiontype):
- return [("Score to Win", {
- 'default': 3,
- 'min_value': 1
- }),
- ("Flag Touch Return Time", {
- 'default': 0,
- 'min_value': 0,
- 'increment': 1
- }),
- ("Flag Idle Return Time", {
- 'default': 30,
- 'min_value': 5,
- 'increment': 5
- }),
- ("Time Limit", {
- 'default': 0,
- 'choices': [
- ('None', 0), ('1 Minute', 60), ('2 Minutes', 120),
- ('5 Minutes', 300), ('10 Minutes', 600),
- ('20 Minutes', 1200)
- ]
- }),
- ("Respawn Times", {
- 'default': 1.0,
- 'choices': [
- ('Shorter', 0.25), ('Short', 0.5), ('Normal', 1.0),
- ('Long', 2.0), ('Longer', 4.0)
- ]
- }),
- ("Epic Mode", {
- 'default': False
- })]
+Return a list of settings relevant to this game type when +running under the provided session type.
get_team_score(self, sessionteam: Union[ba.SessionTeam]) -> Optional[int]
+get_team_score(self, sessionteam: ba.SessionTeam) -> Optional[int]
Return the score for a given ba.SessionTeam.
get_team_score_str(self, team: ba.Team) -> ba.Lstr
+get_team_score_str(self, sessionteam: ba.SessionTeam) -> ba.Lstr
Return the score for the given ba.Team as an Lstr.
@@ -2854,6 +2802,22 @@ Results for a completed game.This can be a number or None. (see the none_is_winner arg in the constructor)
+<top level class> +
+Defines a tip presentable to the user at the start of a game.
+ +Category: Gameplay Classes +
+ +ba.GameTip(text: str, icon: Optional[ba.Texture] = None, sound: Optional[ba.Sound] = None)
+The position of the player, as defined by its current ba.Actor.
-This value is undefined when the player has no Actor.
+If the player currently has no actor, raises a ba.ActorNotFoundError.
ba.PlayerRecord(name: str, name_full: str, player: ba.SessionPlayer, stats: ba.Stats)
+ba.PlayerRecord(name: str, name_full: str, sessionplayer: ba.SessionPlayer, stats: ba.Stats)
associate_with_player(self, sessionplayer: ba.SessionPlayer) -> None
+associate_with_sessionplayer(self, sessionplayer: ba.SessionPlayer) -> None
Associate this entry with a ba.SessionPlayer.
@@ -4470,8 +4434,8 @@ the type-checker properly identifies the returned value as one.Get the icon for this instance's player.
get_last_player(self) -> ba.SessionPlayer
+get_last_sessionplayer(self) -> ba.SessionPlayer
Return the last ba.Player we were associated with.
@@ -4700,13 +4664,19 @@ Pass 0 or a negative number for no ban time. maintaining state between them (players, teams, score tallies, etc).bool
Whether players should be allowed to join in the middle of activities.
+dict
+A shared dictionary for objects to use as storage on this session. +Ensure that keys here are unique to avoid collisions.
+ba.Stats()
@@ -5324,10 +5294,10 @@ of the session.Should be called when a player is killed.
register_player(self, player: ba.SessionPlayer) -> None
+register_sessionplayer(self, player: ba.SessionPlayer) -> None
-Register a player with this score-set.
+Register a ba.SessionPlayer with this score-set.