Skip to content

Commit 226b179

Browse files
committed
Exposed more enumerated type IDs. Added JavaDoc for new training queue accessors.
1 parent 04bef2c commit 226b179

File tree

10 files changed

+16
-12
lines changed

10 files changed

+16
-12
lines changed

src/main/java/bwapi/BulletType.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public enum BulletType {
5959
Arrays.stream(BulletType.values()).forEach(v -> idToEnum[v.id] = v);
6060
}
6161

62-
final int id;
62+
public final int id;
6363

6464
BulletType(final int id) {
6565
this.id = id;

src/main/java/bwapi/CommandType.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public enum CommandType {
3232
Arrays.stream(CommandType.values()).forEach(v -> idToEnum[v.id] = v);
3333
}
3434

35-
final int id;
35+
public final int id;
3636

3737
CommandType(final int id) {
3838
this.id = id;

src/main/java/bwapi/EventType.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public enum EventType {
3333
Arrays.stream(EventType.values()).forEach(v -> idToEnum[v.id] = v);
3434
}
3535

36-
final int id;
36+
public final int id;
3737

3838
EventType(int id) {
3939
this.id = id;

src/main/java/bwapi/GameType.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ public enum GameType {
3535
Arrays.stream(GameType.values()).forEach(v -> idToEnum[v.id] = v);
3636
}
3737

38-
39-
final int id;
38+
public final int id;
4039

4140
GameType(final int id) {
4241
this.id = id;

src/main/java/bwapi/Latency.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public enum Latency {
2323
Arrays.stream(Latency.values()).forEach(v -> idToEnum[v.id] = v);
2424
}
2525

26-
final int id;
26+
public final int id;
2727

2828
Latency(final int id) {
2929
this.id = id;

src/main/java/bwapi/Order.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,8 +209,7 @@ public enum Order {
209209
Arrays.stream(Order.values()).forEach(v -> idToEnum[v.id] = v);
210210
}
211211

212-
213-
final int id;
212+
public final int id;
214213

215214
Order(final int id) {
216215
this.id = id;

src/main/java/bwapi/PlayerType.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public enum PlayerType {
2626
Arrays.stream(PlayerType.values()).forEach(v -> idToEnum[v.id] = v);
2727
}
2828

29-
final int id;
29+
public final int id;
3030

3131
PlayerType(final int id) {
3232
this.id = id;

src/main/java/bwapi/Race.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public enum Race {
5858
Arrays.stream(Race.values()).forEach(v -> idToEnum[v.id] = v);
5959
}
6060

61-
final int id;
61+
public final int id;
6262

6363
Race(final int id) {
6464
this.id = id;

src/main/java/bwapi/ShapeType.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ enum ShapeType {
2121
Arrays.stream(ShapeType.values()).forEach(v -> idToEnum[v.id] = v);
2222
}
2323

24-
final int id;
24+
public final int id;
2525

2626
ShapeType(final int id) {
2727
this.id = id;

src/main/java/bwapi/Unit.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -826,7 +826,7 @@ public UnitType getBuildType() {
826826
}
827827

828828
/**
829-
* Retrieves the list of units queued up to be trained.
829+
* Retrieves the list of unit types queued up to be trained.
830830
*
831831
* @return a List<UnitType> containing all the types that are in this factory's training
832832
* queue, from oldest to most recent.
@@ -838,13 +838,19 @@ public List<UnitType> getTrainingQueue() {
838838
return IntStream.range(0, getTrainingQueueCount()).mapToObj(this::getTrainingQueueAt).collect(Collectors.toList());
839839
}
840840

841+
/**
842+
* Retrieves a unit type from a specific index in the queue of units this unit is training.
843+
*/
841844
public UnitType getTrainingQueueAt(int i) {
842845
if (game.isLatComEnabled() && self().trainingQueue[i].valid(game.getFrameCount())) {
843846
return self().trainingQueue[i].get();
844847
}
845848
return UnitType.idToEnum[unitData.getTrainingQueue(i)];
846849
}
847850

851+
/**
852+
* Retrieves the number of units in this unit's training queue.
853+
*/
848854
public int getTrainingQueueCount() {
849855
int count = unitData.getTrainingQueueCount();
850856
if (game.isLatComEnabled() && self().trainingQueueCount.valid(game.getFrameCount())) {

0 commit comments

Comments
 (0)