w3ts icon indicating copy to clipboard operation
w3ts copied to clipboard

Provide method documentation for the unit class

Open jejanim opened this issue 5 years ago • 4 comments

Still work-in-progress...

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

  • https://world-editor-tutorials.thehelper.net/uniteditor.php#break10
  • http://www.wc3c.net/showthread.php?t=17723

jejanim avatar Oct 26 '20 13:10 jejanim

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.

cipherxof avatar Oct 26 '20 19:10 cipherxof

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

jejanim avatar Oct 27 '20 08:10 jejanim

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);
  }

jejanim avatar Nov 07 '20 16:11 jejanim

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

Fixed https://github.com/cipherxof/w3ts/commit/da1febbfb265a61567a1c44ab63b118a70784f47

cipherxof avatar Nov 24 '20 00:11 cipherxof