mpf.config_players.plugin_player
¶
Plugin config player.
-
class
mpf.config_players.plugin_player.
PluginPlayer
(machine)¶ Base class for a remote ConfigPlayer that is registered as a plug-in to MPF.
This class is created on the MPF side of things.
Initialise config player.
-
clear_context
(context)¶ Clear the context at remote player via BCP.
-
config_play_callback
(settings, priority=0, mode=None, **kwargs)¶ Callback for standalone player.
-
get_express_config
(value)¶ Not supported.
-
get_full_config
(value)¶ Return full config.
-
mode_start
(config, priority, mode)¶ Add events for mode.
-
mode_stop
(mode)¶ Remove events for mode.
-
play
(settings, context, priority=0, **kwargs)¶ Trigger remote player via BCP.
-
process_config
(config, **kwargs)¶ Process system-wide config.
Called every time mpf starts, regardless of whether config was built from cache or config files.
-
process_mode_config
(config, root_config_dict, mode, **kwargs)¶ Parse mode config.
-
register_player_events
(config, mode=None, priority=0)¶ Register player events via BCP.
Override this method in the base class and registers the config_player events to send the trigger via BCP instead of calling the local play() method.
-
show_play_callback
(settings, priority, show_tokens, context)¶ Callback if used in a show.
-
show_stop_callback
(context)¶ Callback if show stops.
-
unload_player_events
(event_list)¶ Unload player events via BCP.
-
validate_config
(config)¶ Validate this player’s section of a config file (either a machine-wide config or a mode config).
Parameters: - config – A dict of the contents of this config_player’s section
- the config file. It's assumed that keys are event names, and (from) –
- are settings for what this config_player does when that (values) –
- is posted. (event) –
- Returns: A dict in the same format, but passed through the config
- validator.
-
validate_show_config
(device, device_settings)¶ Validate show config.
-