Package com.fs.starfarer.api.impl.campaign.entities

Class GenericProbeEntityPlugin

java.lang.Object

com.fs.starfarer.api.impl.campaign.BaseCustomEntityPlugin

com.fs.starfarer.api.impl.campaign.entities.GenericProbeEntityPlugin

All Implemented Interfaces:

CustomCampaignEntityPlugin

public class GenericProbeEntityPlugin
extends BaseCustomEntityPlugin

Not fully implemented. Approximate TODO: Sprite size/facing Smoother movement rather than move/turn/move Smoother transition into orbit Add trigger range for detecting when travel to a destination is finished Add failsafe to detect when travel is taking too long Make not clickable/figure out if it should have a tooltip Possibly: add contrail?

Author:

Alex

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenericProbeEntityPlugin.GenericProbeParams
static class	GenericProbeEntityPlugin.ProbeAction
static enum	GenericProbeEntityPlugin.ProbeActionType

Field Summary

Fields

Modifier and Type	Field	Description
protected CampaignEngineGlowUtil	engineGlow
protected CampaignEntityMovementUtil	movement
protected GenericProbeEntityPlugin.GenericProbeParams	params

Fields inherited from class com.fs.starfarer.api.impl.campaign.BaseCustomEntityPlugin

entity

Constructor Summary

Constructors

Constructor	Description
GenericProbeEntityPlugin()

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)
CampaignEngineGlowUtil	getEngineGlow()
CampaignEntityMovementUtil	getMovement()
float	getRenderRange()	How far away from the viewport the center of this entity can be before it stops being rendered.
void	init(SectorEntityToken entity, Object pluginParams)
void	render(CampaignEngineLayers layer, ViewportAPI viewport)	Should only render for specified layer.

Methods inherited from class com.fs.starfarer.api.impl.campaign.BaseCustomEntityPlugin

appendToCampaignTooltip, createMapTooltip, getMapTooltipWidth, hasCustomMapTooltip, isMapTooltipExpandable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.fs.starfarer.api.campaign.CustomCampaignEntityPlugin

isRenderWhenViewportAlphaMultIsZero

Field Details

params

protected GenericProbeEntityPlugin.GenericProbeParams params

movement

protected CampaignEntityMovementUtil movement

engineGlow

protected CampaignEngineGlowUtil engineGlow

Constructor Details

GenericProbeEntityPlugin

public GenericProbeEntityPlugin()

Method Details

init

public void init(SectorEntityToken entity,
 Object pluginParams)

Specified by:

init in interface CustomCampaignEntityPlugin

Overrides:

init in class BaseCustomEntityPlugin

getMovement

public CampaignEntityMovementUtil getMovement()

getEngineGlow

public CampaignEngineGlowUtil getEngineGlow()

advance

public void advance(float amount)

Specified by:

advance in interface CustomCampaignEntityPlugin

Overrides:

advance in class BaseCustomEntityPlugin

Parameters:

amount - in seconds. Use SectorAPI.getClock() to figure out how many campaign days that is.

render

public void render(CampaignEngineLayers layer,
 ViewportAPI viewport)

Description copied from interface: CustomCampaignEntityPlugin

Should only render for specified layer. Will be called once per each layer, per frame. Needs to respect viewport.getAlphaMult() - i.e. use that alpha value for rendering. Needs to render at the entity's location - there's no translation before this method call. If a sprite is specified, it will be rendered in the bottommost layer of the layers this entity renders for. This method will be called after the sprite has rendered.

Specified by:

render in interface CustomCampaignEntityPlugin

Overrides:

render in class BaseCustomEntityPlugin

getRenderRange

public float getRenderRange()

Description copied from interface: CustomCampaignEntityPlugin

How far away from the viewport the center of this entity can be before it stops being rendered. Should at least be the radius of the entity; sometimes more may be necessary depending on the visual effect desired.

Specified by:

getRenderRange in interface CustomCampaignEntityPlugin

Overrides:

getRenderRange in class BaseCustomEntityPlugin

Returns: