scratch-vm/src/blocks/scratch3_control.js

var Cast = require('../util/cast');
var Promise = require('promise');

function Scratch3ControlBlocks(runtime) {
    /**
     * The runtime instantiating this block package.
     * @type {Runtime}
     */
    this.runtime = runtime;
}

/**
 * Retrieve the block primitives implemented by this package.
 * @return {Object.<string, Function>} Mapping of opcode to Function.
 */
Scratch3ControlBlocks.prototype.getPrimitives = function() {
    return {
        'control_repeat': this.repeat,
        'control_repeat_until': this.repeatUntil,
        'control_forever': this.forever,
        'control_wait': this.wait,
        'control_wait_until': this.waitUntil,
        'control_if': this.if,
        'control_if_else': this.ifElse,
        'control_stop': this.stop,
        'control_create_clone_of_menu': this.createCloneMenu,
        'control_create_clone_of': this.createClone,
        'control_delete_this_clone': this.deleteClone
    };
};

Scratch3ControlBlocks.prototype.getHats = function () {
    return {
        'control_start_as_clone': {
            restartExistingThreads: false
        }
    };
};

Scratch3ControlBlocks.prototype.repeat = function(args, util) {
    var times = Math.floor(Cast.toNumber(args.TIMES));
    // Initialize loop
    if (util.stackFrame.loopCounter === undefined) {
        util.stackFrame.loopCounter = times;
    }
    // Only execute once per frame.
    // When the branch finishes, `repeat` will be executed again and
    // the second branch will be taken, yielding for the rest of the frame.
    if (!util.stackFrame.executedInFrame) {
        util.stackFrame.executedInFrame = true;
        // Decrease counter
        util.stackFrame.loopCounter--;
        // If we still have some left, start the branch.
        if (util.stackFrame.loopCounter >= 0) {
            util.startBranch();
        }
    } else {
        util.stackFrame.executedInFrame = false;
        util.yieldFrame();
    }
};

Scratch3ControlBlocks.prototype.repeatUntil = function(args, util) {
    var condition = Cast.toBoolean(args.CONDITION);
    // Only execute once per frame.
    // When the branch finishes, `repeat` will be executed again and
    // the second branch will be taken, yielding for the rest of the frame.
    if (!util.stackFrame.executedInFrame) {
        util.stackFrame.executedInFrame = true;
        // If the condition is true, start the branch.
        if (!condition) {
            util.startBranch();
        }
    } else {
        util.stackFrame.executedInFrame = false;
        util.yieldFrame();
    }
};

Scratch3ControlBlocks.prototype.waitUntil = function(args, util) {
    var condition = Cast.toBoolean(args.CONDITION);
    // Only execute once per frame.
    if (!condition) {
        util.yieldFrame();
    }
};

Scratch3ControlBlocks.prototype.forever = function(args, util) {
    // Only execute once per frame.
    // When the branch finishes, `forever` will be executed again and
    // the second branch will be taken, yielding for the rest of the frame.
    if (!util.stackFrame.executedInFrame) {
        util.stackFrame.executedInFrame = true;
        util.startBranch();
    } else {
        util.stackFrame.executedInFrame = false;
        util.yieldFrame();
    }
};

Scratch3ControlBlocks.prototype.wait = function(args) {
    var duration = Cast.toNumber(args.DURATION);
    return new Promise(function(resolve) {
        setTimeout(function() {
            resolve();
        }, 1000 * duration);
    });
};

Scratch3ControlBlocks.prototype.if = function(args, util) {
    var condition = Cast.toBoolean(args.CONDITION);
    // Only execute one time. `if` will be returned to
    // when the branch finishes, but it shouldn't execute again.
    if (util.stackFrame.executedInFrame === undefined) {
        util.stackFrame.executedInFrame = true;
        if (condition) {
            util.startBranch();
        }
    }
};

Scratch3ControlBlocks.prototype.ifElse = function(args, util) {
    var condition = Cast.toBoolean(args.CONDITION);
    // Only execute one time. `ifElse` will be returned to
    // when the branch finishes, but it shouldn't execute again.
    if (util.stackFrame.executedInFrame === undefined) {
        util.stackFrame.executedInFrame = true;
        if (condition) {
            util.startBranch(1);
        } else {
            util.startBranch(2);
        }
    }
};

Scratch3ControlBlocks.prototype.stop = function(args, util) {
    var option = args.STOP_OPTION;
    if (option == 'all') {
        util.stopAll();
    } else if (option == 'other scripts in sprite' ||
        option == 'other scripts in stage') {
        util.stopOtherTargetThreads();
    } else if (option == 'this script') {
        util.stopThread();
    }
};

// @todo (GH-146): remove.
Scratch3ControlBlocks.prototype.createCloneMenu = function (args) {
    return args.CLONE_OPTION;
};

Scratch3ControlBlocks.prototype.createClone = function (args, util) {
    var cloneTarget;
    if (args.CLONE_OPTION == '_myself_') {
        cloneTarget = util.target;
    } else {
        cloneTarget = this.runtime.getSpriteTargetByName(args.CLONE_OPTION);
    }
    if (!cloneTarget) {
        return;
    }
    var newClone = cloneTarget.makeClone();
    if (newClone) {
        this.runtime.targets.push(newClone);
    }
};

Scratch3ControlBlocks.prototype.deleteClone = function (args, util) {
    if (util.target.isOriginal) return;
    this.runtime.disposeTarget(util.target);
    this.runtime.stopForTarget(util.target);
};

module.exports = Scratch3ControlBlocks;