li.cil.manual.api.manual

Interface PathProvider

public interface PathProvider

Allows providing paths for item stacks and blocks in the world.

This is used for generating NEI usage pages with a button opening the manual on the page at the specified path, or for opening the manual when held in hand and sneak-activating a block in the world.

This way you can easily make entries in your documentation available the same way RTFM does it itself.

Note that you can use the special variable %LANGUAGE% in your paths, for language agnostic paths. These will be resolved to the currently set language, falling back to en_US, during actual content lookup.

Method Summary

Modifier and Type	Method and Description
java.lang.String	pathFor(net.minecraft.item.ItemStack stack) Get the path to the documentation page for the provided item stack.
java.lang.String	pathFor(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Get the path to the documentation page for the provided block.

Method Detail

pathFor

@Nullable
java.lang.String pathFor(net.minecraft.item.ItemStack stack)

Get the path to the documentation page for the provided item stack.

Return null if there is no known page for this item, allowing other providers to be queried.

Parameters:

stack - the stack to get the documentation path to.

Returns:

the path to the page, null if none is known.

pathFor

@Nullable
java.lang.String pathFor(net.minecraft.world.World world,
                                   net.minecraft.util.math.BlockPos pos)

Get the path to the documentation page for the provided block.

Return null if there is no known page for this item, allowing other providers to be queried.

Parameters:

world - the world containing the block.

pos - the position coordinate of the block.

Returns:

the path to the page, null if none is known.