com.fs.starfarer.api.impl.codex

Class CodexCustomEntryExample

java.lang.Object

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

com.fs.starfarer.api.impl.codex.CodexCustomEntryExample

All Implemented Interfaces:

CustomUIPanelPlugin, CodexEntryPlugin

public class CodexCustomEntryExample
extends CodexEntryV2
implements CustomUIPanelPlugin

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 UIPanelAPI	box
protected CodexDialogAPI	codex
protected CustomPanelAPI	panel
protected UIPanelAPI	relatedEntries

Fields inherited from class com.fs.starfarer.api.impl.codex.CodexEntryV2

categorySortTierForRelatedEntries, checking, children, icon, id, param, param2, parent, related, retainOrderOfChildren, retainOrderOfRelatedEntries, tags, title

Constructor Summary

Constructors

Constructor and Description
CodexCustomEntryExample(java.lang.String id, java.lang.String title, java.lang.String icon)

Method Summary

Modifier and Type	Method and Description
void	advance(float amount)
void	buttonPressed(java.lang.Object buttonId)
void	createCustomDetail(CustomPanelAPI panel, UIPanelAPI relatedEntries, CodexDialogAPI codex)
void	createTitleForList(TooltipMakerAPI info, float width, CodexEntryPlugin.ListMode mode)
void	destroyCustomDetail()
CustomUIPanelPlugin	getCustomPanelPlugin() Optional, can be null.
boolean	hasCustomDetailPanel()
void	positionChanged(PositionAPI position) Called whenever the location or size of this UI panel changes.
void	processInput(java.util.List<InputEventAPI> events) List of input events that occurred this frame.
void	render(float alphaMult) alphaMult is the transparency the panel should be rendered at.
void	renderBelow(float alphaMult) Below any UI elements in the panel.

Methods inherited from class com.fs.starfarer.api.impl.codex.CodexEntryV2

addChild, addRelatedEntry, addRelatedEntry, addTag, areAnyRelatedEntriesUnlocked, areAnyRelatedEntriesVisible, checkTagsWhenLocked, configureTagDisplay, findChildren, getCategorySortTierForRelatedEntries, getChildren, getChildrenRecursive, getIcon, getId, getParam, getParam2, getParent, getRelatedEntries, getRelatedEntryIds, getSearchString, getSortTitle, getSourceMod, getTags, getTitle, getUnlockRelatedTags, hasDetail, hasTag, hasTagDisplay, isCategory, isLocked, isLockedStandard, isRetainOrderOfChildren, isRetainOrderOfRelatedEntries, isUnlockedIfRequiresUnlock, isVignetteIcon, isVisible, isVisibleStandard, matchesTags, removeRelatedEntry, removeRelatedEntry, setCategorySortTierForRelatedEntries, setIcon, setParam, setParam2, setParent, setRetainOrderOfChildren, setRetainOrderOfRelatedEntries, 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

panel

protected CustomPanelAPI panel

relatedEntries

protected UIPanelAPI relatedEntries

box

protected UIPanelAPI box

codex

protected CodexDialogAPI codex

Constructor Detail

CodexCustomEntryExample

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

Method Detail

createTitleForList

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

Specified by:

createTitleForList in interface CodexEntryPlugin

Overrides:

createTitleForList in class CodexEntryV2

hasCustomDetailPanel

public boolean hasCustomDetailPanel()

Specified by:

hasCustomDetailPanel in interface CodexEntryPlugin

Overrides:

hasCustomDetailPanel in class CodexEntryV2

getCustomPanelPlugin

public CustomUIPanelPlugin getCustomPanelPlugin()

Description copied from interface: CodexEntryPlugin

Optional, can be null.

Specified by:

getCustomPanelPlugin in interface CodexEntryPlugin

Overrides:

getCustomPanelPlugin in class CodexEntryV2

Returns:

destroyCustomDetail

public void destroyCustomDetail()

Specified by:

destroyCustomDetail in interface CodexEntryPlugin

Overrides:

destroyCustomDetail in class CodexEntryV2

createCustomDetail

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

Specified by:

createCustomDetail in interface CodexEntryPlugin

Overrides:

createCustomDetail in class CodexEntryV2

positionChanged

public void positionChanged(PositionAPI position)

Description copied from interface: CustomUIPanelPlugin

Called whenever the location or size of this UI panel changes.

Specified by:

positionChanged in interface CustomUIPanelPlugin

renderBelow

public void renderBelow(float alphaMult)

Description copied from interface: CustomUIPanelPlugin

Below any UI elements in the panel.

Specified by:

renderBelow in interface CustomUIPanelPlugin

render

public void render(float alphaMult)

Description copied from interface: CustomUIPanelPlugin

alphaMult is the transparency the panel should be rendered at.

Specified by:

render in interface CustomUIPanelPlugin

advance

public void advance(float amount)

Specified by:

advance in interface CustomUIPanelPlugin

Parameters:

amount - in seconds.

processInput

public void processInput(java.util.List<InputEventAPI> events)

Description copied from interface: CustomUIPanelPlugin

List of input events that occurred this frame. (Almost) always includes one mouse move event. Events should be consume()d if they are acted on. Mouse-move events should generally not be consumed. The loop processing events should check to see if an event has already been consumed, and if so, skip it. Accessing the data of a consumed event will throw an exception.

Specified by:

processInput in interface CustomUIPanelPlugin

buttonPressed

public void buttonPressed(java.lang.Object buttonId)

Specified by:

buttonPressed in interface CustomUIPanelPlugin