Difference between revisions of "PlugIn Development:GameEx Initialize Function"
Jump to navigation
Jump to search
Line 20: | Line 20: | ||
public string GameExVersion; | public string GameExVersion; | ||
}</pre> | }</pre> | ||
== <span class="plugin_headline_text">Code Examples</span> == | == <span class="plugin_headline_text">Code Examples</span> == | ||
The code samples below outline the syntax needed to process the call in the <span class="plugin_return_text">PlugIn.dll</span> file within the template.<br /> | The code samples below outline the syntax needed to process the call in the <span class="plugin_return_text">PlugIn.dll</span> file within the template.<br /> |
Revision as of 06:51, 28 April 2014
This function is called when GameEx initializes.
Using this function call, you can run code to do various things, like set up your log files or load your settings.
Returns
This function returns a boolean value.
Return Values
Return true and GameEx will initialize your plugin.
Return false and GameEx will not initialize your plugin.
Structures
VB.NET
<StructLayout(LayoutKind.Sequential)> _ Public Structure GameExInfo Public GameExVersion As String End Structure
C#
[ StructLayout( LayoutKind.Sequential )] public struct GameExInfo { public string GameExVersion; }
Code Examples
The code samples below outline the syntax needed to process the call in the PlugIn.dll file within the template.
VB.NET
Public Function Initialize(ByVal InfoPtr As IntPtr) As Boolean Dim Info As GameExInfo = DirectCast(Marshal.PtrToStructure(InfoPtr, GetType(GameExInfo)), GameExInfo)) 'This will output the current version of GameEx: Dim GameEx_Version As String = Info.GameExVersion Return True End Function
C#
public bool Initialize(IntPtr InfoPtr) { GameExInfo Info = (GameExInfo) Marshal.PtrToStructure(InfoPtr, typeof(GameExInfo)); //This will output the current version of GameEx as a string: string GameEx_Version = Info.GameExVersion; return true; }