mirror of
https://github.com/scratchfoundation/scratch-vm.git
synced 2024-12-25 15:32:40 -05:00
61 lines
3 KiB
JavaScript
61 lines
3 KiB
JavaScript
|
/**
|
||
|
|
* @typedef {object} ExtensionMetadata
|
||
|
|
* All the metadata needed to register an extension.
|
||
|
|
* @property {string} id - a unique alphanumeric identifier for this extension. No special characters allowed.
|
||
|
|
* @property {string} name - the human-readable name of this extension.
|
||
|
|
* @property {string} blockIconURI - URI for an image to be placed on each block in this extension. Data URI ok.
|
||
|
|
* @property {string} menuIconURI - URI for an image to be placed on this extension's category menu entry. Data URI ok.
|
||
|
|
* @property {string} docsURI - link to documentation content for this extension.
|
||
|
|
* @property {Array.<ExtensionBlockMetadata|string>} - the blocks provided by this extension, with optional separators.
|
||
|
|
* @property {Object.<ExtensionMenuMetadata>} - map of menu name to metadata about each of this extension's menus.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {object} ExtensionBlockMetadata
|
||
|
|
* All the metadata needed to register an extension block.
|
||
|
|
* @property {string} opcode - a unique alphanumeric identifier for this block. No special characters allowed.
|
||
|
|
* @property {BlockType} blockType - the type of block (command, reporter, etc.) being described.
|
||
|
|
* @property {string} func - the name of the function implementing this block. Can be shared with other blocks/opcodes.
|
||
|
|
* @property {Boolean} hideFromPalette - true if this block should not appear in the block palette.
|
||
|
|
* @property {ReporterScope} reporterScope - if this block is a reporter, this is the scope/context for its value.
|
||
|
|
* @property {Boolean} terminal - true if the block ends a stack - no blocks can be connected after it.
|
||
|
|
* @property {string} text - the text on the block, with [PLACEHOLDERS] for arguments.
|
||
|
|
* @property {Object.<ExtensionArgumentMetadata>} arguments - map of argument placeholder to metadata about each arg.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {object} ExtensionArgumentMetadata
|
||
|
|
* All the metadata needed to register an argument for an extension block.
|
||
|
|
* @property {ArgumentType} type - the type of the argument (number, string, etc.)
|
||
|
|
* @property {*} defaultValue - the default value of this argument.
|
||
|
|
* @property {string} menu - the name of the menu to use for this argument, if any.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {ExtensionDynamicMenu|ExtensionMenuItems} ExtensionMenuMetadata
|
||
|
|
* All the metadata needed to register an extension drop-down menu.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {string} ExtensionDynamicMenu
|
||
|
|
* The string name of a function which returns menu items.
|
||
|
|
* @see {ExtensionMenuItems} - the type of data expected to be returned by the specified function.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {Array.<ExtensionMenuItemSimple|ExtensionMenuItemComplex>} ExtensionMenuItems
|
||
|
|
* Items in an extension menu.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {string} ExtensionMenuItemSimple
|
||
|
|
* A menu item for which the label and value are identical strings.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {object} ExtensionMenuItemComplex
|
||
|
|
* A menu item for which the label and value can differ.
|
||
|
|
* @property {*} value - the value of the block argument when this menu item is selected.
|
||
|
|
* @property {string} text - the human-readable label of this menu item in the menu.
|
||
|
|
*/
|