com.fs.starfarer.api.impl.codex

Class CodexEntryV2

java.lang.Object

com.fs.starfarer.api.impl.codex.CodexEntryV2

All Implemented Interfaces:

CodexEntryPlugin

Direct Known Subclasses:

CodexCustomEntryExample, CodexTextEntryLoader.TextEntry

public class CodexEntryV2
extends java.lang.Object
implements CodexEntryPlugin

Nested Class Summary

Nested classes/interfaces inherited from interface com.fs.starfarer.api.impl.codex.CodexEntryPlugin

CodexEntryPlugin.ListMode

Field Summary

Fields

Modifier and Type	Field and Description
protected float	categorySortTierForRelatedEntries
protected boolean	checking
protected java.util.List<CodexEntryPlugin>	children
protected java.lang.String	icon
protected java.lang.String	id
protected java.lang.Object	param
protected java.lang.Object	param2
protected CodexEntryPlugin	parent
protected java.util.Set<java.lang.String>	related
protected boolean	retainOrderOfChildren
protected boolean	retainOrderOfRelatedEntries
protected java.util.Set<java.lang.String>	tags
protected java.lang.String	title

Constructor Summary

Constructors

Constructor and Description
CodexEntryV2(java.lang.String id, java.lang.String title, java.lang.String icon)
CodexEntryV2(java.lang.String id, java.lang.String title, java.lang.String icon, java.lang.Object param)

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	areAnyRelatedEntriesUnlocked()
boolean	areAnyRelatedEntriesVisible()
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()
void	findChildren(CodexEntryPlugin curr, java.util.List<CodexEntryPlugin> result, boolean includeCategories)
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()
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()
java.util.Set<java.lang.String>	getUnlockRelatedTags()
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	isLockedStandard(java.util.Set<java.lang.String> tags, boolean thingUnlocked)
boolean	isRetainOrderOfChildren()
boolean	isRetainOrderOfRelatedEntries()
boolean	isUnlockedIfRequiresUnlock()
boolean	isVignetteIcon()
boolean	isVisible()
boolean	isVisibleStandard(java.util.Set<java.lang.String> tags, boolean thingUnlocked)
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	setParam(java.lang.Object param)
void	setParam2(java.lang.Object param2)
void	setParent(CodexEntryPlugin parent)
void	setRetainOrderOfChildren(boolean retainOrderOfChildren)
void	setRetainOrderOfRelatedEntries(boolean retainOrderOfRelatedEntries)
boolean	skipForTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.fs.starfarer.api.impl.codex.CodexEntryPlugin

getIconColor

Field Detail

id

protected java.lang.String id

title

protected java.lang.String title

icon

protected java.lang.String icon

parent

protected CodexEntryPlugin parent

param

protected java.lang.Object param

param2

protected java.lang.Object param2

children

protected java.util.List<CodexEntryPlugin> children

related

protected java.util.Set<java.lang.String> related

retainOrderOfChildren

protected boolean retainOrderOfChildren

retainOrderOfRelatedEntries

protected boolean retainOrderOfRelatedEntries

categorySortTierForRelatedEntries

protected float categorySortTierForRelatedEntries

tags

protected java.util.Set<java.lang.String> tags

checking

protected boolean checking

Constructor Detail

CodexEntryV2

public CodexEntryV2(java.lang.String id,
                    java.lang.String title,
                    java.lang.String icon)

CodexEntryV2

public CodexEntryV2(java.lang.String id,
                    java.lang.String title,
                    java.lang.String icon,
                    java.lang.Object param)

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface CodexEntryPlugin

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in interface CodexEntryPlugin

getSortTitle

public java.lang.String getSortTitle()

Specified by:

getSortTitle in interface CodexEntryPlugin

getSearchString

public java.lang.String getSearchString()

Specified by:

getSearchString in interface CodexEntryPlugin

getIcon

public java.lang.String getIcon()

Specified by:

getIcon in interface CodexEntryPlugin

setIcon

public void setIcon(java.lang.String icon)

Specified by:

setIcon in interface CodexEntryPlugin

getParent

public CodexEntryPlugin getParent()

Specified by:

getParent in interface CodexEntryPlugin

setParent

public void setParent(CodexEntryPlugin parent)

Specified by:

setParent in interface CodexEntryPlugin

getParam

public java.lang.Object getParam()

Specified by:

getParam in interface CodexEntryPlugin

setParam

public void setParam(java.lang.Object param)

getChildren

public java.util.List<CodexEntryPlugin> getChildren()

Specified by:

getChildren in interface CodexEntryPlugin

addChild

public void addChild(CodexEntryPlugin entry)

Specified by:

addChild in interface CodexEntryPlugin

isRetainOrderOfChildren

public boolean isRetainOrderOfChildren()

Specified by:

isRetainOrderOfChildren in interface CodexEntryPlugin

setRetainOrderOfChildren

public void setRetainOrderOfChildren(boolean retainOrderOfChildren)

Specified by:

setRetainOrderOfChildren in interface CodexEntryPlugin

isCategory

public boolean isCategory()

Specified by:

isCategory in interface CodexEntryPlugin

createTitleForList

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

Specified by:

createTitleForList in interface CodexEntryPlugin

