turbowarp / types Goto Github PK

• They added a method to stop the frame loop
• Scratch Link-related changes

https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/scratch-env/index.d.ts

https://github.com/LLK/scratch-vm/blob/develop/docs/extensions.md

https://github.com/TurboWarp/extensions/tree/master/types

• vm._editingTarget
• updateSVGSkin rotation center argument optional?
• document getSpriteTargetByName never returns stage sprite
• link target.sprite.name and target.getName() ?
• document what updateSvgSkin updateBitmapSkin etc. do when skin is wrong type (reskin)
• tw: SOUND and COSTUME arguments
• tw: packaged runtime mode? document what it actually means
• tw: costume.asset, sound.asset can be null if packaged runtime

I'm not sure if these types belong in this or not, because while it's not technically a library, it is used by library in methods like this, but it would be helpful if this library contained types for the project.json object in SB3 files.

If you're happy to add these types, I just wrote some simple ones for my project here that shouldn't be difficult to copy and paste over to here. I will eventually be adding types for each opcode individually to get rid of the records in ProjectSB3BlockBase, but that could be a while.

In my opinion, it's kind of strange that these typing as they are right now only allow you to use the layer groups that scratch uses. As the comment in the enum says:

  const enum LayerGroup {
    // The renderer can be configured to use any strings as group names, but these are the groups
    // that scratch-vm uses, listed in order.
    Background = 'background',
    Video = 'video',
    Pen = 'pen',
    Sprite = 'sprite'
  }

What you name your layer groups is really a decision made by consumers of the scratch-renderer library and shouldn't be arbitrarily enforced by these typings. Because of this odd restriction, things like the playground example which come directly from scratch-render repo will not compile without casting or changing the layer group name to one of the four prescribed by the enum above.

I think this should be changed, but I though I'd create an issue because it seems to be a very deliberate decision and I was curious to hear your thoughts.

I found in the scratch-vm repository that RenderedTarget.setXY() emits TARGET_MOVED and EVENT_TARGET_VISUAL_CHANGE:

https://github.com/LLK/scratch-vm/blob/33a2c30e7a83a356b02567c17b0a6da6815c7b1b/src/sprites/rendered-target.js#L266-L287

And I found this TODO:

code:

const myCat = vm.runtime.getSpriteTargetByName('Cat');
console.log(myCat.sprite);

log:

Sprite {
  runtime: Runtime {},
  blocks: Blocks {},
  name: 'Cat',
  costumes_: [],
  sounds: [],
  clones: [],
  soundBank: null
}

But Sprite interface isn't have clones and soundBank properties:

they are constructors not instances

For extensions you can't use the scratch extension vm with import Scratch from 'scratch-vm-extension'; as it isn't used in index.d.ts.

just a quick note as right now you can't use the types for extensions.
(if I'm just stupid and missed something, please tell me)

import Anina R Cross (others?) in costume library