Bullet (jbwapi 2.1.0 API)

java.lang.Object
- bwapi.Bullet

All Implemented Interfaces:

Comparable<Bullet>
```
public final class Bullet
extends Object
implements Comparable<Bullet>
```
An object representing a bullet or missile spawned from an attack.
The Bullet interface allows you to detect bullets, missiles, and other types of non-melee attacks or special abilities that would normally be visible through human eyes (A lurker spike or a Queen's flying parasite), allowing quicker reaction to unavoidable consequences.
For example, ordering medics to restore units that are about to receive a lockdown to compensate for latency and minimize its effects. You can't know entirely which unit will be receiving a lockdown unless you can detect the lockdown missile using the Bullet class.
Bullet objects are re-used after they are destroyed, however their ID is updated when it represents a new Bullet.
If Flag.CompleteMapInformation is disabled, then a Bullet is accessible if and only if it is visible. Otherwise if Flag.CompleteMapInformation is enabled, then all Bullets in the game are accessible.

See Also:

Game.getBullets(), exists()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Bullet other)`
`boolean`	`equals(Object o)`
`boolean`	`exists()` Checks if the `Bullet` exists in the view of the BWAPI player.
`double`	`getAngle()` Retrieve's the direction the `Bullet` is facing.
`int`	`getID()` Retrieves a unique identifier for the current `Bullet`.
`Player`	`getPlayer()` Retrieves the `Player` interface that owns the Bullet.
`Position`	`getPosition()` Retrieves the Bullet's current position.
`int`	`getRemoveTimer()` Retrieves the timer that indicates the Bullet's life span.
`Unit`	`getSource()` Retrieves the `Unit` that the `Bullet` spawned from.
`Unit`	`getTarget()` Retrieves the Unit interface that the `Bullet` is heading to.
`Position`	`getTargetPosition()` Retrieves the target position that the `Bullet` is heading to.
`BulletType`	`getType()` Retrieves the type of this `Bullet`.
`double`	`getVelocityX()` Retrieves the X component of the Bullet's velocity, measured in pixels per frame.
`double`	`getVelocityY()` Retrieves the Y component of the Bullet's velocity, measured in pixels per frame.
`int`	`hashCode()`
`boolean`	`isVisible()`
`boolean`	`isVisible(Player player)` Retrieves the visibility state of the Bullet.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getID
```
public int getID()
```
    Retrieves a unique identifier for the current Bullet.
    
    Returns:
    
    An integer value containing the identifier.
  - exists
```
public boolean exists()
```
    Checks if the Bullet exists in the view of the BWAPI player.
    If Flag.CompleteMapInformation is disabled, and a Bullet is not visible, then the return value will be false regardless of the Bullet's true existence. This is because absolutely no state information on invisible enemy bullets is made available to the AI.
    If Flag.CompleteMapInformation is enabled, then this function is accurate for all Bullet information.
    
    Returns:
    
    true if the bullet exists or is visible, false if the bullet was destroyed or has gone out of scope.
    
    See Also:
    
    isVisible(), Unit.exists()
  - getPlayer
```
public Player getPlayer()
```
    Retrieves the Player interface that owns the Bullet.
    
    Returns:
    
    The owning Player object. Returns null if the Player object for this Bullet is inaccessible.
  - getType
```
public BulletType getType()
```
    Retrieves the type of this Bullet.
    
    Returns:
    
    A BulletType representing the Bullet's type. Returns BulletType.Unknown if the Bullet is inaccessible.
  - getSource
```
public Unit getSource()
```
    Retrieves the Unit that the Bullet spawned from.
    
    Returns:
    
    The owning Unit object. Returns null if the source can not be identified or is inaccessible.
    
    See Also:
    
    getTarget()
  - getPosition
```
public Position getPosition()
```
    Retrieves the Bullet's current position.
    
    Returns:
    
    A Position containing the Bullet's current coordinates. Returns Position.Unknown if the Bullet is inaccessible.
    
    See Also:
    
    getTargetPosition()
  - getAngle
```
public double getAngle()
```
    Retrieve's the direction the Bullet is facing. If the angle is 0, then the Bullet is facing right.
    
    Returns:
    
    A double representing the direction the Bullet is facing. Returns 0.0 if the bullet is inaccessible.
  - getVelocityX
```
public double getVelocityX()
```
    Retrieves the X component of the Bullet's velocity, measured in pixels per frame.
    
    Returns:
    
    A double representing the number of pixels moved on the X axis per frame. Returns 0.0 if the Bullet is inaccessible.
    
    See Also:
    
    getVelocityY(), getAngle()
  - getVelocityY
```
public double getVelocityY()
```
    Retrieves the Y component of the Bullet's velocity, measured in pixels per frame.
    
    Returns:
    
    A double representing the number of pixels moved on the Y axis per frame. Returns 0.0 if the Bullet is inaccessible.
    
    See Also:
    
    getVelocityX(), getAngle()
  - getTarget
```
public Unit getTarget()
```
    Retrieves the Unit interface that the Bullet is heading to.
    
    Returns:
    
    The target Unit object, if one exists. Returns null if the Bullet's target Unit is inaccessible, the Bullet is targetting the ground, or if the Bullet itself is inaccessible.
    
    See Also:
    
    getTargetPosition(), getSource()
  - getTargetPosition
```
public Position getTargetPosition()
```
    Retrieves the target position that the Bullet is heading to.
    
    Returns:
    
    A Position indicating where the Bullet is headed. Returns Position.Unknown if the bullet is inaccessible.
    
    See Also:
    
    getTarget(), getPosition()
  - getRemoveTimer
```
public int getRemoveTimer()
```
    Retrieves the timer that indicates the Bullet's life span.
    Bullets are not permanent objects, so they will often have a limited life span. This life span is measured in frames. Normally a Bullet will reach its target before being removed.
    
    Returns:
    
    An integer representing the remaining number of frames until the Bullet self-destructs. Returns 0 if the Bullet is inaccessible.
  - isVisible
```
public boolean isVisible()
```
  - isVisible
```
public boolean isVisible(Player player)
```
    Retrieves the visibility state of the Bullet.
    
    Parameters:
    
    player - If this parameter is specified, then the Bullet's visibility to the given player is checked. If this parameter is omitted, then a default value of null is used, which will check if the BWAPI player has vision of the Bullet.
    
    Returns:
    
    true if the Bullet is visible to the specified player, false if the Bullet is not visible to the specified player.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(Bullet other)
```
    Specified by:
    
    compareTo in interface Comparable<Bullet>

Class Bullet

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getID

exists

getPlayer

getType

getSource

getPosition

getAngle

getVelocityX

getVelocityY

getTarget

getTargetPosition

getRemoveTimer

isVisible

isVisible

equals

hashCode

compareTo