com.fs.starfarer.api.campaign

Interface CustomUIPanelPlugin

All Known Implementing Classes:

BaseCustomUIPanelPlugin, CodexCustomEntryExample, DuelPanel, DuelTutorialPanel, ExampleCustomUIPanel

public interface CustomUIPanelPlugin

Method Summary

Modifier and Type	Method and Description
void	advance(float amount)
void	buttonPressed(java.lang.Object buttonId)
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.

Method Detail

positionChanged

void positionChanged(PositionAPI position)

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

Parameters:

position -

renderBelow

void renderBelow(float alphaMult)

Below any UI elements in the panel.

Parameters:

alphaMult -

render

void render(float alphaMult)

alphaMult is the transparency the panel should be rendered at.

Parameters:

alphaMult -

advance

void advance(float amount)

Parameters:

amount - in seconds.

processInput

void processInput(java.util.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 -

buttonPressed

void buttonPressed(java.lang.Object buttonId)