PlugIn Development:GameEx Event CommandLine Function - Revision history

Adultery: /* Parameter Values */

2014-04-30T21:22:08Z

Parameter Values

← Older revision		Revision as of 21:22, 30 April 2014
Line 6:		Line 6:
	=== <span class="plugin_text_fx">Parameter Values</span> ===		=== <span class="plugin_text_fx">Parameter Values</span> ===
	The <span class="plugin_return_text">InfoPtr</span> passed to this variable populates the <span class="plugin_return_text">GameInfo structure</span> when passed via <span class="plugin_return_text">DirectCast</span> like so:<br />		The <span class="plugin_return_text">InfoPtr</span> passed to this variable populates the <span class="plugin_return_text">GameInfo structure</span> when passed via <span class="plugin_return_text">DirectCast</span> like so:<br />
	<span class="plugin_header_mini">VB.NET:</span> <span class="plugin_return_text">~~Dim~~ Info As Game_Info = DirectCast(Marshal.PtrToStructure(InfoPtr, GetType(Game_Info)), Game_Info)</span><br />		<span class="plugin_header_mini">VB.NET:</span> <span class="plugin_return_text_noline">Dim</span> <span class="plugin_return_text">Info</span> <span class="plugin_return_text_noline">As</span> <span class="plugin_return_text">Game_Info</span> <span class="plugin_return_text_noline">= DirectCast(Marshal.PtrToStructure(InfoPtr, GetType(Game_Info)), Game_Info)</span><br />
	<span class="plugin_header_mini">C#:</span> <span class="plugin_return_text">Game_Info Info = (Game_Info)Marshal.PtrToStructure(InfoPtr, typeof(Game_Info));</span>		<span class="plugin_header_mini">C#:</span> <span class="plugin_return_text">Game_Info</span> <span class="plugin_return_text">Info</span> <span class="plugin_return_text_noline">= (Game_Info)Marshal.PtrToStructure(InfoPtr, typeof(Game_Info));</span>
	<br />		<br />

Adultery: /* Parameter Values */

2014-04-30T19:52:43Z

Parameter Values

← Older revision		Revision as of 19:52, 30 April 2014
Line 6:		Line 6:
	=== <span class="plugin_text_fx">Parameter Values</span> ===		=== <span class="plugin_text_fx">Parameter Values</span> ===
	The <span class="plugin_return_text">InfoPtr</span> passed to this variable populates the <span class="plugin_return_text">GameInfo structure</span> when passed via <span class="plugin_return_text">DirectCast</span> like so:<br />		The <span class="plugin_return_text">InfoPtr</span> passed to this variable populates the <span class="plugin_return_text">GameInfo structure</span> when passed via <span class="plugin_return_text">DirectCast</span> like so:<br />
	VB.NET: <span class="plugin_return_text">Dim Info As Game_Info = DirectCast(Marshal.PtrToStructure(InfoPtr, GetType(Game_Info)), Game_Info)</span><br />		<span class="plugin_header_mini">VB.NET:</span> <span class="plugin_return_text">Dim Info As Game_Info = DirectCast(Marshal.PtrToStructure(InfoPtr, GetType(Game_Info)), Game_Info)</span><br />
	C#: <span class="plugin_return_text">Game_Info Info = (Game_Info)Marshal.PtrToStructure(InfoPtr, typeof(Game_Info));</span>		<span class="plugin_header_mini">C#:</span> <span class="plugin_return_text">Game_Info Info = (Game_Info)Marshal.PtrToStructure(InfoPtr, typeof(Game_Info));</span>
	<br />		<br />

Adultery at 19:49, 30 April 2014

2014-04-30T19:49:27Z

Show changes

Adultery: /* C# */

2014-04-28T14:15:09Z

← Older revision		Revision as of 14:15, 28 April 2014
Line 49:		Line 49:

	=== <span class="plugin_text_fx">C#</span> ===		=== <span class="plugin_text_fx">C#</span> ===
	~~----~~
	==== <span style="color:purple;">Structure</span> ====		==== <span style="color:purple;">Structure</span> ====
	<pre class="~~code_block_struc~~">		<pre class="code_es_cs">
	[ StructLayout( LayoutKind.Sequential )]		[ StructLayout( LayoutKind.Sequential )]
	public struct Game_Info		public struct Game_Info
