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

Provide method documentation for the unit class #19

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

jejanim
Copy link
Contributor

@jejanim jejanim commented Oct 26, 2020

Still work-in-progress...

I'm not an expert on those functions or the editor fields in general but I consulted the following references:

@cipherxof
Copy link
Owner

You may also want to look at https://github.com/lep/jassdoc

Maybe a script could be made to automate the docs from there, although there may be some slight API differences with the wrappers.

@jejanim
Copy link
Contributor Author

jejanim commented Oct 27, 2020

Thanks for the reference, I will see what I can do.

@jejanim
Copy link
Contributor Author

jejanim commented Nov 7, 2020

I found a duplicate function that might be there to prevent breaking changes, not sure. Care to keep it?

  public hideAbility(abilId: number, flag: boolean) {
    BlzUnitHideAbility(this.handle, abilId, flag);
  }

(the third param (hideUI) is unused but I think it's more descriptive than flag and could replace it)

 public disableAbility(abilId: number, flag: boolean, hideUI: boolean) {
    BlzUnitHideAbility(this.handle, abilId, flag);
  }

@cipherxof
Copy link
Owner

I found a duplicate function that might be there to prevent breaking changes, not sure. Care to keep it?

Fixed da1febb

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants