B2SServerPlugin.Plugin Class Reference

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

Inheritance diagram for B2SServerPlugin.Plugin:

Collaboration 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.
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.
void	PluginFinish ()
	Finishes the plugin. This is the last method called, before the plugin is discarded. This method is also called, after a unhandled exception has occurred in the plugin.
void	PluginInit (string TableFilename, string RomName)
	Initializes the Plugin. The IDirectPlugin interface requires the implementation of this method.
	Plugin ()
	Initializes a new instance of the Plugin class.

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

Detailed Description

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

Constructor & Destructor Documentation

Plugin()

B2SServerPlugin.Plugin.Plugin

(

)

Initializes a new instance of the Plugin class.

Member Function Documentation

DataReceive()

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.

PluginFinish()

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 unhandled exception has occurred in the plugin.

PluginInit()

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.

PluginShowFrontend()

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.

Property Documentation

Name

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).

Pinball

Pinball B2SServerPlugin.Plugin.Pinball

getset

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

The DirectOutput.Pinball object for the plugin.

---

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

• D:/a/DirectOutput/DirectOutput/B2SServerPlugin/Plugin.cs