com.fs.starfarer.api.campaign

Class BaseCustomUIPanelPlugin

java.lang.Object

com.fs.starfarer.api.campaign.BaseCustomUIPanelPlugin

All Implemented Interfaces:

CustomUIPanelPlugin

Direct Known Subclasses:

DuelPanel, DuelTutorialPanel, ExampleCustomUIPanel

public class BaseCustomUIPanelPlugin
extends java.lang.Object
implements CustomUIPanelPlugin

Constructor Summary

Constructors

Constructor and Description
BaseCustomUIPanelPlugin()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseCustomUIPanelPlugin

public BaseCustomUIPanelPlugin()

Method Detail

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