Package org.cyclops.cyclopscore.infobook

Interface IInfoBookRegistry

All Superinterfaces:

org.cyclops.cyclopscore.init.IRegistry

All Known Implementing Classes:

InfoBookRegistry

public interface IInfoBookRegistry
extends org.cyclops.cyclopscore.init.IRegistry

Registry for in-game manuals.

Method Summary

Modifier and Type	Method	Description
InfoSection	getRoot(IInfoBook infoBook)	Get the root of the given book.
void	registerInfoBook(IInfoBook infoBook, String path)	Register a new infobook.
void	registerSection(ModBase<?> mod, IInfoBook infoBook, String parentSection, String sectionPath)	Register a new section to the given section of the given infobook.

Method Details

registerInfoBook

void registerInfoBook(IInfoBook infoBook,
 String path)

Register a new infobook.

Parameters:

infoBook - The infobook to register.

path - The path to the xml file of the book.

registerSection

void registerSection(ModBase<?> mod,
 IInfoBook infoBook,
 String parentSection,
 String sectionPath)

Register a new section to the given section of the given infobook.

Parameters:

mod - The mod owning the section.

infoBook - The infobook to register to.

parentSection - The section to register this new section to.

sectionPath - The path to the xml file of the section to register.

getRoot

InfoSection getRoot(IInfoBook infoBook)

Get the root of the given book.

Parameters:

infoBook - The info book to get the root from.

Returns:

The root section.