Better Documentation

[GoogleCodeExporter]

Better documentation would be nice.  For example, define what a queue is and 
that you can only send one command to a unit in one frame (and sometimes have 
to wait multiple frames before you can issue another command), for instance: 
Stop then Build is not allowed even if you would think it should be.

Original issue reported on code.google.com by pawngam...@gmail.com on 20 Aug 2012 at 9:02

[GoogleCodeExporter]

Queue is Starcraft's command queue (should be in Starcraft manual). Build 
commands can't be queued. Generally if the actual Unit->command doesn't have an 
isQueued parameter it can't be queued.

But yes documentation is one thing that is slowly being worked on. Requests for 
clarifications will be used to make better documentation and possibly example 
code.

Original comment by AHeinerm on 21 Aug 2012 at 1:32

• Changed state: Accepted

[GoogleCodeExporter]

I have the following queries, some of which were answered in IRC - maybe they 
could be covered in the documentation for this issue?
1. Can some UnitCommandType's like Cloak/Decloak and Set_Rally_Position & 
Set_Rally_Unit be issued the same frame as issuing a different command to the 
same unit (e.g. Move for a ghost, or Train for a barracks)?  Paraphrasing 
<@Heinermann>: yes. Like cloak and nuke for a ghost. Or maybe cloak and move.
2. What other unit commands can be done multiple times for the same unit for 
the same frame?  E.g. cancelTrain() then train()?  Can train() be done multiple 
times in the same frame for the same production building?
3. Can the rightClick unit command do anything that none of the other unit 
commands can do, or is it just for convenience? Does it execute faster? 
Paraphrasing <@Heinermann>: it's convenient. It's there for completion, and 
uses 1 less byte I believe (in a replay).

Original comment by chris.c...@gmail.com on 24 Aug 2012 at 7:10

[GoogleCodeExporter]

Update on my point 3: Actually, right-click can be used to make a worker return 
cargo to a specific resource collection centre (rather than the nearest one) 
then continue gathering.  This is actually the behavior of Starcraft itself 
(it's nothing to do with BWAPI).  I suppose you could consider this a sequence 
of commands though (albeit a more complicated sequence of commands).

Original comment by chris.c...@gmail.com on 2 Sep 2012 at 10:21

[GoogleCodeExporter]

Original comment by AHeinerm on 29 Apr 2013 at 12:18

• Changed state: Started
• Added labels: Milestone-Release

[GoogleCodeExporter]

The BWAPI project is slowly undergoing the migration to GitHub. All issues have 
been migrated to the GitHub issue tracker located here: 
https://github.com/bwapi/bwapi/issues

In order to receive updates on your issue, please head over to the GitHub issue 
tracker and subscribe to your issue.

Original comment by AHeinerm on 15 Apr 2014 at 7:46

• Changed state: Migrated