Inheritance diagram for com.fs.starfarer.api.combat.CombatEntityAPI:

[legend]

Public Member Functions
Vector2f	getLocation ()

Vector2f	getVelocity ()

float	getFacing ()

void	setFacing (float facing)

float	getAngularVelocity ()

void	setAngularVelocity (float angVel)

int	getOwner ()

void	setOwner (int owner)

float	getCollisionRadius ()

CollisionClass	getCollisionClass ()

void	setCollisionClass (CollisionClass collisionClass)

float	getMass ()

void	setMass (float mass)

BoundsAPI	getExactBounds ()

ShieldAPI	getShield ()

float	getHullLevel ()

float	getHitpoints ()

float	getMaxHitpoints ()

void	setCollisionRadius (float radius)

Object	getAI ()

boolean	isExpired ()

void	setCustomData (String key, Object data)

void	removeCustomData (String key)

Map< String, Object >	getCustomData ()

void	setHitpoints (float hitpoints)

Detailed Description

Definition at line 7 of file CombatEntityAPI.java.

Member Function Documentation

◆ getAI()

Object com.fs.starfarer.api.combat.CombatEntityAPI.getAI ( )

◆ getAngularVelocity()

float com.fs.starfarer.api.combat.CombatEntityAPI.getAngularVelocity ( )

◆ getCollisionClass()

CollisionClass com.fs.starfarer.api.combat.CombatEntityAPI.getCollisionClass ( )

◆ getCollisionRadius()

float com.fs.starfarer.api.combat.CombatEntityAPI.getCollisionRadius ( )

◆ getCustomData()

Map< String, Object > com.fs.starfarer.api.combat.CombatEntityAPI.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

◆ getExactBounds()

BoundsAPI com.fs.starfarer.api.combat.CombatEntityAPI.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

◆ getFacing()

float com.fs.starfarer.api.combat.CombatEntityAPI.getFacing ( )

◆ getHitpoints()

float com.fs.starfarer.api.combat.CombatEntityAPI.getHitpoints ( )

Returns: actual hull points left

◆ getHullLevel()

float com.fs.starfarer.api.combat.CombatEntityAPI.getHullLevel ( )

Returns: hull level, normalized to (0, 1)

◆ getLocation()

Vector2f com.fs.starfarer.api.combat.CombatEntityAPI.getLocation ( )

Implemented in com.fs.starfarer.api.combat.BattleObjectiveAPI.

◆ getMass()

float com.fs.starfarer.api.combat.CombatEntityAPI.getMass ( )

◆ getMaxHitpoints()

float com.fs.starfarer.api.combat.CombatEntityAPI.getMaxHitpoints ( )

Returns: maximum hull points for the ship

◆ getOwner()

int com.fs.starfarer.api.combat.CombatEntityAPI.getOwner ( )

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

Returns

Implemented in com.fs.starfarer.api.combat.BattleObjectiveAPI.

◆ getShield()

ShieldAPI com.fs.starfarer.api.combat.CombatEntityAPI.getShield ( )

Returns null for entities without shields.

Returns

◆ getVelocity()

Vector2f com.fs.starfarer.api.combat.CombatEntityAPI.getVelocity ( )

◆ isExpired()

boolean com.fs.starfarer.api.combat.CombatEntityAPI.isExpired ( )

◆ removeCustomData()

void com.fs.starfarer.api.combat.CombatEntityAPI.removeCustomData ( String key )

◆ setAngularVelocity()

void com.fs.starfarer.api.combat.CombatEntityAPI.setAngularVelocity ( float angVel )

◆ setCollisionClass()

void com.fs.starfarer.api.combat.CombatEntityAPI.setCollisionClass ( CollisionClass collisionClass )

◆ setCollisionRadius()

void com.fs.starfarer.api.combat.CombatEntityAPI.setCollisionRadius ( float radius )

Should always circumscribe the bounds, if any.

Parameters

radius

◆ setCustomData()

void com.fs.starfarer.api.combat.CombatEntityAPI.setCustomData	(	String	key,
		Object	data
	)

◆ setFacing()

void com.fs.starfarer.api.combat.CombatEntityAPI.setFacing ( float facing )

◆ setHitpoints()

void com.fs.starfarer.api.combat.CombatEntityAPI.setHitpoints ( float hitpoints )

Implemented in com.fs.starfarer.api.combat.ShipAPI.

◆ setMass()

void com.fs.starfarer.api.combat.CombatEntityAPI.setMass ( float mass )

◆ setOwner()

void com.fs.starfarer.api.combat.CombatEntityAPI.setOwner ( int owner )