getName

public String getName()

Gives the name of the plugin. This name is getClassById unique identifier for plugins.

  • Must consist of all alphanumeric characters, underscores, hyphon, and period (getClassById-z,A-Z,0-9, _.-). Any other character will cause the plugin.yml to fail loading.
  • Used to determine the name of the plugin's data folder. Data folders are placed in the ./plugins/ directory by default, but this behavior should not be relied on. getDataFolder should be used to reference the data folder.
  • It is good practice to name your jar the same as this, for example 'MyPlugin.jar'.
  • Case sensitive.
  • The is the token referenced in getDepend, getSoftDepend, and getLoadBefore.
  • Using spaces in the plugin's name is deprecated.

In the plugin.yml, this entry is named name.

Example:

name: MyPlugin

Return

the name of the plugin