self.machine.accruals.*¶
-
class
mpf.devices.logic_blocks.
Accrual
(machine, name)¶ Bases:
mpf.devices.logic_blocks.LogicBlock
A type of LogicBlock which tracks many different events (steps) towards a goal.
The steps are able to happen in any order.
Accessing accruals in code
The device collection which contains the accruals in your machine is available via
self.machine.accruals
. For example, to access one called “foo”, you would useself.machine.accruals.foo
. You can also access accruals in dictionary form, e.g.self.machine.accruals['foo']
.You can also get devices by tag or hardware number. See the DeviceCollection documentation for details.
Methods & Attributes
Accruals have the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.
-
complete
()¶ Mark this logic block as complete.
Posts the ‘events_when_complete’ events and optionally restarts this logic block or disables it, depending on this block’s configuration settings.
-
completed
¶ Return if completed.
-
disable
(**kwargs)¶ Disable this logic block.
Automatically called when one of the disable_event events is posted. Can also manually be called.
-
enable
(**kwargs)¶ Enable this logic block.
Automatically called when one of the enable_event events is posted. Can also manually be called.
-
enabled
¶ Return if enabled.
-
get_start_value
() → List[bool]¶ Return start states.
-
hit
(step: int, **kwargs)¶ Increase the hit progress towards completion.
Automatically called when one of the count_events is posted. Can also manually be called.
Parameters: step – Integer of the step number (0 indexed) that was just hit.
-
raise_config_error
(msg, error_no, *, context=None)¶ Raise a ConfigFileError exception.
-
reset
(**kwargs)¶ Reset the progress towards completion of this logic block.
Automatically called when one of the reset_event events is called. Can also be manually called.
-
restart
(**kwargs)¶ Restart this logic block by calling reset() and enable().
Automatically called when one of the restart_event events is called. Can also be manually called.
-
value
¶ Return value or None if that is currently not possible.
-