Comments (3)
There already exists an excellent documentation source here: https://airef.github.io/index.html which could probably be used instead.
from aoe2-ai-module.
That is indeed an excellent source of information and would be a waste of resources to duplicate. Although having to do some cross-referencing it should work fairly well for coding with this API. It could use some contributions regarding DE commands.
A few cases that I think should still be documented here:
- Any custom actions and facts that are added by AI Module. Currently there's just "Goals", but in the future I can see "StrategicNumbers" and a few more being added.
- The AI Module might support AoC at some point. The user looking at the API should assume that unless explicitly stated, a function will work on both DE and AoC. A notice should be added to facts and actions that are available only on one or the other.
As for the rest of the facts and actions, documenting them is certainly a very low priority task. Also no more than 1 sentence per message or parameter. Reasons for doing it at all might be for the completeness of the API (seems odd to have only some RPC messages documented) and to eliminate any guesswork regarding return values and parameters (the module modifies how some facts return values, plus there are parameter naming discrepancies compared to airef, it should be fairly obvious though). To alleviate the latter issue, there's also the option to standardize parameter names to airef as much as possible.
from aoe2-ai-module.
In commit 8c54ee7 fact and action parameters were renamed to be more consistent and similar to airef.
from aoe2-ai-module.
Related Issues (12)
- AoC support HOT 1
- Functions HOT 11
- Positional arguments? HOT 1
- GetGoals() and GetStrategicNumbers() for other players
- Remove/change the current anti-cheating protection
- Return time spent in CommandResultList
- Add a way to resolve constants
- Fix actions and facts that contain string type parameters HOT 1
- Document obscure AI commands
- Error in auth_context.h when trying to build HOT 1
- grpc not connecting? HOT 18
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from aoe2-ai-module.