+ Plugin prerequisites
+ +The Plugin Class
+-
+
- Your plugin must have a
Pluginclass.
+ - The
Pluginclass is the main class of your plugin. It contains the entry point of your plugin and is used to initialize your plugin.-
+
- It is typically named either
Plugin,MainClass, or the name of your plugin.
+
+ - It is typically named either
- The
Pluginclass must have a method with thePluginEntryPointattribute.-
+
- 4 parameters must be passed on to
PluginEntryPointattribute, in the following order:
+Plugin Name, Plugin Version, Plugin Author, and Plugin Description.
+ - If you are planning to use any kind of events, you would call
EventManager::RegisterEventsin thePluginEntryPointmethod, more on that in the EventHandlers section.
+ - Here is also where a Singleton would be initialized.
+### The
ConfigClass
+
+ - 4 parameters must be passed on to
- #### The
Configclass isn't required, but is recommended since you will need to if you're planning on letting serverhosts make any changes to your plugin
+ - The
Configclass contains properties, which values will be serialized and deserialized into/from a YML file when the plugin loads.-
+
- Properties are similar to fields, except they have a getter and a setter.
public string Text { get; set; }is an example property.
+ - Properties can be of any supported type, but they must be public. +
- You can prevent properties from being serialized using the
[YamlIgnore]attribute, this, however, will require theYamlDotNetpackage to be installed.
+ - Non-public properties and anything else that isn't a property will be ignored. +
+ - Properties are similar to fields, except they have a getter and a setter.
- You need to define your
Configclass in thePluginclass using thePluginConfigattribute, by adding it to a field with yourConfigclass as type.
This typicially looks like this:
+csharp +[PluginConfig] +public Config Config;
+ - You can access any values inside the config via its instance defined the the
Pluginclass.-
+
- If you need to read values outside the
Pluginclass, consider making yourPlugina Singleton. +### Event Handlers
+
+ - If you need to read values outside the
- An event handler is a method that are called when a specific event is triggered. +
- An event handler is marked with the
PluginEvent(EventType)attribute.
+ - Any class containing an event handler must be registered using
EventManager.RegisterEvents<CLASSNAME>(this);in thePluginEntryPointmethod.-
+
- If the event handler is in the
Pluginclass, you can simply callEventManager.RegisterEvents(this);.
+
+ - If the event handler is in the
- Here is an example of an event handler which displays a welcome message:
+
csharp +[PluginEvent(ServerEventType.PlayerJoined)] +public void OnPlayerJoin(Player player) +{ + player.SendBroadcast("Welcome to the server!", 5); +}
+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+