Mod

java.lang.Object

me.mythicalflame.spigotmodding.utilities.Mod

public final class Mod extends Object

Represents a game modification.

Constructor Summary

Constructors

Constructor

Description

Mod(String namespace, String displayName, Version APIVersion)

Constructs a mod.
Method Summary

Modifier and Type

Method

Description

Version

getAPIVersion()

String

getDisplayName()

String

getNamespace()

ArrayList<ModdedArmorSet>

getRegisteredArmor()

ArrayList<ModdedItem>

getRegisteredItems()

void

registerArmor(ModdedArmorSet set)

Registers an armor set with the mod.

void

registerItem(ModdedItem item)

Registers a custom item with the mod.

String

toString()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- Mod
  
  public Mod(String namespace, String displayName, Version APIVersion)
  
  Constructs a mod.
  
  Parameters:
  
  namespace - The namespace that this mod belongs to.
  
  displayName - The display name of this mod.
  
  APIVersion - The API version that this mod is based off of.
Method Details
- getNamespace
  
  public String getNamespace()
  
  Returns:
  
  The namespace that this mod belongs to.
- getDisplayName
  
  public String getDisplayName()
  
  Returns:
  
  The display name of this mod.
- getAPIVersion
  
  public Version getAPIVersion()
  
  Returns:
  
  The API version this mod is based off of.
- getRegisteredItems
  
  public ArrayList<ModdedItem> getRegisteredItems()
  
  Returns:
  
  An ArrayList of the ModdedItems registered in this mod.
- getRegisteredArmor
  
  public ArrayList<ModdedArmorSet> getRegisteredArmor()
  
  Returns:
  
  An ArrayList of the ModdedArmorSets registered in this mod.
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- registerItem
  
  public void registerItem(ModdedItem item)
  
  Registers a custom item with the mod.
  
  Parameters:
  
  item - The custom item to register.
- registerArmor
  
  public void registerArmor(ModdedArmorSet set)
  
  Registers an armor set with the mod.
  
  Parameters:
  
  set - The armor set to register.