Difference between revisions of "PlugIn Development:GameEx Configure Function"

From Spesoft/GameEx Wiki
Jump to navigation Jump to search
Line 2: Line 2:
<br />
<br />
== <span class="plugin_headline_text">Code Examples</span> ==
== <span class="plugin_headline_text">Code Examples</span> ==
The following code assumes that you have a Configuration class with a window for setting options. It's probably good practice that if you don't allow a user to configure any options, you should add a MessageBox.Show command to let the user know there are no user-configurable options so they aren't deterred from enabling your plugin in the PlugIn Manager.
The following code assumes that you have a <span class="plugin_return_text">Configuration</span> class with a window for setting options. It's probably good practice that if you don't allow a user to configure any options, you should add a <span class="plugin_return_text">MessageBox.Show</span> command to let the user know there are no user-configurable options so they aren't deterred from enabling your plugin in the PlugIn Manager.
<br />
<br />
=== <span class="plugin_text_fx">VB.NET</span> ===
=== <span class="plugin_text_fx">VB.NET</span> ===

Revision as of 00:09, 28 April 2014

This function is called when the user configures the PlugIn from the PlugIn Manager interface.
Typically you would launch a configuration window from this sub. If your plugin doesn't require user configuration, you can simply leave this area empty.

Code Examples

The following code assumes that you have a Configuration class with a window for setting options. It's probably good practice that if you don't allow a user to configure any options, you should add a MessageBox.Show command to let the user know there are no user-configurable options so they aren't deterred from enabling your plugin in the PlugIn Manager.

VB.NET


Public Sub Configure()
     Dim config As New Configuration
     config.ShowDialog()
End Sub

C#


public void Configure()
{
     using(Configuration config = new Configuration())
     {
          config.ShowDialog(null);
     }
}