IInfoBook (CyclopsCore 1.19.0-421 API)

All Known Implementing Classes:: InfoBook, InfoBookTest

public interface IInfoBook

Instances of this can be used with the InfoBookRegistry to create in-game manuals.

Method Summary

Modifier and Type

Method

Description

void

addSection(String sectionName, InfoSection section)

String

getBaseUrl()

Map<String,org.apache.commons.lang3.tuple.Pair<InfoSection,Integer>>

getConfigLinks()

int

getCurrentPage()

InfoSection

getCurrentSection()

EvictingStack<InfoSection.Location>

getHistory()

ModBase<?>

getMod()

int

getPagesPerView()

InfoSection

getSection(String sectionName)

InfoSectionTagIndex

getTagIndex()

void

putIndex(InfoSectionTagIndex tagIndex)

void

setConfigLinks(Map<String,org.apache.commons.lang3.tuple.Pair<InfoSection,Integer>> configLinks)

void

setCurrentPage(int page)

void

setCurrentSection(InfoSection section)

Method Details
- getMod
  
  ModBase<?> getMod()
- getPagesPerView
  
  int getPagesPerView()
- getBaseUrl
  
  String getBaseUrl()
- setCurrentPage
  
  void setCurrentPage(int page)
- setCurrentSection
  
  void setCurrentSection(InfoSection section)
- getCurrentPage
  
  int getCurrentPage()
- getCurrentSection
  
  InfoSection getCurrentSection()
- addSection
  
  void addSection(String sectionName, InfoSection section)
- getSection
  
  InfoSection getSection(String sectionName)
- getConfigLinks
  
  Map<String,org.apache.commons.lang3.tuple.Pair<InfoSection,Integer>> getConfigLinks()
- setConfigLinks
  
  void setConfigLinks(Map<String,org.apache.commons.lang3.tuple.Pair<InfoSection,Integer>> configLinks)
- getTagIndex
  
  InfoSectionTagIndex getTagIndex()
- putIndex
  
  void putIndex(InfoSectionTagIndex tagIndex)
- getHistory
  
  EvictingStack<InfoSection.Location> getHistory()