com.fs.starfarer.api.campaign.CustomUIPanelPlugin Interface Reference

Inheritance diagram for com.fs.starfarer.api.campaign.CustomUIPanelPlugin:

Public Member Functions
void	positionChanged (PositionAPI position)
void	renderBelow (float alphaMult)
void	render (float alphaMult)
void	advance (float amount)
void	processInput (List< InputEventAPI > events)
void	buttonPressed (Object buttonId)

Detailed Description

Definition at line 8 of file CustomUIPanelPlugin.java.

Member Function Documentation

advance()

void com.fs.starfarer.api.campaign.CustomUIPanelPlugin.advance

(

float

amount

)

Parameters

amount

in seconds.

Implemented in com.fs.starfarer.api.campaign.BaseCustomUIPanelPlugin, com.fs.starfarer.api.impl.campaign.eventide.DuelPanel, com.fs.starfarer.api.impl.campaign.eventide.DuelTutorialPanel, com.fs.starfarer.api.impl.campaign.ExampleCustomUIPanel, and com.fs.starfarer.api.impl.codex.CodexCustomEntryExample.

buttonPressed()

void com.fs.starfarer.api.campaign.CustomUIPanelPlugin.buttonPressed

(

Object

buttonId

)

Implemented in com.fs.starfarer.api.campaign.BaseCustomUIPanelPlugin, com.fs.starfarer.api.impl.campaign.ExampleCustomUIPanel, and com.fs.starfarer.api.impl.codex.CodexCustomEntryExample.

positionChanged()

void com.fs.starfarer.api.campaign.CustomUIPanelPlugin.positionChanged

(

PositionAPI

position

)

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

Parameters

position

Implemented in com.fs.starfarer.api.campaign.BaseCustomUIPanelPlugin, com.fs.starfarer.api.impl.campaign.eventide.DuelPanel, com.fs.starfarer.api.impl.campaign.eventide.DuelTutorialPanel, com.fs.starfarer.api.impl.campaign.ExampleCustomUIPanel, and com.fs.starfarer.api.impl.codex.CodexCustomEntryExample.

processInput()

void com.fs.starfarer.api.campaign.CustomUIPanelPlugin.processInput

(

List< InputEventAPI >

events

)

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.

Parameters

events

Implemented in com.fs.starfarer.api.campaign.BaseCustomUIPanelPlugin, com.fs.starfarer.api.impl.campaign.eventide.DuelPanel, com.fs.starfarer.api.impl.campaign.eventide.DuelTutorialPanel, com.fs.starfarer.api.impl.campaign.ExampleCustomUIPanel, and com.fs.starfarer.api.impl.codex.CodexCustomEntryExample.

render()

void com.fs.starfarer.api.campaign.CustomUIPanelPlugin.render

(

float

alphaMult

)

alphaMult is the transparency the panel should be rendered at.

Parameters

alphaMult

Implemented in com.fs.starfarer.api.campaign.BaseCustomUIPanelPlugin, com.fs.starfarer.api.impl.campaign.eventide.DuelPanel, com.fs.starfarer.api.impl.campaign.eventide.DuelTutorialPanel, com.fs.starfarer.api.impl.campaign.ExampleCustomUIPanel, and com.fs.starfarer.api.impl.codex.CodexCustomEntryExample.

renderBelow()

void com.fs.starfarer.api.campaign.CustomUIPanelPlugin.renderBelow

(

float

alphaMult

)

Below any UI elements in the panel.

Parameters

alphaMult

Implemented in com.fs.starfarer.api.campaign.BaseCustomUIPanelPlugin, com.fs.starfarer.api.impl.campaign.eventide.DuelPanel, com.fs.starfarer.api.impl.campaign.eventide.DuelTutorialPanel, com.fs.starfarer.api.impl.campaign.ExampleCustomUIPanel, and com.fs.starfarer.api.impl.codex.CodexCustomEntryExample.

---

The documentation for this interface was generated from the following file:

• src/com/fs/starfarer/api/campaign/CustomUIPanelPlugin.java