This documentation is for an unreleased version of MPF!

This is the developer documentation for MPF 0.54, which is the “dev” (next) release of MPF that is a work-in-progress. Use the “Read the Docs” link in the lower left corner to view the developer docs for the version of MPF you’re using.


class mpf.config_players.light_player.LightPlayer(machine)

Bases: mpf.config_players.device_config_player.DeviceConfigPlayer

Sets lights based on config.

Accessing the light_player in code

The light_player is available via self.machine.light_player.

Methods & Attributes

The light_player has the following methods & attributes available. Note that methods & attributes inherited from the base class are not included here.


Remove all colors which were set in context.


Parse express config.

handle_subscription_change(value, settings, priority, context, key)

Handle subscriptions.

play(settings, context, calling_context, priority=0, **kwargs)

Set light color based on config.