B2SServerPlugin.Plugin Class Reference

Plugin is the IDirectPlugin interface implementation required by the B2S Server. More...

Inheritance diagram for B2SServerPlugin.Plugin:

Public Member Functions
void	PluginShowFrontend (System.Windows.Forms.Form Owner=null)
	Shows the frontend of the the DirectOutput framework. The IDirectPluginFrontend interface requires the implementation of this method. More...
void	DataReceive (char TableElementTypeChar, int Number, int Value)
	This method is called, when new data from Pinmame becomes available. The IDirectPlugin interface requires the implementation of this method. More...
void	PluginFinish ()
	Finishes the plugin. This is the last method called, before the plugin is discarded. This method is also called, after a undhandled exception has occured in the plugin. More...
void	PluginInit (string TableFilename, string RomName)
	Initializes the Plugin. The IDirectPlugin interface requires the implementation of this method. More...
	Plugin ()
	Initializes a new instance of the Plugin class. More...

Properties
string	Name [get]
	Gets the name of the IDirectPlugin. More...
Pinball	Pinball [get, set]
	Gets or sets the DirectOutput.Pinball object for the plugin. More...

Detailed Description

Plugin is the IDirectPlugin interface implementation required by the B2S Server.

Definition at line 18 of file Plugin.cs.

Constructor & Destructor Documentation

B2SServerPlugin.Plugin.Plugin

(

)

Initializes a new instance of the Plugin class.

Definition at line 209 of file Plugin.cs.

Member Function Documentation

void B2SServerPlugin.Plugin.DataReceive	(	char	TableElementTypeChar,
		int	Number,
		int	Value
	)

This method is called, when new data from Pinmame becomes available.
The IDirectPlugin interface requires the implementation of this method.

Parameters

TableElementTypeChar	Char representing the table element type. Check the DirectOutput.TableElementTypeEnum for valid values.
Number	The number of the table element.
Value	The value of the table element.

Definition at line 73 of file Plugin.cs.

void B2SServerPlugin.Plugin.PluginFinish

(

)

Finishes the plugin.
This is the last method called, before the plugin is discarded. This method is also called, after a undhandled exception has occured in the plugin.

Definition at line 85 of file Plugin.cs.

void B2SServerPlugin.Plugin.PluginInit	(	string	TableFilename,
		string	RomName
	)

Initializes the Plugin.
The IDirectPlugin interface requires the implementation of this method.

Parameters

TableFilename	The table filename.
RomName	Name of the rom.

Definition at line 97 of file Plugin.cs.

void B2SServerPlugin.Plugin.PluginShowFrontend

(

System.Windows.Forms.Form

Owner = null

)

Shows the frontend of the the DirectOutput framework.
The IDirectPluginFrontend interface requires the implementation of this method.

Definition at line 28 of file Plugin.cs.

Property Documentation

string B2SServerPlugin.Plugin.Name

get

Gets the name of the IDirectPlugin.

Remarks

This property returns the version of the DirectOutput.dll, NOT the version of the B2SServer plugin.

The name of this IDirectPlugin (Name is DirectOutput (V: VersionNumber) as of TimeStamp).

Definition at line 55 of file Plugin.cs.

Pinball B2SServerPlugin.Plugin.Pinball

getset

Gets or sets the DirectOutput.Pinball object for the plugin.

The DirectOutput.Pinball object for the plugin.

Definition at line 195 of file Plugin.cs.

---

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

• C:/Users/tom/Documents/Github/DirectOutput/B2SServerPlugin/Plugin.cs