hasDetail

public boolean hasDetail()

Specified by:

hasDetail in interface CodexEntryPlugin

matchesTags

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

Specified by:

matchesTags in interface CodexEntryPlugin

hasTagDisplay

public boolean hasTagDisplay()

Specified by:

hasTagDisplay in interface CodexEntryPlugin

configureTagDisplay

public void configureTagDisplay(TagDisplayAPI tags)

Specified by:

configureTagDisplay in interface CodexEntryPlugin

getRelatedEntryIds

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

Specified by:

getRelatedEntryIds in interface CodexEntryPlugin

getRelatedEntries

public java.util.Set<CodexEntryPlugin> getRelatedEntries()

Specified by:

getRelatedEntries in interface CodexEntryPlugin

addRelatedEntry

public void addRelatedEntry(CodexEntryPlugin entry)

Specified by:

addRelatedEntry in interface CodexEntryPlugin

addRelatedEntry

public void addRelatedEntry(java.lang.String id)

Specified by:

addRelatedEntry in interface CodexEntryPlugin

removeRelatedEntry

public void removeRelatedEntry(CodexEntryPlugin entry)

Specified by:

removeRelatedEntry in interface CodexEntryPlugin

removeRelatedEntry

public void removeRelatedEntry(java.lang.String id)

Specified by:

removeRelatedEntry in interface CodexEntryPlugin

isRetainOrderOfRelatedEntries

public boolean isRetainOrderOfRelatedEntries()

Specified by:

isRetainOrderOfRelatedEntries in interface CodexEntryPlugin

setRetainOrderOfRelatedEntries

public void setRetainOrderOfRelatedEntries(boolean retainOrderOfRelatedEntries)

Specified by:

setRetainOrderOfRelatedEntries in interface CodexEntryPlugin

getCategorySortTierForRelatedEntries

public float getCategorySortTierForRelatedEntries()

Description copied from interface: CodexEntryPlugin

Checked for the *parent* of the related entry.

Specified by:

getCategorySortTierForRelatedEntries in interface CodexEntryPlugin

Returns:

setCategorySortTierForRelatedEntries

public void setCategorySortTierForRelatedEntries(float categorySortTierForRelatedEntries)

Specified by:

setCategorySortTierForRelatedEntries in interface CodexEntryPlugin

getChildrenRecursive

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

Specified by:

getChildrenRecursive in interface CodexEntryPlugin

findChildren

public void findChildren(CodexEntryPlugin curr,
                         java.util.List<CodexEntryPlugin> result,
                         boolean includeCategories)

hasCustomDetailPanel

public boolean hasCustomDetailPanel()

Specified by:

hasCustomDetailPanel in interface CodexEntryPlugin

getCustomPanelPlugin

public CustomUIPanelPlugin getCustomPanelPlugin()

Description copied from interface: CodexEntryPlugin

Optional, can be null.

Specified by:

getCustomPanelPlugin in interface CodexEntryPlugin

Returns:

createCustomDetail

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

Specified by:

createCustomDetail in interface CodexEntryPlugin

destroyCustomDetail

public void destroyCustomDetail()

Specified by:

destroyCustomDetail in interface CodexEntryPlugin

isVignetteIcon

public boolean isVignetteIcon()

Specified by:

isVignetteIcon in interface CodexEntryPlugin

areAnyRelatedEntriesVisible

public boolean areAnyRelatedEntriesVisible()

areAnyRelatedEntriesUnlocked

public boolean areAnyRelatedEntriesUnlocked()

isVisible

public boolean isVisible()

Specified by:

isVisible in interface CodexEntryPlugin

isLocked

public boolean isLocked()

Specified by:

isLocked in interface CodexEntryPlugin

checkTagsWhenLocked

public boolean checkTagsWhenLocked()

Specified by:

checkTagsWhenLocked in interface CodexEntryPlugin

getUnlockRelatedTags

public java.util.Set<java.lang.String> getUnlockRelatedTags()

isUnlockedIfRequiresUnlock

public boolean isUnlockedIfRequiresUnlock()

isVisibleStandard

public boolean isVisibleStandard(java.util.Set<java.lang.String> tags,
                                 boolean thingUnlocked)

isLockedStandard

public boolean isLockedStandard(java.util.Set<java.lang.String> tags,
                                boolean thingUnlocked)

getParam2

public java.lang.Object getParam2()

Specified by:

getParam2 in interface CodexEntryPlugin

setParam2

public void setParam2(java.lang.Object param2)

skipForTags

public boolean skipForTags()

Specified by:

skipForTags in interface CodexEntryPlugin

getTags

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

Description copied from interface: CodexEntryPlugin

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

Specified by:

getTags in interface CodexEntryPlugin

Returns:

addTag

public void addTag(java.lang.String tag)

Description copied from interface: CodexEntryPlugin

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

Specified by:

addTag in interface CodexEntryPlugin

hasTag

public boolean hasTag(java.lang.String tag)

Description copied from interface: CodexEntryPlugin

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

Specified by:

hasTag in interface CodexEntryPlugin

Returns:

getSourceMod

public ModSpecAPI getSourceMod()

Specified by:

getSourceMod in interface CodexEntryPlugin