Wick Javascript Object Model documentation

Help
#1

Brief introduction: I’ve recently started to code Wick animations, as a beginner. Used to be a programmer few decades ago…

I visited the “learn” part of the Web site, which helped me to get started.
However, often, understanding the whole logic, or what property to use to reach a given goal, is rather challenging. For example:

.subClipInMainClip.activeFrame._children[0].fillColor

is _children[] documented somewhere?

or (thanks to a recent reply in this forum):

project.activeFrame.clips.forEach(etc.)

Is it documented somewhere that clips is a property of a frame?
Etc.

More generally, is there a comprehensive documentation of Wick’s object model?

Thank you.

1 Like
#2

I think you could ask @noobfield or @StickmanRed or one of the moderators to better assist want you require, although their timezones are different so I am not sure if they are active right now.

#3

(post withdrawn by author, will be automatically deleted in 24 hours unless flagged)

#4

Here are good ones I’ve used https://forum.wickeditor.com/t/more-wick-docs/3396 and https://github.com/Wicklets/wick-editor-2018/blob/master/HOWTO.md

#5

For the second one scroll down for what you want everything above it is for making art/animation

#6

Hey! I know the “Goods” you’re looking for, I brewed them:

Basically, Wick’s Code is in JavaScript, the Web’s programming language. In it’s code, there’s a special type of comment:

/*
 * Adds `a` with `b`.
 * @param {number} a - Number first to add
 * @param {number} b - Second to add.
*/
function plus(a, b) {
  return a + b
}

These are documentations, this specific type is JSDoc. It’s really easy, and battle-tested. It has a tool on NPM (Node Package Manager, Node is a way to run JS on the server.) to make JS files from it. I used the config that already comes in Wick’s engine.

In it, there’s docs at the class level, allowing for us to see really cool stuff and functions, like today I discovered there’s a raycasting tool in Wick.

#7

Thank you all for your replies, very helpful!

#8

Thank you @noobfield for this link. Bottom-up approach, from code to doc. More technical, but indeed very comprehensive.

#9

@LapisLazuli, I don’t know what you’re working on, but feel free to share .WICK or .HTML files.

How to do that:

For .WICK files:

  • go to editor:
  • press “SAVE”

For .HTML files:

  • go to editor
  • press “EXPORT”
  • click on Interactive
  • Press “Export HTML”

image
image

After that, make a message or a post, and drag the HTML or WICK file into the typing box.

#10

Hi @noobfield,

Sure, it is in my plan to share what I did. A good way to say “thank you” for the help! :slight_smile:

I just want to take the time to anonymize it, as it is in a business context, and give some explanations along with the sharing.

Stay tuned…