This is the base calls for PinballX plugins. It contains the public methods which are called from PinballX when it is using the plugin. More...

Public Member Functions
bool	Initialize (IntPtr InfoPtr)
	Initializes the plugin. This method is called when PinballX loads and initializes the plugin. Be sure to return false if a exception ocurres during plugin initialization (plugin will be disabled). More...

void	Configure ()
	The method is called when the configure button in the plugin manager of PinballX is clicked. Open configs windows in the method. More...

void	Event_App_Exit ()
	This method is called when PinballX exits More...

void	Event_GameSelect (IntPtr InfoPtr)

bool	Event_GameRun (IntPtr InfoPtr)
	This method is called before a game is launched. Return true to tell PinballX process the event Return false to tell PinballX NOT to process the event More...

string	Event_Parameters (IntPtr InfoPtr)
	This method is after PinballX has built the command line parameters. You can return a modified command line from this method. To do nothing return an empty string or the same command line More...

void	Event_GameExit (IntPtr InfoPtr)
	This method is called when the emulator exits from a game. More...

bool	Event_Input (bool[] Input_Keys, bool[] Input_Buttons, int PinballXStatus)
	This method is called when PinballX receives input from keyboard or buttons More...

bool	Event_ScreenSaver (int Type)
	This event is called when PinballX starts or quits the screen saver. More...

bool	Event_DisableDMD ()

	Plugin ()
	Initializes a new instance of the Plugin class. More...

void	Dispose ()
	Releases unmanaged and managed resources. More...

Properties
string	Name `[get]`

string	Version `[get]`

string	Author `[get]`

string	Description `[get]`

string	PluginVersion `[get]`

Detailed Description

This is the base calls for PinballX plugins. It contains the public methods which are called from PinballX when it is using the plugin.

Definition at line 19 of file Plugin.cs.

Constructor & Destructor Documentation

PinballX.Plugin.Plugin ( )

Initializes a new instance of the Plugin class.

Definition at line 691 of file Plugin.cs.

Member Function Documentation

void PinballX.Plugin.Configure ( )

The method is called when the configure button in the plugin manager of PinballX is clicked. Open configs windows in the method.

Definition at line 359 of file Plugin.cs.

void PinballX.Plugin.Dispose ( )

Releases unmanaged and managed resources.

Definition at line 702 of file Plugin.cs.

void PinballX.Plugin.Event_App_Exit ( )

This method is called when PinballX exits

Definition at line 388 of file Plugin.cs.

bool PinballX.Plugin.Event_DisableDMD ( )

Definition at line 682 of file Plugin.cs.

void PinballX.Plugin.Event_GameExit ( IntPtr InfoPtr )

This method is called when the emulator exits from a game.

Parameters

InfoPtr The InfoPTR to the GameInfo structure.

Definition at line 498 of file Plugin.cs.

bool PinballX.Plugin.Event_GameRun ( IntPtr InfoPtr )

This method is called before a game is launched. Return true to tell PinballX process the event Return false to tell PinballX NOT to process the event

Parameters

InfoPtr The InfoPTR to the GameInfo structure.

Returns: true if the game has to be launched, otherwise false.

Definition at line 451 of file Plugin.cs.

void PinballX.Plugin.Event_GameSelect ( IntPtr InfoPtr )

Definition at line 419 of file Plugin.cs.

bool PinballX.Plugin.Event_Input	(	bool[]	Input_Keys,
		bool[]	Input_Buttons,
		int	PinballXStatus
	)

This method is called when PinballX receives input from keyboard or buttons

Parameters

Input_Keys	The input keys.
Input_Buttons	The input buttons.
PinballXStatus	The PinballX status.

Returns

Definition at line 524 of file Plugin.cs.

string PinballX.Plugin.Event_Parameters ( IntPtr InfoPtr )

This method is after PinballX has built the command line parameters. You can return a modified command line from this method. To do nothing return an empty string or the same command line

Parameters

InfoPtr The InfoPTR to the GameInfo structure.

Returns: Returns the parameters for the command line (modified if required) or a emty string to preserve to or command line paras.

Definition at line 484 of file Plugin.cs.

bool PinballX.Plugin.Event_ScreenSaver ( int Type )

This event is called when PinballX starts or quits the screen saver.

Parameters

Type	The type of the call (Start ScreenSaver=1, End Screensaver=2).

Returns: Return true to tell PinballX process the event. Return false to tell PinballX NOT to process the event

Definition at line 650 of file Plugin.cs.

bool PinballX.Plugin.Initialize ( IntPtr InfoPtr )

Initializes the plugin. This method is called when PinballX loads and initializes the plugin. Be sure to return false if a exception ocurres during plugin initialization (plugin will be disabled).

Parameters

InfoPtr The InfoPTR for the PinballXInfo struct.

Returns: true if the plugins has been initialized succesfully, otherwise false

Definition at line 315 of file Plugin.cs.

Property Documentation

string PinballX.Plugin.Author

get

Definition at line 754 of file Plugin.cs.

string PinballX.Plugin.Description

get

Definition at line 759 of file Plugin.cs.

string PinballX.Plugin.Name

get

Definition at line 744 of file Plugin.cs.

string PinballX.Plugin.PluginVersion

get

Definition at line 764 of file Plugin.cs.

string PinballX.Plugin.Version

get

Definition at line 749 of file Plugin.cs.

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

C:/Users/tom/Documents/Github/DirectOutput/DirectOutput PinballX Plugin/Plugin.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation