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!
dict
+Entities needing to store simple data with an activity can put it + here. This dict will be deleted when the activity expires, so contained + objects generally do not need to worry about handling expired + activities.
+ +bool
Whether the activity is expired.
@@ -353,14 +362,6 @@ actually award achievements. At this point no new nodes, timers, etc should be made, run, etc, and the activity should be considered a 'zombie'. -dict
-Entities needing to store simple data with an activity can put it - here. This dict will be deleted when the activity expires, so contained - objects generally do not need to worry about handling expired - activities.
-dict
+Entities needing to store simple data with an activity can put it + here. This dict will be deleted when the activity expires, so contained + objects generally do not need to worry about handling expired + activities.
+ +bool
Whether the activity is expired.
@@ -1562,14 +1571,6 @@ start_long_action(callback_when_done=ba.ContextC At this point no new nodes, timers, etc should be made, run, etc, and the activity should be considered a 'zombie'. -dict
-Entities needing to store simple data with an activity can put it - here. This dict will be deleted when the activity expires, so contained - objects generally do not need to worry about handling expired - activities.
-dict
+Entities needing to store simple data with an activity can put it + here. This dict will be deleted when the activity expires, so contained + objects generally do not need to worry about handling expired + activities.
+ +bool
Whether the activity is expired.
@@ -2155,14 +2164,6 @@ its time with lingering corpses, sound effects, etc. At this point no new nodes, timers, etc should be made, run, etc, and the activity should be considered a 'zombie'. -dict
-Entities needing to store simple data with an activity can put it - here. This dict will be deleted when the activity expires, so contained - objects generally do not need to worry about handling expired - activities.
-Optional[ba.Actor]
The ba.Actor associated with the player.
dict
Arbitrary values associated with the player. Though it is encouraged that most player values be properly defined @@ -4111,9 +4112,9 @@ the type-checker properly identifies the returned value as one.
associate_with_player(self, player: ba.SessionPlayer) -> None
+associate_with_player(self, sessionplayer: ba.SessionPlayer) -> None
-Associate this entry with a ba.Player.
+Associate this entry with a ba.SessionPlayer.
str
@@ -4602,14 +4603,7 @@ any lobby character/team selection.The input device associated with the player.
Dict
-A dict for use by the current ba.Session for -storing data associated with this player. -This persists for the duration of the session.
- -The ba.SessionTeam this Player is on. If the SessionPlayer is still in its lobby selecting a team/etc. then a @@ -4708,18 +4702,19 @@ other players.
each SessionTeam consists of just one SessionPlayer.Tuple[float, ...]
The team's color.
Dict
-A dict for use by the current ba.Activity -for storing data associated with this team. -This gets cleared for each new ba.Activity.
+dict
+A dict for use by the current ba.Session for +storing data associated with this team. +Unlike customdata, this persists for the duration +of the session.
List[ba.SessionPlayer]
The list of ba.SessionPlayers on the team.
-Dict
-A dict for use by the current ba.Session for -storing data associated with this team. -Unlike gamedata, this persists for the duration -of the session.
-ba.Stats()
@@ -4971,12 +4958,6 @@ of the session.May return None.
-player_got_hit(self, player: ba.SessionPlayer) -> None
- -Call this when a player got hit.
-player_scored(self, player: ba.Player, base_points: int = 1, target: Sequence[float] = None, kill: bool = False, victim_player: ba.Player = None, scale: float = 1.0, color: Sequence[float] = None, title: Union[str, ba.Lstr] = None, screenmessage: bool = True, display: bool = True, importance: int = 1, showpoints: bool = True, big_message: bool = False) -> int
@@ -5029,9 +5010,9 @@ of the session.dict
Arbitrary values associated with the team. Though it is encouraged that most player values be properly defined @@ -5080,8 +5061,16 @@ of the session.
dict
+Entities needing to store simple data with an activity can put it + here. This dict will be deleted when the activity expires, so contained + objects generally do not need to worry about handling expired + activities.
+ +bool
Whether the activity is expired.
@@ -5090,14 +5079,6 @@ of the session. At this point no new nodes, timers, etc should be made, run, etc, and the activity should be considered a 'zombie'. -dict
-Entities needing to store simple data with an activity can put it - here. This dict will be deleted when the activity expires, so contained - objects generally do not need to worry about handling expired - activities.
-Upon completion, a game should fill one of these out and pass it to its ba.Activity.end() call.
+bool
+Whether lower scores are better.
+ +List[ba.PlayerInfo]
+Get info about the players represented by the results.
+ +str
+The label associated with scores ('points', etc).
+ +The type of score.
+ +List[ba.SessionTeam]
+Return all ba.SessionTeams in the results.
+ +List[WinnerGroup]
+Get an ordered list of winner groups.
+ +Optional[ba.SessionTeam]
+The winning ba.SessionTeam if there is exactly one, or else None.
+ +ba.TeamGameResults()
Instantiate a results instance.
-get_lower_is_better(self) -> bool
- -Return whether lower scores are better.
- -get_player_info(self) -> List[ba.PlayerInfo]
- -Get info about the players represented by the results.
- -get_score_name(self) -> str
- -Get the name associated with scores ('points', etc).
- -get_score_type(self) -> ba.ScoreType
- -Get the type of score.
-get_team_score(self, team: Union[ba.SessionTeam, ba.Team]) -> Optional[int]
+get_team_score(self, sessionteam: Union[ba.SessionTeam]) -> Optional[int]
-Return the score for a given team.
+Return the score for a given ba.SessionTeam.
(properly formatted for the score type.)
-get_teams(self) -> List[ba.SessionTeam]
- -Return all ba.SessionTeams in the results.
- -get_winners(self) -> List[WinnerGroup]
- -Get an ordered list of winner groups.
- -get_winning_team(self) -> Optional[ba.SessionTeam]
- -Get the winning ba.Team if there is exactly one; None otherwise.
-has_score_for_team(self, sessionteam: ba.SessionTeam) -> bool
@@ -5286,7 +5264,7 @@ Results for a completed ba.TeamGameActivityset_team_score(self, team: Union[ba.SessionTeam, ba.Team], score: Optional[int]) -> None
+set_team_score(self, team: ba.Team, score: Optional[int]) -> None
Set the score for a given ba.Team.
@@ -6422,6 +6400,30 @@ playing, the playing track will not be restarted.Category: Gameplay Functions
+storagename(basename: str) -> str
+ +Generate a (hopefully) unique name for storing things in public places.
+ +Category: General Utility Functions
+ +This consists of a leading underscore, the module path at the +call site with dots replaced by underscores, the class name, and +the provided suffix. When storing data in public places such as +'customdata' dicts, this minimizes the chance of collisions if a +module or class is duplicated or renamed.
+ +# Example: generate a unique name for storage purposes:
+class MyThingie:
+
+# This will give something like '_mymodule_submodule_mythingie_data'. + _STORENAME = ba.storagename('data')+ +
def __init__(self, activity): + # Store some data in the Activity we were passed + activity.customdata[self._STORENAME] = {}
+textwidget(edit: Widget = None, parent: Widget = None,