Line 69:		Line 68:
	};</pre>		};</pre>
	==== <span style="color:purple;">Function</span> ====		==== <span style="color:purple;">Function</span> ====
	<pre class="~~code_block_func~~">		<pre class="code_cs">
	public string Event_CommandLine(IntPtr InfoPtr)		public string Event_CommandLine(IntPtr InfoPtr)
	{		{

Adultery: /* Function */

2014-04-28T14:14:20Z

Function

← Older revision		Revision as of 14:14, 28 April 2014
Line 40:		Line 40:

	==== <span style="color:purple;">Function</span> ====		==== <span style="color:purple;">Function</span> ====
	<pre class="~~code_block_func~~">		<pre class="code_vb">
	Public Function Event_CommandLine(ByVal InfoPtr As IntPtr) As String		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 Info As Game_Info = CType(Marshal.PtrToStructure(InfoPtr, GetType(Game_Info)), Game_Info)

Adultery: /* Structure */

2014-04-28T14:13:43Z

Structure

← Older revision		Revision as of 14:13, 28 April 2014
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="~~code_block_struc~~">		<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">

Adultery: /* Parameter Values */

2014-04-28T01:42:55Z

Parameter Values

← Older revision		Revision as of 01:42, 28 April 2014
Line 7:		Line 7:
	=== <span class="plugin_text_fx">Parameter Values</span> ===		=== <span class="plugin_text_fx">Parameter Values</span> ===
	The <span class="plugin_return_text">InfoPtr</span> passed to this variable populates the <span class="plugin_return_text">GameInfo structure</span> when passed via <span class="plugin_return_text">DirectCast</span> like so:<br />		The <span class="plugin_return_text">InfoPtr</span> passed to this variable populates the <span class="plugin_return_text">GameInfo structure</span> when passed via <span class="plugin_return_text">DirectCast</span> like so:<br />
	VB.NET: <span class="plugin_return_text">Dim Info As Game_Info = ~~CType~~(Marshal.PtrToStructure(InfoPtr, GetType(Game_Info)), Game_Info)</span><br />		VB.NET: <span class="plugin_return_text">Dim Info As Game_Info = DirectCast(Marshal.PtrToStructure(InfoPtr, GetType(Game_Info)), Game_Info)</span><br />
	C#: <span class="plugin_return_text">Game_Info Info = (Game_Info)Marshal.PtrToStructure(InfoPtr, typeof(Game_Info));</span>		C#: <span class="plugin_return_text">Game_Info Info = (Game_Info)Marshal.PtrToStructure(InfoPtr, typeof(Game_Info));</span>
	<br />		<br />

	== <span class="plugin_headline_text">Returns</span> ==		== <span class="plugin_headline_text">Returns</span> ==
	This function returns a <span class="plugin_return_text">string</span> value.		This function returns a <span class="plugin_return_text">string</span> value.

Adultery at 01:41, 28 April 2014

2014-04-28T01:41:30Z

← Older revision		Revision as of 01:41, 28 April 2014
Line 1:		Line 1:
	This function is called when GameEx populates the command line for the chosen game.<br />~~Using this function call, you can return an altered command line for GameEx to run instead of the user configured one.~~<~~br />You can return <span style~~="~~color:red;~~">~~'''String.Empty'''~~<~~/span~~> ~~or <span style="color~~:~~red;">'''Info.CmdLine'''~~</~~span~~> ~~and GameEx will not make any changes to the user~~'~~s command line.<br />It should also be noted that 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.		This function is called when GameEx populates the command line for the chosen game.<br />
			<div class="note_block_red"><b>PLEASE NOTE:</b> ''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 <span class="plugin_return_text">DirectCast</span> during the GameRun or the GameSelect event.''</div>
			<br />
			== <span class="plugin_headline_text">Parameters</span> ==
			<span class="plugin_return_text">InfoPtr [IntPtr]</span>: An array of game data, which should be pushed to the <span class="plugin_return_text">GameInfo structure</span> using a <span class="plugin_return_text">DirectCast</span>.
			<br />
			=== <span class="plugin_text_fx">Parameter Values</span> ===
			The <span class="plugin_return_text">InfoPtr</span> passed to this variable populates the <span class="plugin_return_text">GameInfo structure</span> when passed via <span class="plugin_return_text">DirectCast</span> like so:<br />
			VB.NET: <span class="plugin_return_text">Dim Info As Game_Info = CType(Marshal.PtrToStructure(InfoPtr, GetType(Game_Info)), Game_Info)</span><br />
			C#: <span class="plugin_return_text">Game_Info Info = (Game_Info)Marshal.PtrToStructure(InfoPtr, typeof(Game_Info));</span>
			<br />
			== <span class="plugin_headline_text">Returns</span> ==
			This function returns a <span class="plugin_return_text">string</span> value.
			<br />
			=== <span class="plugin_text_fx">Return Values</span> ===
			Return your modified <span class="plugin_return_text">CmdLine string</span> and GameEx will use the new command line when it runs the game.<br />
			Alternatively, you can return <span class="plugin_return_text">Nothing</span> and GameEx will process the currently configured command line.
			<br />
			== <span class="plugin_headline_text">Code Examples</span> ==

	~~== <span style="color:darkblue;">Code Examples</span> ==~~		=== <span class="plugin_text_fx">VB.NET</span> ===

	=== <span ~~style~~="~~color:#003300;~~">VB.NET</span> ===
	~~----~~
	==== <span style="color:purple;">Structure</span> ====		==== <span style="color:purple;">Structure</span> ====
	<pre ~~style~~="~~font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:dashed;~~">		<pre class="code_block_struc">
	<StructLayout(LayoutKind.Sequential)> _		<StructLayout(LayoutKind.Sequential)> _
	Public Structure Game_Info		Public Structure Game_Info
Line 23:		Line 38:
	End Structure</pre>		End Structure</pre>
	==== <span style="color:purple;">Function</span> ====		==== <span style="color:purple;">Function</span> ====
	<pre ~~style~~="~~font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:solid;~~">		<pre class="code_block_func">
	Public Function Event_CommandLine(ByVal InfoPtr As IntPtr) As String		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 Info As Game_Info = CType(Marshal.PtrToStructure(InfoPtr, GetType(Game_Info)), Game_Info)
Line 31:		Line 46:
	End Function</pre>		End Function</pre>

	=== <span ~~style~~="~~color:#003300;~~">C#</span> ===		=== <span class="plugin_text_fx">C#</span> ===
	----		----
	==== <span style="color:purple;">Structure</span> ====		==== <span style="color:purple;">Structure</span> ====
	<pre ~~style~~="~~font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:dashed;~~">		<pre class="code_block_struc">
	[ StructLayout( LayoutKind.Sequential )]		[ StructLayout( LayoutKind.Sequential )]
	public struct Game_Info		public struct Game_Info
Line 52:		Line 67:
	};</pre>		};</pre>
	==== <span style="color:purple;">Function</span> ====		==== <span style="color:purple;">Function</span> ====
	<pre ~~style~~="~~font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:solid;~~">		<pre class="code_block_func">
	public string Event_CommandLine(IntPtr InfoPtr)		public string Event_CommandLine(IntPtr InfoPtr)
	{		{

Adultery: /* Code Examples */

2014-04-27T07:34:05Z

Code Examples

← Older revision		Revision as of 07:34, 27 April 2014
Line 4:		Line 4:

	=== <span style="color:#003300;">VB.NET</span> ===		=== <span style="color:#003300;">VB.NET</span> ===
			----
	==== <span style="color:purple;">Structure</span> ====		==== <span style="color:purple;">Structure</span> ====
	<pre style="font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:dashed;">		<pre style="font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:dashed;">
Line 31:		Line 32:

	=== <span style="color:#003300;">C#</span> ===		=== <span style="color:#003300;">C#</span> ===
			----
	==== <span style="color:purple;">Structure</span> ====		==== <span style="color:purple;">Structure</span> ====
	<pre style="font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:dashed;">		<pre style="font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:dashed;">

Adultery: /* Code Examples */

2014-04-27T06:52:31Z

Code Examples

← Older revision		Revision as of 06:52, 27 April 2014
Line 4:		Line 4:

	=== <span style="color:#003300;">VB.NET</span> ===		=== <span style="color:#003300;">VB.NET</span> ===
	==== Structure ====		==== <span style="color:purple;">Structure</span> ====
	<pre style="font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:dashed;">		<pre style="font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:dashed;">
	<StructLayout(LayoutKind.Sequential)> _		<StructLayout(LayoutKind.Sequential)> _
Line 21:		Line 21:
	Public CmdLine As String		Public CmdLine As String
	End Structure</pre>		End Structure</pre>
	==== Function ====		==== <span style="color:purple;">Function</span> ====
	<pre style="font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:solid;">		<pre style="font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:solid;">
	Public Function Event_CommandLine(ByVal InfoPtr As IntPtr) As String		Public Function Event_CommandLine(ByVal InfoPtr As IntPtr) As String
Line 31:		Line 31:

	=== <span style="color:#003300;">C#</span> ===		=== <span style="color:#003300;">C#</span> ===
	==== Structure ====		==== <span style="color:purple;">Structure</span> ====
	<pre style="font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:dashed;">		<pre style="font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:dashed;">
	[ StructLayout( LayoutKind.Sequential )]		[ StructLayout( LayoutKind.Sequential )]
Line 49:		Line 49:
	public string CMDLine;		public string CMDLine;
	};</pre>		};</pre>
	==== Function ====		==== <span style="color:purple;">Function</span> ====
	<pre style="font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:solid;">		<pre style="font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:solid;">
	public string Event_CommandLine(IntPtr InfoPtr)		public string Event_CommandLine(IntPtr InfoPtr)