com.fs.starfarer.api.impl.codex

Interface CodexEntryPlugin

All Known Implementing Classes:

CodexCustomEntryExample, CodexEntryV2, CodexTextEntryLoader.TextEntry

public interface CodexEntryPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CodexEntryPlugin.ListMode

Method Summary

Modifier and Type	Method and Description
void	addChild(CodexEntryPlugin entry)
void	addRelatedEntry(CodexEntryPlugin entry)
void	addRelatedEntry(java.lang.String id)
void	addTag(java.lang.String tag) These tags are completely unrelated to the matchesTags() method; these are not player-facing at all.
boolean	checkTagsWhenLocked()
void	configureTagDisplay(TagDisplayAPI tags)
void	createCustomDetail(CustomPanelAPI panel, UIPanelAPI relatedEntries, CodexDialogAPI codex)
void	createTitleForList(TooltipMakerAPI info, float width, CodexEntryPlugin.ListMode mode)
void	destroyCustomDetail()
float	getCategorySortTierForRelatedEntries() Checked for the *parent* of the related entry.
java.util.List<CodexEntryPlugin>	getChildren()
java.util.List<CodexEntryPlugin>	getChildrenRecursive(boolean includeCategories)
CustomUIPanelPlugin	getCustomPanelPlugin() Optional, can be null.
java.lang.String	getIcon()
default java.awt.Color	getIconColor()
java.lang.String	getId()
java.lang.Object	getParam()
java.lang.Object	getParam2()
CodexEntryPlugin	getParent()
java.util.Set<CodexEntryPlugin>	getRelatedEntries()
java.util.Set<java.lang.String>	getRelatedEntryIds()
java.lang.String	getSearchString()
java.lang.String	getSortTitle()
ModSpecAPI	getSourceMod()
java.util.Set<java.lang.String>	getTags() These tags are completely unrelated to the matchesTags() method; these are not player-facing at all.
java.lang.String	getTitle()
boolean	hasCustomDetailPanel()
boolean	hasDetail()
boolean	hasTag(java.lang.String tag) These tags are completely unrelated to the matchesTags() method; these are not player-facing at all.
boolean	hasTagDisplay()
boolean	isCategory()
boolean	isLocked()
boolean	isRetainOrderOfChildren()
boolean	isRetainOrderOfRelatedEntries()
boolean	isVignetteIcon()
boolean	isVisible()
boolean	matchesTags(java.util.Set<java.lang.String> tags)
void	removeRelatedEntry(CodexEntryPlugin entry)
void	removeRelatedEntry(java.lang.String id)
void	setCategorySortTierForRelatedEntries(float categorySortTierForRelatedEntries)
void	setIcon(java.lang.String icon)
void	setParent(CodexEntryPlugin parent)
void	setRetainOrderOfChildren(boolean retainOrderOfChildren)
void	setRetainOrderOfRelatedEntries(boolean retainOrderOfRelatedEntries)
boolean	skipForTags()

Method Detail

createTitleForList

void createTitleForList(TooltipMakerAPI info,
                        float width,
                        CodexEntryPlugin.ListMode mode)

getId

java.lang.String getId()

getTitle

java.lang.String getTitle()

getSortTitle

java.lang.String getSortTitle()

getSearchString

java.lang.String getSearchString()

getIcon

java.lang.String getIcon()

isVignetteIcon

boolean isVignetteIcon()

getIconColor

default java.awt.Color getIconColor()

getParent

CodexEntryPlugin getParent()

setParent

void setParent(CodexEntryPlugin parent)

isRetainOrderOfChildren

boolean isRetainOrderOfChildren()

setRetainOrderOfChildren

void setRetainOrderOfChildren(boolean retainOrderOfChildren)

getChildren

java.util.List<CodexEntryPlugin> getChildren()

addChild

void addChild(CodexEntryPlugin entry)

isCategory

boolean isCategory()

hasDetail

boolean hasDetail()

isVisible

boolean isVisible()

getParam

java.lang.Object getParam()

getParam2

java.lang.Object getParam2()

isLocked

boolean isLocked()

matchesTags

boolean matchesTags(java.util.Set<java.lang.String> tags)

hasTagDisplay

boolean hasTagDisplay()

configureTagDisplay

void configureTagDisplay(TagDisplayAPI tags)

getRelatedEntries

java.util.Set<CodexEntryPlugin> getRelatedEntries()

addRelatedEntry

void addRelatedEntry(CodexEntryPlugin entry)

addRelatedEntry

void addRelatedEntry(java.lang.String id)

removeRelatedEntry

void removeRelatedEntry(CodexEntryPlugin entry)

removeRelatedEntry

void removeRelatedEntry(java.lang.String id)

isRetainOrderOfRelatedEntries

boolean isRetainOrderOfRelatedEntries()

setRetainOrderOfRelatedEntries

void setRetainOrderOfRelatedEntries(boolean retainOrderOfRelatedEntries)

getCategorySortTierForRelatedEntries

float getCategorySortTierForRelatedEntries()

Checked for the *parent* of the related entry.

Returns:

setCategorySortTierForRelatedEntries

void setCategorySortTierForRelatedEntries(float categorySortTierForRelatedEntries)

getChildrenRecursive

java.util.List<CodexEntryPlugin> getChildrenRecursive(boolean includeCategories)

hasCustomDetailPanel

boolean hasCustomDetailPanel()

getCustomPanelPlugin

CustomUIPanelPlugin getCustomPanelPlugin()

Optional, can be null.

Returns:

createCustomDetail

void createCustomDetail(CustomPanelAPI panel,
                        UIPanelAPI relatedEntries,
                        CodexDialogAPI codex)

destroyCustomDetail

void destroyCustomDetail()

getRelatedEntryIds

java.util.Set<java.lang.String> getRelatedEntryIds()

skipForTags

boolean skipForTags()

getTags

java.util.Set<java.lang.String> getTags()

These tags are completely unrelated to the matchesTags() method; these are not player-facing at all.

Returns:

addTag

void addTag(java.lang.String tag)

These tags are completely unrelated to the matchesTags() method; these are not player-facing at all.

hasTag

boolean hasTag(java.lang.String tag)

These tags are completely unrelated to the matchesTags() method; these are not player-facing at all.

Returns:

setIcon

void setIcon(java.lang.String icon)

checkTagsWhenLocked

boolean checkTagsWhenLocked()

getSourceMod

ModSpecAPI getSourceMod()