com.fs.starfarer.api.combat

Interface CombatEntityAPI

All Known Subinterfaces:

BattleObjectiveAPI, CombatAsteroidAPI, DamagingProjectileAPI, EmpArcEntityAPI, MissileAPI, ShipAPI

public interface CombatEntityAPI

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAI()
float	getAngularVelocity()
CollisionClass	getCollisionClass()
float	getCollisionRadius()
java.util.Map<java.lang.String,java.lang.Object>	getCustomData() DO NOT call .put() methods on the returned map.
BoundsAPI	getExactBounds() Can return null if there aren't any bounds, in which case just the collision radius should be used.
float	getFacing()
float	getHitpoints()
float	getHullLevel()
org.lwjgl.util.vector.Vector2f	getLocation()
float	getMass()
float	getMaxHitpoints()
int	getOwner() 0 = player 1 = enemy 100 = neutral (used for ship hulks)
ShieldAPI	getShield() Returns null for entities without shields.
org.lwjgl.util.vector.Vector2f	getVelocity() Note: For projectiles, do not use this! Projectile movement is defined by its moveSpeed and facing, not velocity!
boolean	isExpired()
boolean	isPointInBounds(org.lwjgl.util.vector.Vector2f p)
void	removeCustomData(java.lang.String key)
void	setAngularVelocity(float angVel)
void	setCollisionClass(CollisionClass collisionClass)
void	setCollisionRadius(float radius) Should always circumscribe the bounds, if any.
void	setCustomData(java.lang.String key, java.lang.Object data)
void	setFacing(float facing)
void	setHitpoints(float hitpoints)
void	setMass(float mass)
void	setOwner(int owner) 0 = player 1 = enemy 100 = neutral (used for ship hulks)
boolean	wasRemoved()

Method Detail

getLocation

org.lwjgl.util.vector.Vector2f getLocation()

getVelocity

org.lwjgl.util.vector.Vector2f getVelocity()

Note: For projectiles, do not use this! Projectile movement is defined by its moveSpeed and facing, not velocity!

Returns:

getFacing

float getFacing()

setFacing

void setFacing(float facing)

getAngularVelocity

float getAngularVelocity()

setAngularVelocity

void setAngularVelocity(float angVel)

getOwner

int getOwner()

0 = player 1 = enemy 100 = neutral (used for ship hulks)

Returns:

setOwner

void setOwner(int owner)

0 = player 1 = enemy 100 = neutral (used for ship hulks)

getCollisionRadius

float getCollisionRadius()

getCollisionClass

CollisionClass getCollisionClass()

setCollisionClass

void setCollisionClass(CollisionClass collisionClass)

getMass

float getMass()

setMass

void setMass(float mass)

getExactBounds

BoundsAPI getExactBounds()

Can return null if there aren't any bounds, in which case just the collision radius should be used. The bounds are guaranteed to be inside the collision radius.

Returns:

getShield

ShieldAPI getShield()

Returns null for entities without shields.

Returns:

getHullLevel

float getHullLevel()

Returns:

hull level, normalized to (0, 1)

getHitpoints

float getHitpoints()

Returns:

actual hull points left

getMaxHitpoints

float getMaxHitpoints()

Returns:

maximum hull points for the ship

setCollisionRadius

void setCollisionRadius(float radius)

Should always circumscribe the bounds, if any.

Parameters:

radius -

getAI

java.lang.Object getAI()

isExpired

boolean isExpired()

setCustomData

void setCustomData(java.lang.String key,
                   java.lang.Object data)

removeCustomData

void removeCustomData(java.lang.String key)

getCustomData

java.util.Map<java.lang.String,java.lang.Object> getCustomData()

DO NOT call .put() methods on the returned map. Use setCustomData() instead. When the map is empty, it will return a new non-null map that will not be retained, so any additions to it would be lost.

Returns:

setHitpoints

void setHitpoints(float hitpoints)

isPointInBounds

boolean isPointInBounds(org.lwjgl.util.vector.Vector2f p)

wasRemoved

boolean wasRemoved()