self.machine.magnets.*¶
-
class
mpf.devices.magnet.
Magnet
(*args, **kwargs)¶ Bases:
mpf.core.system_wide_device.SystemWideDevice
Controls a playfield magnet in a pinball machine.
Accessing magnets in code
The device collection which contains the magnets in your machine is available via
self.machine.magnets
. For example, to access one called “foo”, you would useself.machine.magnets.foo
. You can also access magnets in dictionary form, e.g.self.machine.magnets['foo']
.You can also get devices by tag or hardware number. See the DeviceCollection documentation for details.
Methods & Attributes
Magnets have the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.
-
disable
(**kwargs)¶ Disable magnet.
-
enable
(**kwargs)¶ Enable magnet.
-
fling_ball
(**kwargs)¶ Fling the grabbed ball.
-
grab_ball
(**kwargs)¶ Grab a ball.
-
raise_config_error
(msg, error_no, *, context=None)¶ Raise a ConfigFileError exception.
-
release_ball
(**kwargs)¶ Release the grabbed ball.
-
reset
(**kwargs)¶ Release ball and disable magnet.
-