bryab / tba-types Goto Github PK

Add definitions for Storyboard Pro, and identify any objects that are shared between Harmony and Storyboard Pro, and move those to the shared definition file.

I did not yet attempt to actually parse the QTScript 4 documentation into Typescript definitions. I added a few as needed.

https://docs.toonboom.com/help/harmony-20/premium/release-notes/harmony/harmony-20-release-notes.html#_ljnfuqqhhgur

It's not always practical to use Typescript in production (for example, making modifications to existing scripts). But you can utilize these type definitions in VS Code using normal Javascript.

This involves creating a jsconfig.json and pointing at the correct type definition file for your DCC.

https://docs.toonboom.com/help/storyboard-pro-7/storyboard/release-notes/storyboard-pro-7-0-2-release-notes.html
https://docs.toonboom.com/help/storyboard-pro-7/storyboard/release-notes/storyboard-pro-7-0-1-release-notes.html
https://docs.toonboom.com/help/storyboard-pro-7/storyboard/release-notes/storyboard-pro-7-release-notes.html#Scriptin

https://docs.toonboom.com/help/storyboard-pro-7/storyboard/scripting/reference/index.html

Hey Bryan,

Thanks for this awesome project! I'd love to use this for a project I'm working on but I didn't see any examples of how to use with TBA. Any chance you could upload an example script showing how this can be used in TBA?

I can't hope to have an exhaustive and complete definition of the entire Qt4 API but I'd like to at least improve it.

Some examples of missing Qt classes are in this file:

https://github.com/diegogarciahuerta/tk-harmony/blob/master/resources/packages/ShotgunBridge/configure.js

https://docs.toonboom.com/help/harmony-20/scripting/extended/index.html
https://docs.toonboom.com/help/harmony-21/scripting/extended/index.html
https://docs.toonboom.com/help/harmony-22/scripting/extended/index.html

More API to parse here and add to the type definitions, including PythonManager.

https://docs.toonboom.com/help/storyboard-pro-20/storyboard/release-notes/storyboard-pro-20-release-notes.html