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!
Use ba.getcollidemodel() to instantiate one.
+<top level class> +
+A class providing info about occurring collisions.
+ +int
+The body index on the opposing node in the current collision.
+ +The node the current callback material node is hitting.
+ +Throws a ba.NodeNotFoundError if the node does not exist. + This can be expected in some cases such as in 'disconnect' + callbacks triggered by deleting a currently-colliding node.
+ +The position of the current collision.
+ +The node containing the material triggering the current callback.
+ +Throws a ba.NodeNotFoundError if the node does not exist, though + the node should always exist (at least at the start of the collision + callback).
+ +<top level class> @@ -3547,10 +3592,13 @@ the right thing both for Node objects and values of None.
getdelegate() -> Any
+getdelegate(type: Type, doraise: bool = False) -> <varies>
-Returns the node's current delegate, which is the Python object -designated to handle the Node's messages.
+Return the node's current delegate object if it matches a certain type.
+ +If the node has no delegate or it is not an instance of the passed +type, then None will be returned. If 'doraise' is True, then an +Exception will be raised instead in such cases.
get_collision_info(*args: Any) -> Any
- -Return collision related values
- -Category: Gameplay Functions
- -Returns a single collision value or tuple of values such as location, -depth, nodes involved, etc. Only call this in the handler of a -collision-triggered callback or message
-get_valid_languages() -> List[str]
@@ -5785,6 +5821,12 @@ to be loaded. To avoid hitches, instantiate your media objects in advance of when you will be using them, allowing time for them to load in the background if necessary. +getcollision() -> Collision
+ +Return the in-progress collision.
+getmaps(playtype: str) -> List[str]
diff --git a/tests/test_efro/test_dataclasses.py b/tests/test_efro/test_dataclasses.py index 4bd6a911..a2bf51f5 100644 --- a/tests/test_efro/test_dataclasses.py +++ b/tests/test_efro/test_dataclasses.py @@ -149,7 +149,6 @@ def test_validate() -> None: dataclass_validate(tclass) # No longer valid. - # noinspection PyTypeHints tclass.ival = None # type: ignore with pytest.raises(TypeError): dataclass_validate(tclass) diff --git a/tests/test_efro/test_entity.py b/tests/test_efro/test_entity.py index 063ab689..97354d92 100644 --- a/tests/test_efro/test_entity.py +++ b/tests/test_efro/test_entity.py @@ -80,7 +80,6 @@ class EntityTest(entity.Entity): fval2 = entity.Field('f2', entity.Float3Value()) -# noinspection PyTypeHints def test_entity_values() -> None: """Test various entity assigns for value and type correctness.""" ent = EntityTest() @@ -134,7 +133,6 @@ def test_entity_values() -> None: assert dict(ent.str_int_dict.items()) == {'foo': 123} -# noinspection PyTypeHints def test_entity_values_2() -> None: """Test various entity assigns for value and type correctness.""" @@ -191,7 +189,6 @@ def test_entity_values_2() -> None: assert static_type_equals(ent.grp.compoundlist[0].subval, bool) -# noinspection PyTypeHints def test_field_copies() -> None: """Test copying various values between fields.""" ent1 = EntityTest() diff --git a/tools/efro/entity/_entity.py b/tools/efro/entity/_entity.py index 144fec0f..9f66ab10 100644 --- a/tools/efro/entity/_entity.py +++ b/tools/efro/entity/_entity.py @@ -121,7 +121,6 @@ class EntityMixin: self.d_data = target.d_data # Make sure target blows up if someone tries to use it. - # noinspection PyTypeHints target.d_data = None # type: ignore def pruned_data(self) -> Dict[str, Any]: diff --git a/tools/efro/util.py b/tools/efro/util.py index fc74c96f..c7a2b69a 100644 --- a/tools/efro/util.py +++ b/tools/efro/util.py @@ -99,7 +99,7 @@ class DispatchMethodWrapper(Generic[TARG, TRET]): registry: Dict[Any, Callable] -# noinspection PyTypeHints, PyProtectedMember +# noinspection PyProtectedMember def dispatchmethod( func: Callable[[Any, TARG], TRET]) -> DispatchMethodWrapper[TARG, TRET]: