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) |
 Public Member Functions inherited from com.fs.starfarer.api.campaign.CustomUIPanelPlugin | |
Detailed Description
Definition at line 8 of file BaseCustomUIPanelPlugin.java.
Member Function Documentation
◆ advance()
| void com.fs.starfarer.api.campaign.BaseCustomUIPanelPlugin.advance | ( | float | amount | ) |
- Parameters
-
amount in seconds.
Implements com.fs.starfarer.api.campaign.CustomUIPanelPlugin.
Reimplemented in com.fs.starfarer.api.impl.campaign.eventide.DuelPanel, com.fs.starfarer.api.impl.campaign.eventide.DuelTutorialPanel, and com.fs.starfarer.api.impl.campaign.ExampleCustomUIPanel.
Definition at line 22 of file BaseCustomUIPanelPlugin.java.
◆ buttonPressed()
| void com.fs.starfarer.api.campaign.BaseCustomUIPanelPlugin.buttonPressed | ( | Object | buttonId | ) |
Implements com.fs.starfarer.api.campaign.CustomUIPanelPlugin.
Reimplemented in com.fs.starfarer.api.impl.campaign.ExampleCustomUIPanel.
Definition at line 30 of file BaseCustomUIPanelPlugin.java.
◆ positionChanged()
| void com.fs.starfarer.api.campaign.BaseCustomUIPanelPlugin.positionChanged | ( | PositionAPI | position | ) |
Called whenever the location or size of this UI panel changes.
- Parameters
-
position
Implements com.fs.starfarer.api.campaign.CustomUIPanelPlugin.
Reimplemented in com.fs.starfarer.api.impl.campaign.eventide.DuelPanel, com.fs.starfarer.api.impl.campaign.eventide.DuelTutorialPanel, and com.fs.starfarer.api.impl.campaign.ExampleCustomUIPanel.
Definition at line 10 of file BaseCustomUIPanelPlugin.java.
◆ processInput()
| void com.fs.starfarer.api.campaign.BaseCustomUIPanelPlugin.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
Implements com.fs.starfarer.api.campaign.CustomUIPanelPlugin.
Reimplemented in com.fs.starfarer.api.impl.campaign.eventide.DuelPanel, com.fs.starfarer.api.impl.campaign.eventide.DuelTutorialPanel, and com.fs.starfarer.api.impl.campaign.ExampleCustomUIPanel.
Definition at line 26 of file BaseCustomUIPanelPlugin.java.
◆ render()
| void com.fs.starfarer.api.campaign.BaseCustomUIPanelPlugin.render | ( | float | alphaMult | ) |
alphaMult is the transparency the panel should be rendered at.
- Parameters
-
alphaMult
Implements com.fs.starfarer.api.campaign.CustomUIPanelPlugin.
Reimplemented in com.fs.starfarer.api.impl.campaign.eventide.DuelPanel, com.fs.starfarer.api.impl.campaign.eventide.DuelTutorialPanel, and com.fs.starfarer.api.impl.campaign.ExampleCustomUIPanel.
Definition at line 18 of file BaseCustomUIPanelPlugin.java.
◆ renderBelow()
| void com.fs.starfarer.api.campaign.BaseCustomUIPanelPlugin.renderBelow | ( | float | alphaMult | ) |
Below any UI elements in the panel.
- Parameters
-
alphaMult
Implements com.fs.starfarer.api.campaign.CustomUIPanelPlugin.
Reimplemented in com.fs.starfarer.api.impl.campaign.eventide.DuelPanel, com.fs.starfarer.api.impl.campaign.eventide.DuelTutorialPanel, and com.fs.starfarer.api.impl.campaign.ExampleCustomUIPanel.
Definition at line 14 of file BaseCustomUIPanelPlugin.java.
The documentation for this class was generated from the following file:
- src/com/fs/starfarer/api/campaign/BaseCustomUIPanelPlugin.java
