bwapi

Class Bullet

java.lang.Object

bwapi.Bullet

public class Bullet
extends java.lang.Object

An interface 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, BulletInterface::exists

Method Summary

Methods

Modifier and Type	Method and Description
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 interface 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.
boolean	isVisible() Retrieves the visibility state of the Bullet.
boolean	isVisible(Player player)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, 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. Return values true If the bullet exists or is visible. false If the bullet was destroyed or has gone out of scope. 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. See also isVisible, UnitInterface::exists

getPlayer

public Player getPlayer()

Retrieves the Player interface that owns the Bullet. Return values nullptr If the Player object for this Bullet is inaccessible. Returns The owning Player interface object.

getType

public BulletType getType()

Retrieves the type of this Bullet. Return values BulletTypes::Unknown if the Bullet is inaccessible. Returns A BulletType representing the Bullet's type.

getSource

public Unit getSource()

Retrieves the Unit interface that the Bullet spawned from. Return values nullptr If the source can not be identified or is inaccessible. Returns The owning Unit interface object. See also getTarget

getPosition

public Position getPosition()

Retrieves the Bullet's current position. Return values Positions::Unknown If the Bullet is inaccessible. Returns A Position containing the Bullet's current coordinates. 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. Return values 0.0 If the bullet is inaccessible. Returns A double representing the direction the Bullet is facing.

getVelocityX

public double getVelocityX()

Retrieves the X component of the Bullet's velocity, measured in pixels per frame. Return values 0.0 if the Bullet is inaccessible. Returns A double representing the number of pixels moved on the X axis per frame. See also getVelocityY, getAngle

getVelocityY

public double getVelocityY()

Retrieves the Y component of the Bullet's velocity, measured in pixels per frame. Return values 0.0 if the Bullet is inaccessible. Returns A double representing the number of pixels moved on the Y axis per frame. See also getVelocityX, getAngle

getTarget

public Unit getTarget()

Retrieves the Unit interface that the Bullet is heading to. Return values nullptr If the Bullet's target Unit is inaccessible, the Bullet is targetting the ground, or if the Bullet itself is inaccessible. Returns The target Unit interface object, if one exists. See also getTargetPosition, getSource

getTargetPosition

public Position getTargetPosition()

Retrieves the target position that the Bullet is heading to. Return values Positions::Unknown If the bullet is inaccessible. Returns A Position indicating where the Bullet is headed. 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. Return values 0 If the Bullet is inaccessible. Returns An integer representing the remaining number of frames until the Bullet self-destructs.

isVisible

public boolean isVisible()

Retrieves the visibility state of the Bullet. Parameters player (optional) 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 nullptr is used, which will check if the BWAPI player has vision of the Bullet. Note If player is nullptr and Broodwar->self() is also nullptr, then the visibility of the Bullet is determined by checking if at least one other player has vision of the Bullet. Return values true If the Bullet is visible to the specified player. false If the Bullet is not visible to the specified player.

isVisible

public boolean isVisible(Player player)