Difference between revisions of "PlugIn Development:GameEx Configure Function"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
This function is called when the user configures the PlugIn from the PlugIn Manager interface.<br />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. | This function is called when the user configures the PlugIn from the PlugIn Manager interface.<br />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. | ||
<br /> | <br /> | ||
== <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 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. | ||
<br /> | <br /> | ||
=== <span | === <span class="plugin_text_fx">VB.NET</span> === | ||
---- | ---- | ||
<pre | <pre class="code_block_func"> | ||
Public Sub Configure() | Public Sub Configure() | ||
Dim config As New Configuration | Dim config As New Configuration | ||
| Line 12: | Line 12: | ||
End Sub</pre> | End Sub</pre> | ||
=== <span | === <span class="plugin_text_fx">C#</span> === | ||
---- | ---- | ||
<pre | <pre class="code_block_func"> | ||
public void Configure() | public void Configure() | ||
{ | { | ||
Revision as of 00:07, 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);
}
}