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.
void	Init ()
	Initializes/starts the Pinball object.
void	Finish ()
	Finishes the Pinball object.
void	MainThreadSignal ()
	Signals the main thread to continue its work (if currently sleeping).
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.
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.
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.
override string	ToString ()
	Returns a System.String that represents this instance.
	Pinball ()
	Initializes a new instance of the Pinball class.

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

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.

Constructor & Destructor Documentation

Pinball()

DirectOutput.Pinball.Pinball

(

)

Initializes a new instance of the Pinball class.

Member Function Documentation

Finish()

void DirectOutput.Pinball.Finish

(

)

Finishes the Pinball object.

Init()

void DirectOutput.Pinball.Init

(

)

Initializes/starts the Pinball object.

MainThreadSignal()

void DirectOutput.Pinball.MainThreadSignal

(

)

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

ReceiveData() [1/3]

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.

ReceiveData() [2/3]

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.

ReceiveData() [3/3]

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.

Setup()

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.

ToString()

override string DirectOutput.Pinball.ToString

(

)

Returns a System.String that represents this instance.

Returns

A System.String that represents this instance.

Property Documentation

Alarms

AlarmHandler DirectOutput.Pinball.Alarms

get

Gets the AlarmHandler object for the Pinball object.

The AlarmHandler object for the Pinball object.

Cabinet

Cabinet DirectOutput.Pinball.Cabinet

getset

Gets or sets the Cabinet object for the Pinball object.

The cabinet object for the Pinball object.

GlobalConfig

GlobalConfig DirectOutput.Pinball.GlobalConfig

get

Gets the global config for the Pinball object.

The global config for the Pinball object.

MainThreadIsActive

bool DirectOutput.Pinball.MainThreadIsActive

get

Indicates if the MainThread of DirectOutput is active.

Table

Table.Table DirectOutput.Pinball.Table

getset

Gets or sets the table object for the Pinball object.

The table object for the Pinball object.

---

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

• D:/a/DirectOutput/DirectOutput/DirectOutput/Pinball.cs