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

From Spesoft/GameEx Wiki
Jump to navigation Jump to search
 
(6 intermediate revisions by the same user not shown)
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 style="color:darkblue;">Code Examples</span> ==
== <span class="plugin_headline_text">Parameters</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.
This substructre has no available parameters.
<br />
<br />
=== <span style="color:#003300;">VB.NET</span> ===
== <span class="plugin_headline_text">Code Examples</span> ==
<pre style="font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:solid;">
The following code assumes that you have a <span class="plugin_return_text">Configuration</span> class with a window for setting options. <br />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 />
=== <span class="plugin_text_fx">VB.NET</span> ===
<pre class="code_vb">
Public Sub Configure()
Public Sub Configure()
     Dim config As New Configuration
     Dim config As New Configuration
Line 11: Line 14:
End Sub</pre>
End Sub</pre>


=== <span style="color:#003300;">C#</span> ===
=== <span class="plugin_text_fx">C#</span> ===
<pre style="font-family:'Lucida Console', Monaco, monospace; border-color:#003300; background-color:#E0EEE0; border-style:solid;">
<pre class="code_cs">
public void Configure()
public void Configure()
{
{

Latest revision as of 07: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.

Parameters

This substructre has no available parameters.

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);
     }
}


Retrieved from "https://gameex.info/wiki/index.php?title=PlugIn_Development:GameEx_Configure_Function&oldid=1999"