self.machine.ball_holds.*¶
-
class
mpf.devices.ball_hold.
BallHold
(self_inner, *args, **kwargs)¶ Bases:
mpf.core.system_wide_device.SystemWideDevice
,mpf.core.mode_device.ModeDevice
Ball hold device which can be used to keep balls in ball devices and control their eject later on.
Accessing ball_holds in code
The device collection which contains the ball_holds in your machine is available via
self.machine.ball_holds
. For example, to access one called "foo", you would useself.machine.ball_holds.foo
. You can also access ball_holds in dictionary form, e.g.self.machine.ball_holds['foo']
.You can also get devices by tag or hardware number. See the DeviceCollection documentation for details.
Methods & Attributes
Ball_holds have the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.
-
disable
(**kwargs)¶ Disable the hold.
If the hold is not enabled, no balls will be held.
Parameters: **kwargs -- unused
-
enable
(**kwargs)¶ Enable the hold.
If the hold is not enabled, no balls will be held.
Parameters: **kwargs -- unused
-
is_full
()¶ Return true if hold is full.
-
release_all
(**kwargs)¶ Release all balls in hold.
-
release_balls
(balls_to_release)¶ Release all balls and return the actual amount of balls released.
Parameters: balls_to_release -- number of ball to release from hold
-
release_one
(**kwargs)¶ Release one ball.
Parameters: **kwargs -- unused
-
release_one_if_full
(**kwargs)¶ Release one ball if hold is full.
-
remaining_space_in_hold
()¶ Return the remaining capacity of the hold.
-
reset
(**kwargs)¶ Reset the hold.
Will release held balls. Device status will stay the same (enabled/disabled). It will wait for those balls to drain and block ball_ending until they do. Those balls are not included in ball_in_play.
Parameters: **kwargs -- unused
-