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!
bool
@@ -355,6 +355,12 @@ actually award achievements. At this point no new nodes, timers, etc should be made, run, etc, and the activity should be considered a 'zombie'. +The 'globals' ba.Node for the activity. This contains various + global controls and values.
+List[PlayerType]
@@ -1541,7 +1547,7 @@ start_long_action(callback_when_done=ba.ContextCbool
@@ -1551,6 +1557,12 @@ 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'. +The 'globals' ba.Node for the activity. This contains various + global controls and values.
+Optional[ba.Campaign]
The ba.Campaign instance this Session represents, or None if there is no associated Campaign.
+The sessionglobals ba.Node for the session.
+The sessionglobals ba.Node for the session.
+ +The sessionglobals ba.Node for the session.
+ +bool
@@ -2108,6 +2142,12 @@ 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'. +The 'globals' ba.Node for the activity. This contains various + global controls and values.
+# example 3: play some sounds when we're contacting the ground: m = ba.Material() m.add_actions(conditions=('they_have_material', - ba.sharedobj('footing_material')), + shared.footing_material), actions=(('impact_sound', ba.getsound('metalHit'), 2, 5), ('skid_sound', ba.getsound('metalSkid'), 2, 5)))@@ -3329,6 +3369,14 @@ Use ba.getmodel() to instantiate one.
The sessionglobals ba.Node for the session.
+ +bool
@@ -4305,6 +4353,11 @@ to proceed past the initial joining screen. list in ba.Activity; not this. Some players, such as those who have not yet selected a character, will only appear on this list. +The sessionglobals ba.Node for the session.
+List[ba.SessionTeam]
@@ -4812,6 +4865,22 @@ of the session.<top level class> +
+Describes a point in space and an angle to face.
+ +Category: Gameplay Classes +
+ +ba.StandLocation(position: _ba.Vec3, angle: Optional[float] = None)
+ +<top level class>
@@ -4961,7 +5030,7 @@ of the session.bool
@@ -4971,6 +5040,12 @@ of the session. At this point no new nodes, timers, etc should be made, run, etc, and the activity should be considered a 'zombie'. +The 'globals' ba.Node for the activity. This contains various + global controls and values.
+if 'continuous' is True and musictype is the same as what is already playing, the playing track will not be restarted.
-sharedobj(name: str) -> Any
- -Return a predefined object for the current Activity, creating if needed.
- -Category: Gameplay Functions
- -Available values for 'name':
- -'globals': returns the 'globals' ba.Node, containing various global - controls & values.
- -'object_material': a ba.Material that should be applied to any small, - normal, physical objects such as bombs, boxes, players, etc. Other - materials often check for the presence of this material as a - prerequisite for performing certain actions (such as disabling collisions - between initially-overlapping objects)
- -'player_material': a ba.Material to be applied to player parts. Generally, - materials related to the process of scoring when reaching a goal, etc - will look for the presence of this material on things that hit them.
- -'pickup_material': a ba.Material; collision shapes used for picking things - up will have this material applied. To prevent an object from being - picked up, you can add a material that disables collisions against things - containing this material.
- -'footing_material': anything that can be 'walked on' should have this - ba.Material applied; generally just terrain and whatnot. A character will - snap upright whenever touching something with this material so it should - not be applied to props, etc.
- -'attack_material': a ba.Material applied to explosion shapes, punch - shapes, etc. An object not wanting to receive impulse/etc messages can - disable collisions against this material.
- -'death_material': a ba.Material that sends a ba.DieMessage() to anything - that touches it; handy for terrain below a cliff, etc.
- -'region_material': a ba.Material used for non-physical collision shapes - (regions); collisions can generally be allowed with this material even - when initially overlapping since it is not physical.
- -'railing_material': a ba.Material with a very low friction/stiffness/etc - that can be applied to invisible 'railings' useful for gently keeping - characters from falling off of cliffs.
-show_damage_count(damage: str, position: Sequence[float], direction: Sequence[float]) -> None