PinballX.Plugin Class Reference

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 occurs during plugin initialization (plugin will be disabled).
void	Configure ()
	The method is called when the configure button in the plugin manager of PinballX is clicked. Open configs windows in the method.
void	Event_App_Exit ()
	This method is called when PinballX exits.
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.
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.
void	Event_GameExit (IntPtr InfoPtr)
	This method is called when the emulator exits from a game.
bool	Event_Input (bool[] Input_Keys, bool[] Input_Buttons, int PinballXStatus)
	This method is called when PinballX receives input from keyboard or buttons.
bool	Event_ScreenSaver (int Type)
	This event is called when PinballX starts or quits the screen saver.
bool	Event_DisableDMD ()
	Plugin ()
	Initializes a new instance of the Plugin class.
void	Dispose ()
	Releases unmanaged and managed resources.

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.

Constructor & Destructor Documentation

Plugin()

PinballX.Plugin.Plugin

(

)

Initializes a new instance of the Plugin class.

Member Function Documentation

Configure()

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.

Dispose()

void PinballX.Plugin.Dispose

(

)

Releases unmanaged and managed resources.

Event_App_Exit()

void PinballX.Plugin.Event_App_Exit

(

)

This method is called when PinballX exits.

Event_DisableDMD()

bool PinballX.Plugin.Event_DisableDMD

(

)

Event_GameExit()

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.

Event_GameRun()

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.

Event_GameSelect()

void PinballX.Plugin.Event_GameSelect

(

IntPtr

InfoPtr

)

Event_Input()

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

Event_Parameters()

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 empty string to preserve to or command line paras.

Event_ScreenSaver()

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

Initialize()

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 occurs during plugin initialization (plugin will be disabled).

Parameters

InfoPtr

The InfoPTR for the PinballXInfo struct.

Returns

true if the plugins has been initialized successfully, otherwise false

Property Documentation

Author

string PinballX.Plugin.Author

get

Description

string PinballX.Plugin.Description

get

Name

string PinballX.Plugin.Name

get

PluginVersion

string PinballX.Plugin.PluginVersion

get

Version

string PinballX.Plugin.Version

get

---

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

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