Package me.hsgamer.hscore.addon.object

Class Addon

java.lang.Object

me.hsgamer.hscore.addon.object.Addon

All Implemented Interfaces:

Expansion

public abstract class Addon
extends Object
implements Expansion

The main class of the addon

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Addon()

Method Summary

Modifier and Type	Method	Description
final @NotNull File	getDataFolder()	Get the addon's folder
final @NotNull AddonDescription	getDescription()	Get the addon's description
ExpansionClassLoader	getExpansionClassLoader()	Get the expansion class loader
final @Nullable InputStream	getResource(@NotNull String path)	Get the resource from the addon's jar
void	onPostEnable()	Called after all addons enabled
void	onReload()	Called when reloading
final void	saveResource(@NotNull String path, boolean replace)	Copy the resource from the addon's jar

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface me.hsgamer.hscore.expansion.common.Expansion

onDisable, onEnable, onLoad

Constructor Details

Addon

protected Addon()

Method Details

onPostEnable

public void onPostEnable()

Called after all addons enabled

onReload

public void onReload()

Called when reloading

getDescription

@NotNull
public final @NotNull AddonDescription getDescription()

Get the addon's description

Returns:

the description

getDataFolder

@NotNull
public final @NotNull File getDataFolder()

Get the addon's folder

Returns:

the directory for the addon

saveResource

public final void saveResource(@NotNull
 @NotNull String path,
 boolean replace)

Copy the resource from the addon's jar

Parameters:

path - path to resource

replace - whether it replaces the existed one

getResource

@Nullable
public final @Nullable InputStream getResource(@NotNull
 @NotNull String path)

Get the resource from the addon's jar

Parameters:

path - path to resource

Returns:

the InputStream of the resource, or null if it's not found

getExpansionClassLoader

public ExpansionClassLoader getExpansionClassLoader()

Get the expansion class loader

Returns:

the class loader