Javascript API documentation

[cybersphinx]

Made the buildbot generate the current javascript docs of master (which should cover 3.1 as well).
One page: http://buildbot.wz2100.net/files/javasc ... cript.html
Multi page table of contents: http://buildbot.wz2100.net/files/javasc ... index.html

[aubergine]

@cybersphinx - AWESOME WIN! Great work!

When referencing things like structures.txt, rules.js, scavfact.js, features.txt, is there any way they could be hyperlinked to github so we can view those online too? Would be much easier than having to trawl through base.wz and mp.wz looking for them (as I'm never quite sure where some of those files exist).

[Per]

Added:
* chat(target, message), for sending chat messages. chat may be ALL_PLAYERS or ALLIES or a specific player number
* orderDroid(droid, order), with new orders DORDER_STOP, DORDER_HOLD, DORDER_RTR, DORDER_RTB
* DORDER_FIRESUPPORT
* DORDER_REARM, and it may be used both with orderDroid() and orderDroidObj()
* enumGateways(), gives array of objects with x1, y1, x2, y2 properties
* .hasIndirect property for droids, if any weapons are indirect (eg artillery)

Fixed .armed and .range properties. The .group and .armed properties are now null instead of undefined if not applicable.

All of this is for 3.2 only at the moment.

[NoQ]

sending chat messages

All right, but we also need to receive chat messages! (:

[aubergine]

Woot! Great to see more stuff being added

enumGateways()? What are gateways?

[NoQ]

What are gateways?

Gateways are special invisible marks on the map that hint AIs to build hardpoints on them. They are painted by the map maker (of course, some map makers are lazy enough to paint them). Each gateway is a line segment of adjacent map tiles. Nexus AI fills the whole line with best hardpoints available, except two middle tiles (any two middle tiles in case gateway has odd length); i guess any AI should do the same. Picture.

[NoQ]

In order to build hardpoints on gateways, i'd like to be able to find out if a certain tile of a gateway is already occupied by a (friendly) structure. So that not to block things. Of course, i could make this check manually (cycle through all structures, guess its dimensions based on stattype and/or name, etc.), but it's a lot of pain.

That is, i'd like to have something like isBuildable(x,y) that will return true iff the tile (x,y) is passable (neither cliff nor water) and not occupied by any building or feature (tiles near a research center are considered to be occupied, but tiles near factory aren't).

[aubergine]

I'd like a whatsAt(x,y) function that returns:

* terrain type
* z-index
* continent
* any droids/structures/features at that point

[Per]

All right, but we also need to receive chat messages! (:

Right. Added eventChat(from, to, message) for receiving chat messages. I think it will handle network messages, as in the case of non-host players being allied to an AI and wanting to message it, but this has not been properly tested yet. (No, this is not trivial. The message code is FUBAR.)

[NoQ]

Excellent! Beacons is the thing i want the most now.

Also, in the latest git, whatever AI said is displayed as if the host said this (displayed as NoQ: ...) (it was a skirmish game) (eventChat also thinks that me == NoQ) (this wasn't there some time ago when eventChat wasn't present)

[aubergine]

Ability for AI to place beacons as well - that would be v. useful as it would allow AIs to indicate to allies locations on the map.

[NoQ]

I'd like to have DORDER_OBSERVE, so that i could use mobile sensors to pick targets for long-range artillery. Neither DORDER_ATTACK nor DORDER_SCOUT seem to do the job.

[aubergine]

Can't you just pass the numeric id of that order in to orderDroidObj?

[NoQ]

Didn't try yet; just though that to ask is better than to hack (:

[NoQ]

I think it's a good idea to 1. make this thread sticky and 2. separate wzscript discussions into a subforum (: