DirectOutputR1
DirectOutput framework R1 for virtual pinball cabinets.
Go to:
Overview 
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
DirectPlugin.DirectOutputPlugin Class Reference

DirectOutputPlugin is the IPlugin interface implementation required by generic the PluginInterface.dll. More...

Inheritance diagram for DirectPlugin.DirectOutputPlugin:
Collaboration diagram for DirectPlugin.DirectOutputPlugin:

Public Member Functions

void DataReceive (char TableElementTypeChar, int Number, int Value)
 This method is called, when the hosting application sends new data to DirectOutput.
The IPlugin interface requires the implementation of this method.
More...
 
void PluginFinish ()
 Finishes the plugin.
This is the last method called, before a plugin is discared. This method is also called, after a undhandled exception has occured in a plugin.
The IPlugin interface requires the implementation of this method.
More...
 
void PluginInit (string HostingApplicationName, string TableFilename, string GameName)
 Initializes the Plugin.
The IPlugin interface requires the implementation of this method.
More...
 
void PluginShowFrontend (Form Owner=null)
 
 DirectOutputPlugin ()
 Initializes a new instance of the DirectOutputPlugin class. More...
 

Properties

string Name [get]
 Gets the name of this IPlugin.
More...
 
Pinball Pinball [get, set]
 Gets or sets the Pinball object for the plugin. More...
 

Detailed Description

DirectOutputPlugin is the IPlugin interface implementation required by generic the PluginInterface.dll.

Definition at line 19 of file Plugin.cs.

Constructor & Destructor Documentation

DirectPlugin.DirectOutputPlugin.DirectOutputPlugin ( )
inline

Initializes a new instance of the DirectOutputPlugin class.

Definition at line 201 of file Plugin.cs.

Member Function Documentation

void DirectPlugin.DirectOutputPlugin.DataReceive ( char  TableElementTypeChar,
int  Number,
int  Value 
)
inline

This method is called, when the hosting application sends new data to DirectOutput.
The IPlugin interface requires the implementation of this method.

Parameters
TableElementTypeCharChar identifying the type of the table element. For a list of valid char, check to docu on the TableElementTypeEnum in DirectOutput.
NumberThe received Number.
ValueThe received value.

Definition at line 50 of file Plugin.cs.

void DirectPlugin.DirectOutputPlugin.PluginFinish ( )
inline

Finishes the plugin.
This is the last method called, before a plugin is discared. This method is also called, after a undhandled exception has occured in a plugin.
The IPlugin interface requires the implementation of this method.

Definition at line 65 of file Plugin.cs.

void DirectPlugin.DirectOutputPlugin.PluginInit ( string  HostingApplicationName,
string  TableFilename,
string  GameName 
)
inline

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

Parameters
HostingApplicationNameName of the hosting application.
TableFilenameThe table filename.
If no table filename is available, it is best to provide a path and name of a non existing dummy file, since the plugins might use this path to identify the directories where the store logs, load configs from and so on.
GameNameName of the game.
If the game is a SS pinball table it is highly recommanded to provide the name of the game rom, otherwise any other name which identifiey to game uniquely will be fine as well.

Definition at line 79 of file Plugin.cs.

void DirectPlugin.DirectOutputPlugin.PluginShowFrontend ( Form  Owner = null)
inline

Definition at line 158 of file Plugin.cs.

Property Documentation

string DirectPlugin.DirectOutputPlugin.Name
get

Gets the name of this IPlugin.

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

The name of this IPlugin (Name is DirectOutput (V: VersionNumber) af of TimeStamp).

Definition at line 32 of file Plugin.cs.

Pinball DirectPlugin.DirectOutputPlugin.Pinball
getset

Gets or sets the Pinball object for the plugin.

The Pinball object for the plugin.

Definition at line 187 of file Plugin.cs.


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