search

Teardown-Issue-Tracker-Maintainers / Teardown-Issue-Tracker

A public repo for the community to track issues/bugs/feature requests in Teardown.
12 stars 5 forks source link

[Documentation] Missing function descriptions in Scripting API XML #202

Closed CrazyFluffyPony closed 2 years ago

CrazyFluffyPony commented 2 years ago

Document to improve

https://www.teardowngame.com/modding/api.xml

The XML is missing all the descriptions of what each function doesin https://www.teardowngame.com/modding/api.html

Example: GetTime

api.html

image

api.xml

<function name="GetTime">
    <output name="time" type="number" desc="The time in seconds since level was started"/>
</function>

api.xml is missing the whole description Returns running time of this script. If called from update, this returns the simulated time, otherwise it returns wall time.

Enhancement

Include function descriptions in api.xml

tuxedolabs commented 2 years ago

The description can contain tables and other things that wouldn't map well to XML. The XMl is intended for editor highlighting and completion purposes and not full documentation.

CrazyFluffyPony commented 2 years ago

@tuxedolabs so what is the point of having autocompletion, if you always have to look at the website to read the full description (which is required to understand it)? :(