nova.core.loader

Annotation Type Mod

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Mod

An annotation placed on the NOVA mod's main loading class.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	id The unique mod identifier for this mod
java.lang.String	name The user friendly name for the mod
java.lang.String	novaVersion The version of Nova this mod is compatible with
java.lang.String	version The version identifier of this mod

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	dependencies An array of the dependencies for this mod.
java.lang.String	description A simple description of the mod.
java.lang.String[]	domains The domains used by the mod for its assets.
java.lang.Class<? extends se.jbee.inject.bootstrap.Bundle>[]	modules Modules of Dependency Injection that will be added to core injector allowing provision of modules by mods.
int	priority This method is used by APIs to allow them to load before most mods load.

Element Detail

id

public abstract java.lang.String id

The unique mod identifier for this mod

Returns:

Mod ID

name

public abstract java.lang.String name

The user friendly name for the mod

Returns:

Mod name

version

public abstract java.lang.String version

The version identifier of this mod

Returns:

Mod Version

novaVersion

public abstract java.lang.String novaVersion

The version of Nova this mod is compatible with

Returns:

Nova version

description

public abstract java.lang.String description

A simple description of the mod.

Returns:

Mod description

Default:

""

domains

public abstract java.lang.String[] domains

The domains used by the mod for its assets. These domain names are used to load the assets from file. The assets should be placed in assets/domain/*

Returns:

An array of domain names.

Default:

{}

dependencies

public abstract java.lang.String[] dependencies

An array of the dependencies for this mod. The mod will load after all the dependencies are loaded. String format: "x" is the version wildcard. Adding "f" after the version will force the dependency to be a requirement. E.g: BuildCraft@6.1.x?

Returns:

The dependencies

Default:

{}

modules

public abstract java.lang.Class<? extends se.jbee.inject.bootstrap.Bundle>[] modules

Modules of Dependency Injection that will be added to core injector allowing provision of modules by mods.

Returns:

The modules

Default:

{}

priority

public abstract int priority

This method is used by APIs to allow them to load before most mods load.

Returns:

The priority for the plugin to load. The higher the number, the higher the load priority.

Default:

0