PluginManifest

public class PluginManifest

Represents the plugin manifest containing metadata including plugin identifier, version information using semantic versioning, author information, dependencies and load order, and asset pack inclusion.

java.lang.Object > PluginManifest

Field Summary

group

private String group

Field group.

name

private String name

Field name.

version

private Semver version

Field version.

description

private String description

Field description.

authors

private List authors

Field authors.

website

private String website

Field website.

main

private String main

Field main.

serverVersion

private SemverRange serverVersion

Field serverVersion.

subPlugins

private List subPlugins

Field subPlugins.

disabledByDefault

private boolean disabledByDefault

Field disabledByDefault.

includesAssetPack

private boolean includesAssetPack

Field includesAssetPack.

Method Detail

PluginManifest

public public PluginManifest ()

Method PluginManifest.

getGroup

public String getGroup ()

Method getGroup.

getName

public String getName ()

Method getName.

getVersion

public Semver getVersion ()

Method getVersion.

getDescription

public String getDescription ()

Method getDescription.

getAuthors

public List getAuthors ()

Method getAuthors.

getWebsite

public String getWebsite ()

Method getWebsite.

setGroup

public void setGroup (@Nonnull final String group)

Method setGroup.

Parameters:
@Nonnull final String group

setName

public void setName (@Nonnull final String name)

Method setName.

Parameters:
@Nonnull final String name

setVersion

public void setVersion (@Nullable final Semver version)

Method setVersion.

Parameters:
@Nullable final Semver version

setDescription

public void setDescription (@Nullable final String description)

Method setDescription.

Parameters:
@Nullable final String description

setAuthors

public void setAuthors (@Nonnull final List authors)

Method setAuthors.

Parameters:
@Nonnull final List authors

setWebsite

public void setWebsite (@Nullable final String website)

Method setWebsite.

Parameters:
@Nullable final String website

getMain

public String getMain ()

Method getMain.

getServerVersion

public SemverRange getServerVersion ()

Method getServerVersion.

getDependencies

public SemverRange> getDependencies ()

Method getDependencies.

injectDependency

public void injectDependency (final PluginIdentifier identifier, final SemverRange range)

Method injectDependency.

Parameters:
final PluginIdentifier identifier
final SemverRange range

getOptionalDependencies

public SemverRange> getOptionalDependencies ()

Method getOptionalDependencies.

getLoadBefore

public SemverRange> getLoadBefore ()

Method getLoadBefore.

isDisabledByDefault

public boolean isDisabledByDefault ()

Method isDisabledByDefault.

includesAssetPack

public boolean includesAssetPack ()

Method includesAssetPack.

getSubPlugins

public List getSubPlugins ()

Method getSubPlugins.

inherit

public void inherit (@Nonnull final PluginManifest manifest)

Method inherit.

Parameters:
@Nonnull final PluginManifest manifest

PluginIdentifier

public new PluginIdentifier (manifest)

Method PluginIdentifier.

Parameters:
manifest manifest

toString

public String toString ()

Method toString.

corePlugin

static CoreBuilder corePlugin (@Nonnull final Class pluginClass)

Method corePlugin.

Parameters:
@Nonnull final Class pluginClass

CoreBuilder

public new CoreBuilder ("Hytale", pluginClass.getSimpleName()

Method CoreBuilder.

Parameters:
"Hytale" "Hytale"
pluginClass.getSimpleName( pluginClass.getSimpleName(

description

public CoreBuilder description (@Nonnull final String description)

Method description.

Parameters:
@Nonnull final String description

depends

final CoreBuilder depends (@Nonnull final Class... dependencies)

Method depends.

Parameters:
@Nonnull final Class... dependencies

optDepends

final CoreBuilder optDepends (@Nonnull final Class... dependencies)

Method optDepends.

Parameters:
@Nonnull final Class... dependencies

loadsBefore

final CoreBuilder loadsBefore (@Nonnull final Class... plugins)

Method loadsBefore.

Parameters:
@Nonnull final Class... plugins

build

public PluginManifest build ()

Method build.

See Also: