Skip to content

Commit 08d77a1

Browse files
committed
Documented the novelty of the new training queue accessors.
1 parent 226b179 commit 08d77a1

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/main/java/bwapi/Unit.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -840,6 +840,9 @@ public List<UnitType> getTrainingQueue() {
840840

841841
/**
842842
* Retrieves a unit type from a specific index in the queue of units this unit is training.
843+
*
844+
* This method does not have a direct analog in the BWAPI client API.
845+
* It exists as a more performant alternative to getTrainingQueue().
843846
*/
844847
public UnitType getTrainingQueueAt(int i) {
845848
if (game.isLatComEnabled() && self().trainingQueue[i].valid(game.getFrameCount())) {
@@ -850,6 +853,9 @@ public UnitType getTrainingQueueAt(int i) {
850853

851854
/**
852855
* Retrieves the number of units in this unit's training queue.
856+
*
857+
* This method does not have a direct analog in the BWAPI client API.
858+
* It exists as a more performant alternative to getTrainingQueue().
853859
*/
854860
public int getTrainingQueueCount() {
855861
int count = unitData.getTrainingQueueCount();

0 commit comments

Comments
 (0)