Difference between revisions of "PlugIn Development:GameEx Event CommandLine Function"
Jump to navigation
Jump to search
Line 22: | Line 22: | ||
=== <span class="plugin_text_fx">VB.NET</span> === | === <span class="plugin_text_fx">VB.NET</span> === | ||
==== <span style="color:purple;">Structure</span> ==== | ==== <span style="color:purple;">Structure</span> ==== | ||
<pre class=" | <pre class="code_es_vb"> | ||
<StructLayout(LayoutKind.Sequential)> _ | <StructLayout(LayoutKind.Sequential)> _ | ||
Public Structure Game_Info | Public Structure Game_Info | ||
Line 38: | Line 38: | ||
Public CmdLine As String | Public CmdLine As String | ||
End Structure</pre> | End Structure</pre> | ||
==== <span style="color:purple;">Function</span> ==== | ==== <span style="color:purple;">Function</span> ==== | ||
<pre class="code_block_func"> | <pre class="code_block_func"> |
Revision as of 14:13, 28 April 2014
This function is called when GameEx populates the command line for the chosen game.
PLEASE NOTE: The only info pushed down to this event is the command line since PlugIn Version 1.41. For the additional info exposed in the structure, you will need to push a DirectCast during the GameRun or the GameSelect event.
Parameters
InfoPtr [IntPtr]: An array of game data, which should be pushed to the GameInfo structure using a DirectCast.
Parameter Values
The InfoPtr passed to this variable populates the GameInfo structure when passed via DirectCast like so:
VB.NET: Dim Info As Game_Info = DirectCast(Marshal.PtrToStructure(InfoPtr, GetType(Game_Info)), Game_Info)
C#: Game_Info Info = (Game_Info)Marshal.PtrToStructure(InfoPtr, typeof(Game_Info));
Returns
This function returns a string value.
Return Values
Return your modified CmdLine string and GameEx will use the new command line when it runs the game.
Alternatively, you can return Nothing and GameEx will process the currently configured command line.
Code Examples
VB.NET
Structure
<StructLayout(LayoutKind.Sequential)> _ Public Structure Game_Info Public EmulatorNumber As Integer Public EmulatorName As String 'No value is passed during this event Public GameName As String 'No value is passed during this event Public ROMPath As String 'No value is passed during this event Public ROMName As String 'No value is passed during this event Public GameData As Database 'No value is passed during this event Public MameInfo As Mame_Info 'No value is passed during this event Public RomFilter As String 'No value is passed during this event Public SnapPath As String 'No value is passed during this event Public VideoPath As String 'No value is passed during this event Public TitlePath As String 'No value is passed during this event Public CmdLine As String End Structure
Function
Public Function Event_CommandLine(ByVal InfoPtr As IntPtr) As String Dim Info As Game_Info = CType(Marshal.PtrToStructure(InfoPtr, GetType(Game_Info)), Game_Info) Dim CmdLine As String = Info.CmdLine 'Run some code here! Return CmdLine End Function
C#
Structure
[ StructLayout( LayoutKind.Sequential )] public struct Game_Info { public int EmulatorNumber; public string EmulatorName; //No value is passed during this event public string GameName; //No value is passed during this event public string ROMPath; //No value is passed during this event public string ROMName; //No value is passed during this event public Database GameData; //No value is passed during this event public Mame_Info MameInfo; //No value is passed during this event public string ROMFilter; //No value is passed during this event public string SnapPath; //No value is passed during this event public string VideoPath; //No value is passed during this event public string TitlePath; //No value is passed during this event public string CMDLine; };
Function
public string Event_CommandLine(IntPtr InfoPtr) { Game_Info Info = (Game_Info)Marshal.PtrToStructure(InfoPtr, typeof(Game_Info)); string CmdLine = Info.CMDLine; //Run some code here! return CmdLine; }