lep / jassdoc

Document the WarCraft 3 API
52 stars 20 forks source link

Add notes to Point and Build order functions #117

Closed WaterKnight closed 1 year ago

WaterKnight commented 1 year ago

Please re-check and reflect on the interpretation.

I marked BlzQueueBuildOrderById returning true as a note instead of a bug because enqueuing build orders without having the resources for the structure is actually allowed. But it should not be allowed as the first order, so it's debatable if BlzQueueBuildOrderById should return false in that case if the queue was empty.

Luashine commented 1 year ago

so it's debatable if BlzQueueBuildOrderById should return false in that case if the queue was empty.

This seems similar to how UseItem... orders work like UnitDropItemSlot. There are some very basic checks but otherwise if an order can be submitted into the queue, it will report success with true disregarding if the action will actually fail immediately after for whatever reason.

If the return value was egregiously wrong I would put it down as bug but otherwise a @note or a general description should be OK.

Looks good :+1: