public class RadarSettings
extends java.lang.Object
data/config/radar/
.Modifier and Type | Method and Description |
---|---|
static java.awt.Color |
getAlliedContactColor()
Returns the color that allied radar contacts should be drawn with.
|
static java.util.List<java.lang.Class<? extends CampaignRenderer>> |
getCampaignRendererClasses()
Returns the list of renderers used on the campaign map.
|
static java.util.List<java.lang.Class<? extends CombatRenderer>> |
getCombatRendererClasses()
Returns the list of renderers used in combat.
|
static java.awt.Color |
getEnemyContactColor()
Returns the color that hostile radar contacts should be drawn with.
|
static java.awt.Color |
getFriendlyContactColor()
Returns the color that friendly radar contacts should be drawn with.
|
static float |
getMaxCampaignSightRange()
Returns the maximum campaign radar range.
|
static float |
getMaxCombatSightRange()
Returns the maximum combat radar range.
|
static java.awt.Color |
getNeutralContactColor()
Returns the color that neutral radar contacts should be drawn with.
|
static int |
getNumZoomLevels()
Returns how many zoom levels the radar supports.
|
static float |
getRadarContactAlpha()
Returns the alpha modifier for all radar contacts.
|
static float |
getRadarRenderRadius()
Returns the radius of the rendered radar circle, in pixels.
|
static int |
getRadarToggleKey()
Returns the LWJGL keyboard constant for the radar toggle key.
|
static float |
getRadarUIAlpha()
Returns the alpha modifier for all radar user interface elements.
|
static float |
getTimeBetweenUpdateFrames()
Returns how long there is between each radar update frame.
|
static int |
getVerticesPerCircle()
Returns how many vertices the radar should use when creating circles.
|
static float |
getZoomAnimationDuration()
Returns how long it takes for the radar to animate switching zoom levels.
|
static int |
getZoomInKey()
Returns the LWJGL keyboard constant for the radar zoom in key.
|
static int |
getZoomOutKey()
Returns the LWJGL keyboard constant for the radar zoom out key.
|
static boolean |
isFilteredOut(com.fs.starfarer.api.combat.CombatEntityAPI entity)
Checks if a combat object should be drawn on the combat radar or not.
|
static boolean |
isFilteredOut(com.fs.starfarer.api.campaign.SectorEntityToken token)
Checks if a campaign object should be drawn on the campaign radar or not.
|
static boolean |
isRespectingFogOfWar()
Returns whether the radar will ignore contacts that the player can't
currently see.
|
static void |
reloadSettings()
Reloads all radar settings from the config file.
|
static boolean |
usesVertexBufferObjects()
Returns whether the radar will use vertex buffer objects (VBOs) when
rendering.
|
public static void reloadSettings() throws org.json.JSONException, java.io.IOException
org.json.JSONException
- if any settings are missing.java.io.IOException
- if the settings file couldn't be loaded.public static java.util.List<java.lang.Class<? extends CombatRenderer>> getCombatRendererClasses()
List
of CombatRenderer
s used in combat.
public static java.util.List<java.lang.Class<? extends CampaignRenderer>> getCampaignRendererClasses()
List
of CampaignRenderer
s used on the
campaign
map.
public static boolean isRespectingFogOfWar()
true
if contacts outside the fog of war will be ignored,
false
otherwise.
public static boolean usesVertexBufferObjects()
true
if VBOs are enabled and the user's card supports
them, false
otherwise.
public static int getVerticesPerCircle()
public static boolean isFilteredOut(com.fs.starfarer.api.campaign.SectorEntityToken token)
token
- The SectorEntityToken
to check.
true
if token
should not be drawn,
false
otherwise.
public static boolean isFilteredOut(com.fs.starfarer.api.combat.CombatEntityAPI entity)
entity
- The CombatEntityAPI
to check.
true
if entity
should not be drawn,
false
otherwise.
public static float getRadarRenderRadius()
public static float getTimeBetweenUpdateFrames()
public static float getMaxCombatSightRange()
public static float getMaxCampaignSightRange()
public static float getZoomAnimationDuration()
public static int getNumZoomLevels()
public static float getRadarUIAlpha()
getRadarContactAlpha()
).
public static float getRadarContactAlpha()
getRadarUIAlpha()
).
public static java.awt.Color getFriendlyContactColor()
Color
that friendly contacts should appear as.
public static java.awt.Color getEnemyContactColor()
Color
that hostile contacts should appear as.
public static java.awt.Color getNeutralContactColor()
Color
that neutral contacts should appear as.
public static java.awt.Color getAlliedContactColor()
Color
that allied contacts should appear as.
public static int getRadarToggleKey()
Keyboard
constant of the key used to toggle the
radar on or off. See
the LWJGL documentation page for details.
public static int getZoomInKey()
Keyboard
constant of the key used to zoom the
radar in. See
the LWJGL documentation page for details.
public static int getZoomOutKey()
Keyboard
constant of the key used to zoom the
radar out. See
the LWJGL documentation page for details.