mpf.core.config_player
¶
Base class used for things that “play” from the config files, such as WidgetPlayer, SlidePlayer, etc.
-
class
mpf.core.config_player.
ConfigPlayer
(machine)¶ Base class for players which play things based on config.
Initialise config player.
-
clear_context
(context)¶ Clear the context.
-
config_play_callback
(settings, calling_context, priority=0, mode=None, **kwargs)¶ Callback for standalone player.
-
get_express_config
(value)¶ Parse short config version.
Implements “express” settings for this config_player which is what happens when a config is passed as a string instead of a full config dict. (This is detected automatically and this method is only called when the config is not a dict.)
For example, the led_player uses the express config to parse a string like ‘ff0000-f.5s’ and translate it into:
color: 220000 fade: 500
Since every config_player is different, this method raises a NotImplementedError and most be configured in the child class.
Parameters: value – The single line string value from a config file. Returns: A dictionary (which will then be passed through the config validator)
-
get_full_config
(value)¶ Return full config.
-
get_list_config
(value)¶ Parse config list.
-
mode_start
(config, priority, mode)¶ Add events for mode.
-
mode_stop
(mode)¶ Remove events for mode.
-
play
(settings, context, calling_context, priority=0, **kwargs)¶ Directly play player.
-
classmethod
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 events for standalone player.
-
show_play_callback
(settings, priority, calling_context, show_tokens, context)¶ Callback if used in a show.
-
show_stop_callback
(context)¶ Callback if show stops.
-
unload_player_events
(key_list)¶ Remove event for standalone player.
-
validate_config
(config)¶ Validate this player’s section of a config file (either a machine-wide config or a mode config).
Parameters: - Returns: A dict in the same format, but passed through the config
- validator.
-
validate_config_entry
(settings, name)¶ Validate one entry of this player.
-