org.lazywizard.radar.renderers.campaign

Class RadarBoxRenderer

java.lang.Object

org.lazywizard.radar.renderers.campaign.RadarBoxRenderer

All Implemented Interfaces:

BaseRenderer<com.fs.starfarer.api.campaign.SectorEntityToken,com.fs.starfarer.api.campaign.CampaignFleetAPI>, CampaignRenderer

public class RadarBoxRenderer
extends java.lang.Object
implements CampaignRenderer

Constructor Summary

Constructors

Constructor and Description
RadarBoxRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
void	init(CommonRadar<com.fs.starfarer.api.campaign.SectorEntityToken> radar) Called on the first frame before rendering begins.
void	reloadSettings(org.json.JSONObject settings) Called when the game first loads or when RadarModPlugin#reloadSettings() is called.
void	render(com.fs.starfarer.api.campaign.CampaignFleetAPI player, float amount, boolean isUpdateFrame) Called every frame to tell your component to render.

Methods inherited from class java.lang.Object

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

Constructor Detail

RadarBoxRenderer

public RadarBoxRenderer()

Method Detail

reloadSettings

public void reloadSettings(org.json.JSONObject settings)
                    throws org.json.JSONException

Description copied from interface: BaseRenderer

Called when the game first loads or when RadarModPlugin#reloadSettings() is called. You should set up static variables such as colors here.

IMPORTANT: this method is called on a temporary object during loading. Any variables you set in here must be static or they won't be retained!

Specified by:

reloadSettings in interface BaseRenderer<com.fs.starfarer.api.campaign.SectorEntityToken,com.fs.starfarer.api.campaign.CampaignFleetAPI>

Parameters:

settings - The contents of the settings file linked to in the radar plugin CSV.

Throws:

org.json.JSONException

init

public void init(CommonRadar<com.fs.starfarer.api.campaign.SectorEntityToken> radar)

Description copied from interface: BaseRenderer

Called on the first frame before rendering begins. You should set up your renderer here.

Specified by:

init in interface BaseRenderer<com.fs.starfarer.api.campaign.SectorEntityToken,com.fs.starfarer.api.campaign.CampaignFleetAPI>

Parameters:

radar - The master radar object; you should keep track of this as many of its properties can change.

render

public void render(com.fs.starfarer.api.campaign.CampaignFleetAPI player,
          float amount,
          boolean isUpdateFrame)

Description copied from interface: BaseRenderer

Called every frame to tell your component to render. Rendering is done using screen coordinates. If your code calls glOrtho() or glViewport(), you should call CommonRadar.resetView() at the end of this method.

Specified by:

render in interface BaseRenderer<com.fs.starfarer.api.campaign.SectorEntityToken,com.fs.starfarer.api.campaign.CampaignFleetAPI>

Parameters:

player - The player's object; also the center of the radar. Will never be null.

amount - How long since the last frame, useful for animated radar elements.

isUpdateFrame - Whether the radar should update components this frame, used so the radar can run at a lower framerate than Starsector.