DOF Events

If DOF is installed on your system, PinballY will generate DOF events to trigger effects from your feedback devices (such as solenoids and flasher lights). This will fire flashers and other devices on certain events, such as when you switch between tables in the table list.

DOF integration is automatic; to take advantage of it, just make sure that DOF is installed and that your .ini files from the DOF Config Tool are up to date. The PinballY definitions were added to the Config Tool database in late July 2018, so you'll need to generate and download fresh copies if your current .ini files are older than that.

Customizing DOF effects

The DOF Config Tool's database includes a predefined set of effects for PinballY, so you don't have to do anything to use the standard effects other than make sure your .ini files are up-to-date. If you want to customize anything, though, the Config Tool lets you override any of the default effects with your own custom settings.

All PinballY events are defined under the pseudo-table named PinballY. To view the event settings in the DOF Config Tool, go to the Table Configs page and select PinballY from the Table Name drop list.

PinballY's entries in the Config Tool follow the standard format defined by DOF. That's a bit obscure and hard to read, but we won't try to explain it here, since you can find documentation on it in the DOF user guide. What we will give you is a list of the special event names and state names that PinballY generates.

Note that all named effects in the Config Tool are specified with a $ prefix, so remember to add that to the names in the lists below. For example, you'd write $PBYWheelNext in the Config Tool field if you want something to trigger on a "wheel next" event.

@allrgb@: There's one special bit of Config Tool syntax that's worth mentioning, because it's a special Config Tool feature that isn't part of DOF. If you put @allrgb@ in one of the toy fields, the Config Tool expands this to a list of the settings for that toy for all of the individual tables throughout the rest of the database. This translates to showing the same colors on that device that would be shown if you were actually playing the game. For example, putting @allrgb@ in the "RGB Flippers" field makes the flipper buttons light up in the colors for whichever table is currently selected in the PinballY wheel display. This only applies to RGB toys.

Events

Each time something DOF-worthy happens in the PinballY user interface, PinballY fires a named DOF event. For example, when you press the Next button (usually the right flipper button) to switch to the next game, PinballY fires a PBYWheelNext event.

Here's a list of the events that PinballY fires:

States

In addition to events, PinballY has "states". These differ from events only in that states are long-lasting. An event fires briefly, usually triggering a quick event in DOF, such as flashing the flashers or firing a flipper solenoid. A state turns on and stays on for an extended period. States tell DOF the current context in the UI: showing a game in the wheel interface, showing a menu, running the "attract mode" screen saver, and so on.