 | BWAPI 4.2.0 An API for interacting with Starcraft: Broodwar (1.16.1) |
| BWAPI 4.2.0 An API for interacting with Starcraft: Broodwar (1.16.1) |
Public Member Functions | |
| virtual bool | exists () const =0 |
| virtual double | getAngle () const =0 |
| virtual int | getID () const =0 |
| virtual Player | getPlayer () const =0 |
| virtual Position | getPosition () const =0 |
| virtual int | getRemoveTimer () const =0 |
| virtual Unit | getSource () const =0 |
| virtual Unit | getTarget () const =0 |
| virtual Position | getTargetPosition () const =0 |
| virtual BulletType | getType () const =0 |
| virtual double | getVelocityX () const =0 |
| virtual double | getVelocityY () const =0 |
| virtual bool | isVisible (Player player=nullptr) const =0 |
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.
Retrieves a unique identifier for the current Bullet.
Checks if the Bullet exists in the view of the BWAPI player.
| 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.
Retrieves the Player interface that owns the Bullet.
| nullptr | If the Player object for this Bullet is inaccessible. |
Retrieves the type of this Bullet.
| BulletTypes::Unknown | if the Bullet is inaccessible. |
Retrieves the Unit interface that the Bullet spawned from.
| nullptr | If the source can not be identified or is inaccessible. |
Retrieves the Bullet's current position.
| Positions::Unknown | If the Bullet is inaccessible. |
Retrieve's the direction the Bullet is facing.
If the angle is 0, then the Bullet is facing right.
| 0.0 | If the bullet is inaccessible. |
Retrieves the X component of the Bullet's velocity, measured in pixels per frame.
| 0.0 | if the Bullet is inaccessible. |
Retrieves the Y component of the Bullet's velocity, measured in pixels per frame.
| 0.0 | if the Bullet is inaccessible. |
Retrieves the Unit interface that the Bullet is heading to.
| nullptr | If the Bullet's target Unit is inaccessible, the Bullet is targetting the ground, or if the Bullet itself is inaccessible. |
Retrieves the target position that the Bullet is heading to.
| Positions::Unknown | If the bullet is inaccessible. |
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.
| 0 | If the Bullet is inaccessible. |
Retrieves the visibility state of the Bullet.
| 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. |
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.| true | If the Bullet is visible to the specified player. |
| false | If the Bullet is not visible to the specified player. |
1.8.11