Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

get_hit_params and get_dig_params aren't in lua_api.txt. #6372

Closed
HybridDog opened this issue Sep 3, 2017 · 4 comments
Closed

get_hit_params and get_dig_params aren't in lua_api.txt. #6372

HybridDog opened this issue Sep 3, 2017 · 4 comments
Labels
Bug Issues that were confirmed to be a bug @ Documentation good first issue

Comments

@HybridDog
Copy link
Contributor

HybridDog commented Sep 3, 2017

get_hit_params and get_dig_params aren't in lua_api.txt.

@SmallJoker SmallJoker added @ Documentation Bug Issues that were confirmed to be a bug labels Sep 3, 2017
@thetaepsilon-gamedev
Copy link

I would like to tack onto this by saying that while get_dig_params() is not yet documented, I intend to make use of this in the pipeworks mod.
Documentation in lua_api.txt would be useful to serve as a marker to consider it public API that is used by a mod, if only in case (admittedly unlikely) it is removed because it is considered "unused".

@HybridDog
Copy link
Contributor Author

HybridDog commented Oct 15, 2017

Before documenting it, the time_from_last_punch parameter should vanish: a9d1f5b#diff-b2e9183274c47c49c500e499eacd627eL134
It looks like something once used for anticheat calculations, now unused.

Edit: thanks for merging that. Now it can be documented

@paramat paramat added the Request / Suggestion The issue makes a suggestion for something that should be done but isn't a new feature. label Oct 15, 2017
@sfan5 sfan5 added good first issue and removed Request / Suggestion The issue makes a suggestion for something that should be done but isn't a new feature. labels Nov 15, 2017
@paramat
Copy link
Contributor

paramat commented Jan 13, 2018

#6906 merged, partially fixes this.

@paramat paramat changed the title automatic_rotate has wrong documentation automatic_rotate has wrong documentation. get_hit_params and get_dig_params aren't in lua_api.txt. Jan 13, 2018
@HybridDog HybridDog changed the title automatic_rotate has wrong documentation. get_hit_params and get_dig_params aren't in lua_api.txt. get_hit_params and get_dig_params aren't in lua_api.txt. Jan 13, 2018
@paramat
Copy link
Contributor

paramat commented Feb 19, 2019

1875194

@paramat paramat closed this as completed Feb 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Issues that were confirmed to be a bug @ Documentation good first issue
Projects
None yet
Development

No branches or pull requests

5 participants