From 09d82b95e59b4718f696e2bfcf344e59f72929c7 Mon Sep 17 00:00:00 2001 From: Adam Johnson Date: Thu, 13 Feb 2020 22:26:49 -0500 Subject: [PATCH] Add documentation for `generate_physical`. --- korman/exporter/physics.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/korman/exporter/physics.py b/korman/exporter/physics.py index e2e9474..b02a249 100644 --- a/korman/exporter/physics.py +++ b/korman/exporter/physics.py @@ -140,7 +140,17 @@ class PhysicsConverter: self._apply_props(simIface, physical, kwargs) def generate_physical(self, bo, so, **kwargs): - """Generates a physical object for the given object pair""" + """Generates a physical object for the given object pair. + The following optional arguments are allowed: + - bounds: (defaults to collision modifier setting) + - member_group: str attribute of plSimDefs, defaults to kGroupStatic + NOTE that kGroupLOSOnly generation will only succeed if no one else + has generated this physical in another group + - properties: sequence of str bit names from plSimulationInterface + - losdbs: sequence of str bit names from plSimDefs + - report_groups: sequence of str bit names from plSimDefs + - collide_groups: sequence of str bit names from plSimDefs + """ if so.sim is None: simIface = self._mgr.add_object(pl=plSimulationInterface, bl=bo) physical = self._mgr.add_object(pl=plGenericPhysical, bl=bo)