sb-edit/lib/Block.d.ts

Import, edit, and export Scratch project files

import * as BlockInput from "./BlockInput";
import { OpCode } from "./OpCode";
type DefaultInput<T extends BlockInput.Any = BlockInput.Any> = T extends BlockInput.Any ? {
    type: Readonly<T["type"]>;
    initial: Readonly<T["value"]>;
} : never;
export declare class BlockBase<MyOpCode extends OpCode, MyInputs extends {
    [key: string]: BlockInput.Any;
}> {
    static getDefaultInput(opcode: KnownBlock["opcode"], input: string): DefaultInput | void;
    static isKnownBlock(opcode: OpCode): opcode is KnownBlock["opcode"];
    id: string;
    opcode: MyOpCode;
    inputs: MyInputs;
    parent: string | null;
    next: string | null;
    constructor(options: {
        id?: string;
        opcode: MyOpCode;
        inputs: MyInputs;
        parent?: string;
        next?: string;
    });
    getDefaultInput(input: string): DefaultInput | void;
    isKnownBlock(): this is KnownBlock;
    get blocks(): Block[];
    get isHat(): boolean;
}
export type MotionBlock = BlockBase<OpCode.motion_movesteps, {
    STEPS: BlockInput.Number;
}> | BlockBase<OpCode.motion_turnright, {
    DEGREES: BlockInput.Number;
}> | BlockBase<OpCode.motion_turnleft, {
    DEGREES: BlockInput.Number;
}> | BlockBase<OpCode.motion_goto, {
    TO: BlockInput.GoToTarget;
}> | BlockBase<OpCode.motion_gotoxy, {
    X: BlockInput.Number;
    Y: BlockInput.Number;
}> | BlockBase<OpCode.motion_glideto, {
    SECS: BlockInput.Number;
    TO: BlockInput.GoToTarget;
}> | BlockBase<OpCode.motion_glidesecstoxy, {
    SECS: BlockInput.Number;
    X: BlockInput.Number;
    Y: BlockInput.Number;
}> | BlockBase<OpCode.motion_pointindirection, {
    DIRECTION: BlockInput.Angle;
}> | BlockBase<OpCode.motion_pointtowards, {
    TOWARDS: BlockInput.PointTowardsTarget;
}> | BlockBase<OpCode.motion_changexby, {
    DX: BlockInput.Number;
}> | BlockBase<OpCode.motion_setx, {
    X: BlockInput.Number;
}> | BlockBase<OpCode.motion_changeyby, {
    DY: BlockInput.Number;
}> | BlockBase<OpCode.motion_sety, {
    Y: BlockInput.Number;
}> | BlockBase<OpCode.motion_ifonedgebounce, {}> | BlockBase<OpCode.motion_setrotationstyle, {
    STYLE: BlockInput.RotationStyle;
}> | BlockBase<OpCode.motion_xposition, {}> | BlockBase<OpCode.motion_yposition, {}> | BlockBase<OpCode.motion_direction, {}> | BlockBase<OpCode.motion_scroll_right, {
    DISTANCE: BlockInput.Number;
}> | BlockBase<OpCode.motion_scroll_up, {
    DISTANCE: BlockInput.Number;
}> | BlockBase<OpCode.motion_align_scene, {
    ALIGNMENT: BlockInput.ScrollAlignment;
}>;
export type LooksBlock = BlockBase<OpCode.looks_sayforsecs, {
    MESSAGE: BlockInput.String;
    SECS: BlockInput.Number;
}> | BlockBase<OpCode.looks_say, {
    MESSAGE: BlockInput.String;
}> | BlockBase<OpCode.looks_thinkforsecs, {
    MESSAGE: BlockInput.String;
    SECS: BlockInput.Number;
}> | BlockBase<OpCode.looks_think, {
    MESSAGE: BlockInput.String;
}> | BlockBase<OpCode.looks_switchcostumeto, {
    COSTUME: BlockInput.Costume;
}> | BlockBase<OpCode.looks_nextcostume, {}> | BlockBase<OpCode.looks_switchbackdropto, {
    BACKDROP: BlockInput.Backdrop;
}> | BlockBase<OpCode.looks_nextbackdrop, {}> | BlockBase<OpCode.looks_changesizeby, {
    CHANGE: BlockInput.Number;
}> | BlockBase<OpCode.looks_setsizeto, {
    SIZE: BlockInput.Number;
}> | BlockBase<OpCode.looks_changeeffectby, {
    EFFECT: BlockInput.GraphicEffect;
    CHANGE: BlockInput.Number;
}> | BlockBase<OpCode.looks_seteffectto, {
    EFFECT: BlockInput.GraphicEffect;
    VALUE: BlockInput.Number;
}> | BlockBase<OpCode.looks_cleargraphiceffects, {}> | BlockBase<OpCode.looks_show, {}> | BlockBase<OpCode.looks_hide, {}> | BlockBase<OpCode.looks_gotofrontback, {
    FRONT_BACK: BlockInput.FrontBackMenu;
}> | BlockBase<OpCode.looks_goforwardbackwardlayers, {
    NUM: BlockInput.Number;
    FORWARD_BACKWARD: BlockInput.ForwardBackwardMenu;
}> | BlockBase<OpCode.looks_costumenumbername, {
    NUMBER_NAME: BlockInput.CostumeNumberName;
}> | BlockBase<OpCode.looks_backdropnumbername, {
    NUMBER_NAME: BlockInput.CostumeNumberName;
}> | BlockBase<OpCode.looks_size, {}> | BlockBase<OpCode.looks_hideallsprites, {}> | BlockBase<OpCode.looks_switchbackdroptoandwait, {
    BACKDROP: BlockInput.Backdrop;
}> | BlockBase<OpCode.looks_changestretchby, {
    CHANGE: BlockInput.Number;
}> | BlockBase<OpCode.looks_setstretchto, {
    STRETCH: BlockInput.Number;
}>;
export type SoundBlock = BlockBase<OpCode.sound_playuntildone, {
    SOUND_MENU: BlockInput.Sound;
}> | BlockBase<OpCode.sound_play, {
    SOUND_MENU: BlockInput.Sound;
}> | BlockBase<OpCode.sound_stopallsounds, {}> | BlockBase<OpCode.sound_changeeffectby, {
    VALUE: BlockInput.Number;
    EFFECT: BlockInput.SoundEffect;
}> | BlockBase<OpCode.sound_seteffectto, {
    VALUE: BlockInput.Number;
    EFFECT: BlockInput.SoundEffect;
}> | BlockBase<OpCode.sound_cleareffects, {}> | BlockBase<OpCode.sound_changevolumeby, {
    VOLUME: BlockInput.Number;
}> | BlockBase<OpCode.sound_setvolumeto, {
    VOLUME: BlockInput.Number;
}> | BlockBase<OpCode.sound_volume, {}>;
export type EventBlock = BlockBase<OpCode.event_whenflagclicked, {}> | BlockBase<OpCode.event_whenkeypressed, {
    KEY_OPTION: BlockInput.Key;
}> | BlockBase<OpCode.event_whenthisspriteclicked, {}> | BlockBase<OpCode.event_whenstageclicked, {}> | BlockBase<OpCode.event_whenbackdropswitchesto, {
    BACKDROP: BlockInput.Backdrop;
}> | BlockBase<OpCode.event_whengreaterthan, {
    VALUE: BlockInput.Number;
    WHENGREATERTHANMENU: BlockInput.GreaterThanMenu;
}> | BlockBase<OpCode.event_whenbroadcastreceived, {
    BROADCAST_OPTION: BlockInput.Broadcast;
}> | BlockBase<OpCode.event_broadcast, {
    BROADCAST_INPUT: BlockInput.Broadcast;
}> | BlockBase<OpCode.event_broadcastandwait, {
    BROADCAST_INPUT: BlockInput.Broadcast;
}>;
export type ControlBlock = BlockBase<OpCode.control_wait, {
    DURATION: BlockInput.Number;
}> | BlockBase<OpCode.control_repeat, {
    TIMES: BlockInput.Number;
    SUBSTACK: BlockInput.Blocks;
}> | BlockBase<OpCode.control_forever, {
    SUBSTACK: BlockInput.Blocks;
}> | BlockBase<OpCode.control_if, {
    CONDITION: BlockInput.Boolean;
    SUBSTACK: BlockInput.Blocks;
}> | BlockBase<OpCode.control_if_else, {
    CONDITION: BlockInput.Boolean;
    SUBSTACK: BlockInput.Blocks;
    SUBSTACK2: BlockInput.Blocks;
}> | BlockBase<OpCode.control_wait_until, {
    CONDITION: BlockInput.Boolean;
}> | BlockBase<OpCode.control_repeat_until, {
    CONDITION: BlockInput.Boolean;
    SUBSTACK: BlockInput.Blocks;
}> | BlockBase<OpCode.control_stop, {
    STOP_OPTION: BlockInput.StopMenu;
}> | BlockBase<OpCode.control_start_as_clone, {}> | BlockBase<OpCode.control_create_clone_of, {
    CLONE_OPTION: BlockInput.CloneTarget;
}> | BlockBase<OpCode.control_delete_this_clone, {}> | BlockBase<OpCode.control_all_at_once, {
    SUBSTACK: BlockInput.Blocks;
}> | BlockBase<OpCode.control_for_each, {
    VARIABLE: BlockInput.Variable;
    VALUE: BlockInput.Number;
    SUBSTACK: BlockInput.Blocks;
}> | BlockBase<OpCode.control_while, {
    CONDITION: BlockInput.Boolean;
    SUBSTACK: BlockInput.Blocks;
}>;
export type SensingBlock = BlockBase<OpCode.sensing_touchingobject, {
    TOUCHINGOBJECTMENU: BlockInput.TouchingTarget;
}> | BlockBase<OpCode.sensing_touchingcolor, {
    COLOR: BlockInput.Color;
}> | BlockBase<OpCode.sensing_coloristouchingcolor, {
    COLOR: BlockInput.Color;
    COLOR2: BlockInput.Color;
}> | BlockBase<OpCode.sensing_distanceto, {
    DISTANCETOMENU: BlockInput.DistanceToMenu;
}> | BlockBase<OpCode.sensing_askandwait, {
    QUESTION: BlockInput.String;
}> | BlockBase<OpCode.sensing_answer, {}> | BlockBase<OpCode.sensing_keypressed, {
    KEY_OPTION: BlockInput.Key;
}> | BlockBase<OpCode.sensing_mousedown, {}> | BlockBase<OpCode.sensing_mousex, {}> | BlockBase<OpCode.sensing_mousey, {}> | BlockBase<OpCode.sensing_setdragmode, {
    DRAG_MODE: BlockInput.DragModeMenu;
}> | BlockBase<OpCode.sensing_loudness, {}> | BlockBase<OpCode.sensing_loud, {}> | BlockBase<OpCode.sensing_timer, {}> | BlockBase<OpCode.sensing_resettimer, {}> | BlockBase<OpCode.sensing_of, {
    OBJECT: BlockInput.Target;
    PROPERTY: BlockInput.PropertyOfMenu;
}> | BlockBase<OpCode.sensing_current, {
    CURRENTMENU: BlockInput.CurrentMenu;
}> | BlockBase<OpCode.sensing_dayssince2000, {}> | BlockBase<OpCode.sensing_username, {}> | BlockBase<OpCode.sensing_userid, {}>;
export type OperatorBlock = BlockBase<OpCode.operator_add, {
    NUM1: BlockInput.Number;
    NUM2: BlockInput.Number;
}> | BlockBase<OpCode.operator_subtract, {
    NUM1: BlockInput.Number;
    NUM2: BlockInput.Number;
}> | BlockBase<OpCode.operator_multiply, {
    NUM1: BlockInput.Number;
    NUM2: BlockInput.Number;
}> | BlockBase<OpCode.operator_divide, {
    NUM1: BlockInput.Number;
    NUM2: BlockInput.Number;
}> | BlockBase<OpCode.operator_random, {
    FROM: BlockInput.Number;
    TO: BlockInput.Number;
}> | BlockBase<OpCode.operator_gt, {
    OPERAND1: BlockInput.Number;
    OPERAND2: BlockInput.Number;
}> | BlockBase<OpCode.operator_lt, {
    OPERAND1: BlockInput.Number;
    OPERAND2: BlockInput.Number;
}> | BlockBase<OpCode.operator_equals, {
    OPERAND1: BlockInput.Number;
    OPERAND2: BlockInput.Number;
}> | BlockBase<OpCode.operator_and, {
    OPERAND1: BlockInput.Boolean;
    OPERAND2: BlockInput.Boolean;
}> | BlockBase<OpCode.operator_or, {
    OPERAND1: BlockInput.Boolean;
    OPERAND2: BlockInput.Boolean;
}> | BlockBase<OpCode.operator_not, {
    OPERAND: BlockInput.Boolean;
}> | BlockBase<OpCode.operator_join, {
    STRING1: BlockInput.String;
    STRING2: BlockInput.String;
}> | BlockBase<OpCode.operator_letter_of, {
    LETTER: BlockInput.Number;
    STRING: BlockInput.String;
}> | BlockBase<OpCode.operator_length, {
    STRING: BlockInput.String;
}> | BlockBase<OpCode.operator_contains, {
    STRING1: BlockInput.String;
    STRING2: BlockInput.String;
}> | BlockBase<OpCode.operator_mod, {
    NUM1: BlockInput.Number;
    NUM2: BlockInput.Number;
}> | BlockBase<OpCode.operator_round, {
    NUM: BlockInput.Number;
}> | BlockBase<OpCode.operator_mathop, {
    OPERATOR: BlockInput.MathopMenu;
    NUM: BlockInput.Number;
}>;
export type DataBlock = BlockBase<OpCode.data_variable, {
    VARIABLE: BlockInput.Variable;
}> | BlockBase<OpCode.data_setvariableto, {
    VARIABLE: BlockInput.Variable;
    VALUE: BlockInput.String;
}> | BlockBase<OpCode.data_changevariableby, {
    VARIABLE: BlockInput.Variable;
    VALUE: BlockInput.Number;
}> | BlockBase<OpCode.data_showvariable, {
    VARIABLE: BlockInput.Variable;
}> | BlockBase<OpCode.data_hidevariable, {
    VARIABLE: BlockInput.Variable;
}> | BlockBase<OpCode.data_listcontents, {
    LIST: BlockInput.List;
}> | BlockBase<OpCode.data_addtolist, {
    LIST: BlockInput.List;
    ITEM: BlockInput.String;
}> | BlockBase<OpCode.data_deleteoflist, {
    LIST: BlockInput.List;
    INDEX: BlockInput.Number;
}> | BlockBase<OpCode.data_deletealloflist, {
    LIST: BlockInput.List;
}> | BlockBase<OpCode.data_insertatlist, {
    LIST: BlockInput.List;
    INDEX: BlockInput.Number;
    ITEM: BlockInput.String;
}> | BlockBase<OpCode.data_replaceitemoflist, {
    LIST: BlockInput.List;
    INDEX: BlockInput.Number;
    ITEM: BlockInput.String;
}> | BlockBase<OpCode.data_itemoflist, {
    LIST: BlockInput.List;
    INDEX: BlockInput.Number;
}> | BlockBase<OpCode.data_itemnumoflist, {
    LIST: BlockInput.List;
    ITEM: BlockInput.String;
}> | BlockBase<OpCode.data_lengthoflist, {
    LIST: BlockInput.List;
}> | BlockBase<OpCode.data_listcontainsitem, {
    LIST: BlockInput.List;
    ITEM: BlockInput.String;
}> | BlockBase<OpCode.data_showlist, {
    LIST: BlockInput.List;
}> | BlockBase<OpCode.data_hidelist, {
    LIST: BlockInput.List;
}>;
export type ProcedureBlock = BlockBase<OpCode.procedures_definition, {
    PROCCODE: BlockInput.String;
    ARGUMENTS: BlockInput.CustomBlockArguments;
    WARP: BlockInput.Boolean;
}> | BlockBase<OpCode.procedures_call, {
    PROCCODE: BlockInput.String;
    INPUTS: BlockInput.CustomBlockInputValues;
}>;
export type ArgumentBlock = BlockBase<OpCode.argument_reporter_string_number, {
    VALUE: BlockInput.String;
}> | BlockBase<OpCode.argument_reporter_boolean, {
    VALUE: BlockInput.String;
}>;
export type CustomBlock = ProcedureBlock | ArgumentBlock;
export type MusicBlock = BlockBase<OpCode.music_playDrumForBeats, {
    DRUM: BlockInput.MusicDrum;
    BEATS: BlockInput.Number;
}> | BlockBase<OpCode.music_restForBeats, {
    BEATS: BlockInput.Number;
}> | BlockBase<OpCode.music_playNoteForBeats, {
    NOTE: BlockInput.MusicInstrument;
    BEATS: BlockInput.Number;
}> | BlockBase<OpCode.music_setInstrument, {
    INSTRUMENT: BlockInput.Number;
}> | BlockBase<OpCode.music_setTempo, {
    TEMPO: BlockInput.Number;
}> | BlockBase<OpCode.music_changeTempo, {
    TEMPO: BlockInput.Number;
}> | BlockBase<OpCode.music_getTempo, {}> | BlockBase<OpCode.music_midiPlayDrumForBeats, {
    DRUM: BlockInput.Number;
    BEATS: BlockInput.Number;
}> | BlockBase<OpCode.music_midiSetInstrument, {
    INSTRUMENT: BlockInput.Number;
}>;
export type PenBlock = BlockBase<OpCode.pen_clear, {}> | BlockBase<OpCode.pen_stamp, {}> | BlockBase<OpCode.pen_penDown, {}> | BlockBase<OpCode.pen_penUp, {}> | BlockBase<OpCode.pen_setPenColorToColor, {
    COLOR: BlockInput.Color;
}> | BlockBase<OpCode.pen_changePenColorParamBy, {
    COLOR_PARAM: BlockInput.PenColorParam;
    VALUE: BlockInput.Number;
}> | BlockBase<OpCode.pen_setPenColorParamTo, {
    COLOR_PARAM: BlockInput.PenColorParam;
    VALUE: BlockInput.Number;
}> | BlockBase<OpCode.pen_changePenSizeBy, {
    SIZE: BlockInput.Number;
}> | BlockBase<OpCode.pen_setPenSizeTo, {
    SIZE: BlockInput.Number;
}> | BlockBase<OpCode.pen_setPenShadeToNumber, {
    SHADE: BlockInput.Number;
}> | BlockBase<OpCode.pen_changePenShadeBy, {
    SHADE: BlockInput.Number;
}> | BlockBase<OpCode.pen_setPenHueToNumber, {
    HUE: BlockInput.Number;
}> | BlockBase<OpCode.pen_changePenHueBy, {
    HUE: BlockInput.Number;
}>;
export type VideoSensingBlock = BlockBase<OpCode.videoSensing_whenMotionGreaterThan, {
    REFERENCE: BlockInput.Number;
}> | BlockBase<OpCode.videoSensing_videoOn, {
    ATTRIBUTE: BlockInput.VideoSensingAttribute;
    SUBJECT: BlockInput.VideoSensingSubject;
}> | BlockBase<OpCode.videoSensing_videoToggle, {
    VIDEO_STATE: BlockInput.VideoSensingVideoState;
}> | BlockBase<OpCode.videoSensing_setVideoTransparency, {
    TRANSPARENCY: BlockInput.Number;
}>;
export type WeDo2Block = BlockBase<OpCode.wedo2_motorOnFor, {
    MOTOR_ID: BlockInput.WeDo2MotorId;
    DURATION: BlockInput.Number;
}> | BlockBase<OpCode.wedo2_motorOn, {
    MOTOR_ID: BlockInput.WeDo2MotorId;
}> | BlockBase<OpCode.wedo2_motorOff, {
    MOTOR_ID: BlockInput.WeDo2MotorId;
}> | BlockBase<OpCode.wedo2_startMotorPower, {
    MOTOR_ID: BlockInput.WeDo2MotorId;
    POWER: BlockInput.Number;
}> | BlockBase<OpCode.wedo2_setMotorDirection, {
    MOTOR_ID: BlockInput.WeDo2MotorId;
    MOTOR_DIRECTION: BlockInput.WeDo2MotorDirection;
}> | BlockBase<OpCode.wedo2_setLightHue, {
    HUE: BlockInput.Number;
}> | BlockBase<OpCode.wedo2_whenDistance, {
    OP: BlockInput.WeDo2Op;
    REFERENCE: BlockInput.Number;
}> | BlockBase<OpCode.wedo2_whenTilted, {
    TILT_DIRECTION_ANY: BlockInput.WeDo2TiltDirectionAny;
}> | BlockBase<OpCode.wedo2_getDistance, {}> | BlockBase<OpCode.wedo2_isTilted, {
    TILT_DIRECTION_ANY: BlockInput.WeDo2TiltDirectionAny;
}> | BlockBase<OpCode.wedo2_getTiltAngle, {
    TILT_DIRECTION: BlockInput.WeDo2TiltDirection;
}> | BlockBase<OpCode.wedo2_playNoteFor, {
    NOTE: BlockInput.Number;
    Duration: BlockInput.Number;
}>;
export type ExtensionBlock = MusicBlock | PenBlock | VideoSensingBlock | WeDo2Block;
export type KnownBlock = MotionBlock | LooksBlock | SoundBlock | EventBlock | ControlBlock | SensingBlock | OperatorBlock | DataBlock | CustomBlock | ExtensionBlock;
export type UnknownBlock = BlockBase<Exclude<OpCode, KnownBlock["opcode"]>, {
    [key: string]: BlockInput.Any;
}>;
export type Block = KnownBlock | UnknownBlock;
export default Block;