DirectOutput.Pinball Class Reference

Pinball is the main object of the DirectOutput framework.
It holds all objects required to process Pinmame data, trigger the necessary effects and update toys and output controllers. More...

Public Member Functions
void	Setup (string GlobalConfigFilename="", string TableFilename="", string RomName="")
	Configures the Pinball object. Loads the global config, table config and cabinet config More...
void	Init ()
	Initializes/starts the Pinball object More...
void	Finish ()
	Finishes the Pinball object. More...
void	MainThreadSignal ()
	Signals the main thread to continue its work (if currently sleeping). More...
void	ReceiveData (char TableElementTypeChar, int Number, int Value)
	Receives the table element data from the calling app (e.g. B2S.Server providing data through the plugin interface). The received data is put in a queue and the internal thread of the framework is notified about the availability of new data. More...
void	ReceiveData (string TableElementName, int Value)
	Receives data for named table elements. The received data is put in a queue and the internal thread of the framework is notified about the availability of new data. More...
void	ReceiveData (TableElementData TableElementData)
	Receives the table element data from the calling app. The received data is put in a queue and the internal thread of the framework is notified about the availability of new data. More...
override string	ToString ()
	Returns a System.String that represents this instance. More...
	Pinball ()
	Initializes a new instance of the Pinball class. More...

Properties
Table.Table	Table [get, set]
	Gets or sets the table object for the Pinball object. More...
Cabinet	Cabinet [get, set]
	Gets or sets the Cabinet object for the Pinball object. More...
AlarmHandler	Alarms [get]
	Gets the AlarmHandler object for the Pinball object. More...
GlobalConfig	GlobalConfig [get]
	Gets the global config for the Pinnball object. More...
bool	MainThreadIsActive [get]
	Indicates if the MainThread of DirectOutput is active More...

Detailed Description

Pinball is the main object of the DirectOutput framework.
It holds all objects required to process Pinmame data, trigger the necessary effects and update toys and output controllers.

Definition at line 23 of file Pinball.cs.

Constructor & Destructor Documentation

DirectOutput.Pinball.Pinball

(

)

Initializes a new instance of the Pinball class.

Definition at line 769 of file Pinball.cs.

Member Function Documentation

void DirectOutput.Pinball.Finish

(

)

Finishes the Pinball object.

Definition at line 446 of file Pinball.cs.

void DirectOutput.Pinball.Init

(

)

Initializes/starts the Pinball object

Definition at line 402 of file Pinball.cs.

void DirectOutput.Pinball.MainThreadSignal

(

)

Signals the main thread to continue its work (if currently sleeping).

Definition at line 555 of file Pinball.cs.

void DirectOutput.Pinball.ReceiveData	(	char	TableElementTypeChar,
		int	Number,
		int	Value
	)

Receives the table element data from the calling app (e.g. B2S.Server providing data through the plugin interface).
The received data is put in a queue and the internal thread of the framework is notified about the availability of new data.

Parameters

TableElementTypeChar	The table element type char as specified in the TableElementTypeEnum.
Number	The number of the TableElement.
Value	The value of the TableElement.

Definition at line 688 of file Pinball.cs.

void DirectOutput.Pinball.ReceiveData	(	string	TableElementName,
		int	Value
	)

Receives data for named table elements. The received data is put in a queue and the internal thread of the framework is notified about the availability of new data.

Parameters

TableElementName	Name of the table element.
Value	The value of the table element.

Definition at line 703 of file Pinball.cs.

void DirectOutput.Pinball.ReceiveData

(

TableElementData

TableElementData

)

Receives the table element data from the calling app.
The received data is put in a queue and the internal thread of the framework is notified about the availability of new data.

Parameters

TableElementData

The table element data to be received.

Definition at line 718 of file Pinball.cs.

void DirectOutput.Pinball.Setup	(	string	GlobalConfigFilename = "",
		string	TableFilename = "",
		string	RomName = ""
	)

Configures the Pinball object.
Loads the global config, table config and cabinet config

Parameters

GlobalConfigFilename	The global config filename.
TableFilename	The table filename.
RomName	Name of the rom.

Definition at line 104 of file Pinball.cs.

override string DirectOutput.Pinball.ToString

(

)

Returns a System.String that represents this instance.

Returns

A System.String that represents this instance.

Definition at line 737 of file Pinball.cs.

Property Documentation

AlarmHandler DirectOutput.Pinball.Alarms

get

Gets the AlarmHandler object for the Pinball object.

The AlarmHandler object for the Pinball object.

Definition at line 71 of file Pinball.cs.

Cabinet DirectOutput.Pinball.Cabinet

getset

Gets or sets the Cabinet object for the Pinball object.

The cabinet object for the Pinball object.

Definition at line 55 of file Pinball.cs.

GlobalConfig DirectOutput.Pinball.GlobalConfig

get

Gets the global config for the Pinnball object.

The global config for the Pinball object.

Definition at line 85 of file Pinball.cs.

bool DirectOutput.Pinball.MainThreadIsActive

get

Indicates if the MainThread of DirectOutput is active

Definition at line 538 of file Pinball.cs.

Table.Table DirectOutput.Pinball.Table

getset

Gets or sets the table object for the Pinball object.

The table object for the Pinball object.

Definition at line 42 of file Pinball.cs.

---

The documentation for this class was generated from the following file:

• C:/Users/tom/Documents/Github/DirectOutput/DirectOutput/Pinball.cs