Skip to content

Commit 67bc4d4

Browse files
committed
Player(Type) doc fixes
1 parent e2c74d9 commit 67bc4d4

File tree

5 files changed

+84
-96
lines changed

5 files changed

+84
-96
lines changed

src/main/java/bwapi/Bullet.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public int getID() {
5555
* If {@link Flag#CompleteMapInformation} is enabled, then this function is accurate for all
5656
* {@link Bullet} information.
5757
*
58-
* @return true if the bullet exists or is visible. false if the bullet was destroyed or has gone out of scope.
58+
* @return true if the bullet exists or is visible, false if the bullet was destroyed or has gone out of scope.
5959
* @see {@link #isVisible}, {@link Unit#exists}
6060
*/
6161
public boolean exists() {
@@ -174,7 +174,7 @@ public boolean isVisible() {
174174
*
175175
* @param 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 {@link Bullet}.
176176
*
177-
* @return true if the {@link Bullet} is visible to the specified player. false if the {@link Bullet} is not visible to the specified player.
177+
* @return true if the {@link Bullet} is visible to the specified player, false if the {@link Bullet} is not visible to the specified player.
178178
*/
179179
public boolean isVisible(final Player player) {
180180
if (player == null) {

src/main/java/bwapi/Game.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -997,7 +997,7 @@ public boolean isVisible(final TilePosition position) {
997997
* @param tileX The x tile coordinate to check.
998998
* @param tileY The y tile coordinate to check.
999999
*
1000-
* @return true if the player has explored the given tile position (partially revealed fog). false if the tile position was never explored (completely black fog).
1000+
* @return true if the player has explored the given tile position (partially revealed fog), false if the tile position was never explored (completely black fog).
10011001
*
10021002
* @see {@link #isVisible}
10031003
*/
@@ -1018,7 +1018,7 @@ public boolean isExplored(final TilePosition position) {
10181018
* @param tileX The x tile coordinate to check.
10191019
* @param tileY The y tile coordinate to check.
10201020
*
1021-
* @return true if the given tile has creep on it. false if the given tile does not have creep, or if it is concealed by the fog of war.
1021+
* @return true if the given tile has creep on it, false if the given tile does not have creep, or if it is concealed by the fog of war.
10221022
*/
10231023
public boolean hasCreep(final int tileX, final int tileY) {
10241024
return hasCreep(new TilePosition(tileX, tileY));
@@ -1043,7 +1043,7 @@ public boolean hasPowerPrecise(final int x, final int y) {
10431043
* @param y The y pixel coordinate to check.
10441044
* @param unitType Checks if the given {@link UnitType} requires power or not. If ommitted, then it will assume that the position requires power for any unit type.
10451045
*
1046-
* @return true if the type at the given position will have power. false if the type at the given position will be unpowered.
1046+
* @return true if the type at the given position will have power, false if the type at the given position will be unpowered.
10471047
*/
10481048
public boolean hasPowerPrecise(final int x, final int y, final UnitType unitType) {
10491049
return hasPowerPrecise(new Position(x, y), unitType);
@@ -1091,7 +1091,7 @@ public boolean hasPower(final int tileX, final int tileY, final int tileWidth, f
10911091
* @param tileY The y tile coordinate to check.
10921092
* @param unitType Checks if the given UnitType will be powered if placed at the given tile position. If omitted, then only the immediate tile position is checked for power, and the function will assume that the location requires power for any unit type.
10931093
*
1094-
* @return true if the type at the given tile position will receive power. false if the type will be unpowered at the given tile position.
1094+
* @return true if the type at the given tile position will receive power, false if the type will be unpowered at the given tile position.
10951095
*/
10961096
public boolean hasPower(final int tileX, final int tileY, final int tileWidth, final int tileHeight, final UnitType unitType) {
10971097
return hasPowerPrecise(tileX * 32 + tileWidth * 16, tileY * 32 + tileHeight * 16, unitType);

0 commit comments

Comments
 (0)