public interface LocationAPI
Modifier and Type | Method and Description |
---|---|
boolean |
activeThisFrame()
Whether the location's advance() method was/will be called this frame.
|
AsteroidAPI |
addAsteroid(float radius) |
SectorEntityToken |
addAsteroidBelt(SectorEntityToken focus,
int numAsteroids,
float orbitRadius,
float width,
float minOrbitDays,
float maxOrbitDays) |
SectorEntityToken |
addAsteroidBelt(SectorEntityToken focus,
int numAsteroids,
float orbitRadius,
float width,
float minOrbitDays,
float maxOrbitDays,
java.lang.String terrainId,
java.lang.String optionalName) |
SectorEntityToken |
addCorona(SectorEntityToken star,
float extraRadius,
float windBurnLevel,
float flareProbability,
float crLossMult) |
SectorEntityToken |
addCorona(SectorEntityToken star,
java.lang.String terrainType,
float extraRadius,
float windBurnLevel,
float flareProbability,
float crLossMult) |
CustomCampaignEntityAPI |
addCustomEntity(java.lang.String id,
java.lang.String name,
java.lang.String type,
java.lang.String factionId)
Adds a custom entity.
|
CustomCampaignEntityAPI |
addCustomEntity(java.lang.String id,
java.lang.String name,
java.lang.String type,
java.lang.String factionId,
float radius,
float spriteWidth,
float spriteHeight)
Adds a custom entity with a radius/spritWidth/spriteHeight different than
those defined for this entity type in custom_entities.json.
|
CustomCampaignEntityAPI |
addCustomEntity(java.lang.String id,
java.lang.String name,
java.lang.String type,
java.lang.String factionId,
float radius,
float spriteWidth,
float spriteHeight,
java.lang.Object pluginParams) |
CustomCampaignEntityAPI |
addCustomEntity(java.lang.String id,
java.lang.String name,
java.lang.String type,
java.lang.String factionId,
java.lang.Object pluginParams) |
void |
addEntity(SectorEntityToken entity) |
void |
addFleetStub(FleetStubAPI stub) |
void |
addHitParticle(Vector2f loc,
Vector2f vel,
float size,
float brightness,
float duration,
java.awt.Color color) |
void |
addOrbitalJunk(SectorEntityToken focus,
java.lang.String junkType,
int num,
float minSize,
float maxSize,
float orbitRadius,
float width,
float minOrbitDays,
float maxOrbitDays,
float minSpin,
float maxSpin) |
ParticleControllerAPI |
addParticle(Vector2f loc,
Vector2f vel,
float size,
float brightness,
float rampUp,
float duration,
java.awt.Color color) |
PlanetAPI |
addPlanet(java.lang.String id,
SectorEntityToken focus,
java.lang.String name,
java.lang.String type,
float angle,
float radius,
float orbitRadius,
float orbitDays) |
SectorEntityToken |
addRadioChatter(SectorEntityToken entity,
float extraRadius) |
RingBandAPI |
addRingBand(SectorEntityToken focus,
java.lang.String category,
java.lang.String key,
float bandWidthInTexture,
int bandIndex,
java.awt.Color color,
float bandWidthInEngine,
float middleRadius,
float orbitDays)
Texture must have vertical, equal width bands in it.
|
SectorEntityToken |
addRingBand(SectorEntityToken focus,
java.lang.String category,
java.lang.String key,
float bandWidthInTexture,
int bandIndex,
java.awt.Color color,
float bandWidthInEngine,
float middleRadius,
float orbitDays,
java.lang.String terrainId,
java.lang.String optionalName)
Same as above, but with a "terrain" ring also being added.
|
void |
addScript(EveryFrameScript script)
Will run every time this location's advance() is called.
|
void |
addSpawnPoint(SpawnPointPlugin point) |
void |
addTag(java.lang.String tag) |
SectorEntityToken |
addTerrain(java.lang.String terrainId,
java.lang.Object param) |
void |
clearTags() |
SectorEntityToken |
createToken(float x,
float y)
Not actually added to the location, and doesn't need to be.
|
SectorEntityToken |
createToken(Vector2f loc) |
java.util.List<SectorEntityToken> |
getAllEntities() |
java.util.List<SectorEntityToken> |
getAsteroids() |
ColorShifterAPI |
getBackgroundColorShifter() |
ColorShifterAPI |
getBackgroundParticleColorShifter() |
java.lang.String |
getBackgroundTextureFilename() |
Constellation |
getConstellation() |
java.util.List<CustomCampaignEntityAPI> |
getCustomEntities() |
java.util.List<CustomCampaignEntityAPI> |
getCustomEntitiesWithTag(java.lang.String tag)
Similar to getEntitiesWithTag(), but for custom entities only.
|
float |
getDaysSinceLastPlayerVisit() |
java.util.List |
getEntities(java.lang.Class implementedClassOrInterface)
Examples:
getEntities(JumpPointAPI.class) - gets all jump points
getEntities(CampaignFleetAPI.class) - gets all fleets
General version of getFleets(), getPlanets(), etc
|
java.util.List<SectorEntityToken> |
getEntitiesWithTag(java.lang.String tag) |
SectorEntityToken |
getEntityById(java.lang.String id) |
SectorEntityToken |
getEntityByName(java.lang.String name)
Deprecated.
|
java.util.List<CampaignFleetAPI> |
getFleets() |
java.util.List<FleetStubAPI> |
getFleetStubs() |
java.util.List<NascentGravityWellAPI> |
getGravityWells() |
java.lang.String |
getId() |
java.util.List<SectorEntityToken> |
getJumpPoints() |
long |
getLastPlayerVisitTimestamp() |
Vector2f |
getLocation() |
MemoryAPI |
getMemoryWithoutUpdate() |
java.lang.String |
getName() |
java.lang.String |
getNameWithLowercaseType() |
java.lang.String |
getNameWithLowercaseTypeShort() |
java.lang.String |
getNameWithNoType() |
java.lang.String |
getNameWithTypeIfNebula() |
java.lang.String |
getNameWithTypeShort() |
java.util.List<SectorEntityToken> |
getOrbitalStations()
Deprecated.
|
java.util.Map<java.lang.String,java.lang.Object> |
getPersistentData() |
java.util.List<PlanetAPI> |
getPlanets() |
java.util.List<EveryFrameScript> |
getScripts() |
java.util.List<SpawnPointPlugin> |
getSpawnPoints() |
java.util.Collection<java.lang.String> |
getTags() |
java.util.List<CampaignTerrainAPI> |
getTerrainCopy() |
boolean |
hasTag(java.lang.String tag) |
boolean |
isCurrentLocation() |
boolean |
isDeepSpace() |
boolean |
isHyperspace() |
boolean |
isInConstellation() |
boolean |
isNebula() |
void |
removeEntity(SectorEntityToken entity) |
void |
removeFleetStub(FleetStubAPI stub) |
void |
removeScript(EveryFrameScript script) |
void |
removeScriptsOfClass(java.lang.Class c) |
void |
removeSpawnPoint(SpawnPointPlugin point) |
void |
removeTag(java.lang.String tag) |
void |
renderingLayersUpdated(SectorEntityToken entity) |
void |
setBackgroundOffset(float x,
float y) |
void |
setBackgroundTextureFilename(java.lang.String backgroundTextureFilename) |
void |
setName(java.lang.String name) |
void |
spawnFleet(SectorEntityToken anchor,
float xOffset,
float yOffset,
CampaignFleetAPI fleet) |
void |
updateAllOrbits() |
java.lang.String getId()
boolean activeThisFrame()
java.lang.String getBackgroundTextureFilename()
void setBackgroundTextureFilename(java.lang.String backgroundTextureFilename)
void addSpawnPoint(SpawnPointPlugin point)
void removeSpawnPoint(SpawnPointPlugin point)
java.util.List<SpawnPointPlugin> getSpawnPoints()
void spawnFleet(SectorEntityToken anchor, float xOffset, float yOffset, CampaignFleetAPI fleet)
SectorEntityToken createToken(float x, float y)
x
- y
- SectorEntityToken createToken(Vector2f loc)
void addEntity(SectorEntityToken entity)
void removeEntity(SectorEntityToken entity)
PlanetAPI addPlanet(java.lang.String id, SectorEntityToken focus, java.lang.String name, java.lang.String type, float angle, float radius, float orbitRadius, float orbitDays)
SectorEntityToken addAsteroidBelt(SectorEntityToken focus, int numAsteroids, float orbitRadius, float width, float minOrbitDays, float maxOrbitDays)
SectorEntityToken addAsteroidBelt(SectorEntityToken focus, int numAsteroids, float orbitRadius, float width, float minOrbitDays, float maxOrbitDays, java.lang.String terrainId, java.lang.String optionalName)
void addOrbitalJunk(SectorEntityToken focus, java.lang.String junkType, int num, float minSize, float maxSize, float orbitRadius, float width, float minOrbitDays, float maxOrbitDays, float minSpin, float maxSpin)
RingBandAPI addRingBand(SectorEntityToken focus, java.lang.String category, java.lang.String key, float bandWidthInTexture, int bandIndex, java.awt.Color color, float bandWidthInEngine, float middleRadius, float orbitDays)
focus
- category
- graphics category in settings.jsonkey
- id within categorybandWidthInTexture
- bandIndex
- color
- bandWidthInEngine
- orbitDays
- middleRadius
- SectorEntityToken addRingBand(SectorEntityToken focus, java.lang.String category, java.lang.String key, float bandWidthInTexture, int bandIndex, java.awt.Color color, float bandWidthInEngine, float middleRadius, float orbitDays, java.lang.String terrainId, java.lang.String optionalName)
focus
- category
- key
- bandWidthInTexture
- bandIndex
- color
- bandWidthInEngine
- middleRadius
- orbitDays
- terrainId
- optionalName
- CustomCampaignEntityAPI addCustomEntity(java.lang.String id, java.lang.String name, java.lang.String type, java.lang.String factionId)
id
- unique id. autogenerated if null.name
- default name for entity used if this is nulltype
- id in custom_entities.jsonfactionId
- defaults to "neutral" if not specifiedCustomCampaignEntityAPI addCustomEntity(java.lang.String id, java.lang.String name, java.lang.String type, java.lang.String factionId, float radius, float spriteWidth, float spriteHeight)
id
- unique id. autogenerated if null.name
- default name for entity used if this is nulltype
- id in custom_entities.jsonfactionId
- defaults to "neutral" if not specifiedradius
- spriteWidth
- spriteHeight
- SectorEntityToken addTerrain(java.lang.String terrainId, java.lang.Object param)
java.util.List getEntities(java.lang.Class implementedClassOrInterface)
implementedClassOrInterface
- java.util.List<SectorEntityToken> getEntitiesWithTag(java.lang.String tag)
java.util.List<CampaignFleetAPI> getFleets()
java.util.List<PlanetAPI> getPlanets()
@Deprecated java.util.List<SectorEntityToken> getOrbitalStations()
java.util.List<SectorEntityToken> getAsteroids()
@Deprecated SectorEntityToken getEntityByName(java.lang.String name)
name
- SectorEntityToken getEntityById(java.lang.String id)
Vector2f getLocation()
boolean isHyperspace()
void addScript(EveryFrameScript script)
script
- void removeScriptsOfClass(java.lang.Class c)
void removeScript(EveryFrameScript script)
java.lang.String getName()
void setName(java.lang.String name)
java.util.List<SectorEntityToken> getAllEntities()
SectorEntityToken addCorona(SectorEntityToken star, float extraRadius, float windBurnLevel, float flareProbability, float crLossMult)
SectorEntityToken addCorona(SectorEntityToken star, java.lang.String terrainType, float extraRadius, float windBurnLevel, float flareProbability, float crLossMult)
java.util.List<CampaignTerrainAPI> getTerrainCopy()
java.util.Map<java.lang.String,java.lang.Object> getPersistentData()
AsteroidAPI addAsteroid(float radius)
void setBackgroundOffset(float x, float y)
SectorEntityToken addRadioChatter(SectorEntityToken entity, float extraRadius)
void updateAllOrbits()
boolean isNebula()
java.lang.String getNameWithLowercaseType()
java.util.List<FleetStubAPI> getFleetStubs()
void removeFleetStub(FleetStubAPI stub)
void addFleetStub(FleetStubAPI stub)
Constellation getConstellation()
boolean isInConstellation()
java.lang.String getNameWithTypeIfNebula()
java.util.Collection<java.lang.String> getTags()
boolean hasTag(java.lang.String tag)
void addTag(java.lang.String tag)
void removeTag(java.lang.String tag)
void clearTags()
CustomCampaignEntityAPI addCustomEntity(java.lang.String id, java.lang.String name, java.lang.String type, java.lang.String factionId, float radius, float spriteWidth, float spriteHeight, java.lang.Object pluginParams)
CustomCampaignEntityAPI addCustomEntity(java.lang.String id, java.lang.String name, java.lang.String type, java.lang.String factionId, java.lang.Object pluginParams)
java.util.List<SectorEntityToken> getJumpPoints()
long getLastPlayerVisitTimestamp()
float getDaysSinceLastPlayerVisit()
java.util.List<CustomCampaignEntityAPI> getCustomEntitiesWithTag(java.lang.String tag)
tag
- java.util.List<EveryFrameScript> getScripts()
void addHitParticle(Vector2f loc, Vector2f vel, float size, float brightness, float duration, java.awt.Color color)
void renderingLayersUpdated(SectorEntityToken entity)
MemoryAPI getMemoryWithoutUpdate()
ParticleControllerAPI addParticle(Vector2f loc, Vector2f vel, float size, float brightness, float rampUp, float duration, java.awt.Color color)
java.lang.String getNameWithNoType()
boolean isCurrentLocation()
java.lang.String getNameWithLowercaseTypeShort()
java.lang.String getNameWithTypeShort()
java.util.List<NascentGravityWellAPI> getGravityWells()
java.util.List<CustomCampaignEntityAPI> getCustomEntities()
ColorShifterAPI getBackgroundColorShifter()
ColorShifterAPI getBackgroundParticleColorShifter()
boolean isDeepSpace()
Copyright © 2013 Fractal Softworks, LLC. All Rights Reserved.