Merge pull request code-dot-org#10283 from code-dot-org/sprite-groups-impl

Add blocks for managing sprite groups

Author: balderdash

apps/i18n/studio/en_us.json

@@ -12,6 +12,7 @@
   "addPoints300": "add 300 points",
   "addPoints1000": "add 1000 points",
   "addPointsTooltip" : "Add points to the score.",
+  "alien": "alien",
   "alienInvasion": "Alien Invasion!",
   "backgroundBlack": "black",
   "backgroundCave": "cave",
@@ -26,6 +27,8 @@
   "backgroundSpace": "space",
   "backgroundTennis": "tennis",
   "backgroundWinter": "winter",
+  "bat": "bat",
+  "bird": "bird",
   "calloutPutCommandsHereRunStart": "Put commands here to have them run when the program starts",
   "calloutBlocklyPlaceGoUpHere": "Place a \"go up\" block here to go up",
   "calloutClickEvents": "Click on the events header to see event function blocks.",
@@ -43,6 +46,7 @@
   "calloutSetDroidAndSpeed": "Set your droid and its speed",
   "calloutFinishButton": "Click here when you are ready to share your game",
   "calloutBlocklyCategories": "You can click on Commands to see all your commands and Events to see all the events",
+  "cat": "cat",
   "catActions": "Actions",
   "catCommands": "Commands",
   "catControl": "Loops",
@@ -52,6 +56,8 @@
   "catProcedures": "Functions",
   "catText": "Text",
   "catVariables": "Variables",
+  "caveboy": "cave boy",
+  "cavegirl": "cave girl",
   "changeScoreTooltip" : "Add or remove a point to the score.",
   "changeScoreTooltipK1" : "Add a point to the score.",
   "tapOrClickToPlay" : "Tap or click to play",
@@ -62,6 +68,9 @@
   "continue": "Continue",
   "decrementPlayerScore" : "remove point",
   "defaultSayText": "type here",
+  "dinosaur": "dinosaur",
+  "dog": "dog",
+  "dragon": "dragon",
   "dropletBlock_addCharacter_description": "Add a character to the scene.",
   "dropletBlock_addCharacter_param0": "type",
   "dropletBlock_addCharacter_param0_description": "The type of the character to be added ('random', 'Stormtrooper', 'RebelPilot', 'PufferPig', 'Mynock', 'MouseDroid', 'Tauntaun', or 'Probot').",
@@ -161,6 +170,7 @@
   "foodFight": "Food fight!",
   "for": "for",
   "getScoreTooltip": "A variable representing the player's score",
+  "ghost": "ghost",
   "goSprite": "go",
   "hello": "hello",
   "helloWorld": "Hello World!",
@@ -237,6 +247,7 @@
   "itemMouseDroid": "Mouse Droid",
   "itemTauntaun": "Tauntaun",
   "itemProbot": "Probot",
+  "knight": "knight",
   "localFunction": "You have placed {funcName} inside another function. You should move {funcName} to a different location in your program.",
   "loseMessage": "You lose!",
   "makeProjectileDisappear": "disappear",
@@ -270,6 +281,7 @@
   "makeProjectileIAProjectile5": "make ice crystal",
   "makeProjectileTooltip": "Make the projectile that just collided disappear or bounce.",
   "makeYourOwn": "Make Your Own Play Lab App",
+  "monster": "monster",
   "moveDirectionDown": "down",
   "moveDirectionLeft": "left",
   "moveDirectionRight": "right",
@@ -304,10 +316,14 @@
   "moveUpRightTooltip": "Move an actor diagonally up and to the right.",
   "moveTooltip": "Move an actor.",
   "nextLevel": "Congratulations! You have completed this puzzle.",
+  "ninja": "masked ninja",
   "no": "No",
   "numBlocksNeeded": "This puzzle can be solved with %1 blocks.",
+  "octopus": "octopus",
   "onEventTooltip": "Execute code in response to the specified event.",
   "ouchExclamation": "Ouch!",
+  "penguin": "penguin",
+  "pirate": "pirate",
   "playSoundCrunch": "play crunch sound",
   "playSoundGoal1": "play goal 1 sound",
   "playSoundGoal2": "play goal 2 sound",
@@ -365,6 +381,7 @@
   "playSoundApplause": "play applause sound",
   "playSoundRandom": "play random sound",
   "points": "points",
+  "princess": "princess",
   "projectileIAProjectile1": "hearts",
   "projectileIAProjectile2": "boulder",
   "projectileIAProjectile3": "ice cube",
@@ -412,6 +429,7 @@
   "repeatForever": "repeat forever",
   "repeatDo": "do",
   "repeatForeverTooltip": "Execute the actions in this block repeatedly while the story is running.",
+  "robot": "robot",
   "spaceInvasion": "Space invasion!",
   "saySprite": "say",
   "saySpriteN": "actor {spriteIndex} say",
@@ -531,6 +549,10 @@
   "setDroidSpeedFast": "set droid to a fast speed",
   "setDroidSpeedTooltip": "Sets the speed of the droid",
   "setEnemySpeed": "set enemy speed",
+  "setEverySpriteNameChaseActor": "set every {spriteName} to chase actor",
+  "setEverySpriteNameFleeActor": "set every {spriteName} to flee actor",
+  "setEverySpriteNameSpeed": "set every {spriteName} speed",
+  "setEverySpriteNameWander": "set every {spriteName} to wander",
   "setItemSpeedSet": "set type",
   "setItemSpeedTooltip": "Sets the speed for a set of characters",
   "setPlayerSpeed": "set player speed",
@@ -611,6 +633,10 @@
   "setSpriteSpeedVeryFast": "to a very fast speed",
   "setSpriteSpeedTooltip": "Sets the speed of an actor",
   "setSpriteZombie": "to a zombie image",
+  "setSpritesChaseTooltip": "Makes all the selected actors chase another actor",
+  "setSpritesFleeTooltip": "Makes all the selected actors flee from another actor",
+  "setSpritesStopTooltip": "Makes all the selected actors stop wandering, chasing, or fleeing",
+  "setSpritesWanderTooltip": "Makes all the selected actors wander around the screen at random",
   "setMap": "set map",
   "setMapRandom": "set random map",
   "setMapBlank": "set blank map",
@@ -639,6 +665,8 @@
   "setDroidC3PO": "to C-3PO",
   "setSprite": "set",
   "setSpriteN": "set actor {spriteIndex}",
+  "soccerboy": "soccer boy",
+  "soccergirl": "soccer girl",
   "soundCrunch": "crunch",
   "soundGoal1": "goal 1",
   "soundGoal2": "goal 2",
@@ -652,17 +680,24 @@
   "soundWinPoint2": "win point 2",
   "soundWood": "wood",
   "soundRandom": "random",
+  "spacebot": "spacebot",
   "speed": "speed",
+  "squirrel": "squirrel",
   "startSetValue": "start (function)",
   "startSetVars": "game_vars (title, subtitle, background, target, danger, player)",
   "startSetFuncs": "game_funcs (update-target, update-danger, update-player, collide?, on-screen?)",
+  "stopEverySpriteName": "stop every {spriteName}",
   "stopSprite": "stop",
   "stopSpriteN": "stop actor {spriteIndex}",
   "stopTooltip": "Stops an actor's movement.",
+  "tennisboy": "tennis boy",
+  "tennisgirl": "tennis girl",
   "throwSprite": "throw",
   "throwSpriteN": "actor {spriteIndex} throw",
   "throwTooltip": "Throws a projectile from the specified actor.",
   "toSet": "to set",
+  "toWander": "to wander",
+  "unicorn": "unicorn",
   "vanish": "vanish",
   "vanishActorN": "vanish actor {spriteIndex}",
   "vanishTooltip": "Vanishes the actor.",
@@ -761,7 +796,10 @@
   "whenUp": "when up arrow",
   "whenUpTooltip": "Execute the actions below when the up arrow key is pressed.",
   "winMessage": "You win!",
+  "witch": "witch",
+  "wizard": "wizard",
   "yes": "Yes",
+  "zombie": "zombie",
   "failedHasSetSprite": "Next time, set a droid.",
   "failedHassetDroidSpeed": "Next time, set a droid speed.",
   "failedHasSetBackground": "Next time, set the background.",

apps/src/studio/Item.js

@@ -44,6 +44,7 @@ export default class Item extends Collidable {
     this.displayDir = Direction.SOUTH;
     this.startFadeTime = null;
     this.fadeTime = constants.ITEM_FADE_TIME;
+    this.targetSpriteIndex = 0;
 
     /** @private {StudioAnimation} */
     this.animation_ = new StudioAnimation(Object.assign({}, options, {
@@ -150,21 +151,30 @@ export default class Item extends Collidable {
     // Has the item reached its destination grid position?
     // (There is a small margin of error to allow for per-update movements greater
     // than a single pixel.)
-    var speed = valueOr(this.speed, 0);
-    if (this.destGridX !== undefined &&
-        (Math.abs(this.x - (this.destGridX * Studio.SQUARE_SIZE + Studio.HALF_SQUARE)) <= speed &&
-         Math.abs(this.y - (this.destGridY * Studio.SQUARE_SIZE + Studio.HALF_SQUARE)) <= speed)) {
-      this.gridX = this.destGridX;
-      this.gridY = this.destGridY;
-      reachedDestinationGridPosition = true;
+    if (this.destGridX !== undefined) {
+      var speed = valueOr(this.speed, 0);
+      var dirUnit = Direction.getUnitVector(this.dir);
+      var center = this.getCenterPos();
+      var destVector = {
+        x: (this.destGridX * Studio.SQUARE_SIZE + Studio.HALF_SQUARE) - center.x,
+        y: (this.destGridY * Studio.SQUARE_SIZE + Studio.HALF_SQUARE) - center.y
+      };
+      // Take the dot product of dirUnit and destVector to see if continuing to
+      // move in that direction will bring the item any closer to its
+      // destination.
+      if (dirUnit.x * destVector.x + dirUnit.y * destVector.y <= speed) {
+        this.gridX = this.destGridX;
+        this.gridY = this.destGridY;
+        reachedDestinationGridPosition = true;
+      }
     }
 
     // Are we missing a destination location in grid coords?
     // Or have we already reached our prior destination location in grid coords?
     // If not, determine it.
     if (this.destGridX === undefined || reachedDestinationGridPosition) {
 
-      var sprite = Studio.sprite[0];
+      var sprite = Studio.sprite[this.targetSpriteIndex];
 
       var spriteX = sprite.x + sprite.width/2;
       var spriteY = sprite.y + sprite.height/2;
@@ -233,10 +243,7 @@ export default class Item extends Collidable {
       // cull candidates that won't be possible
       for (var i = candidates.length-1; i >= 0; i--) {
         var candidate = candidates[i];
-        var atEdge = candidate.gridX < 0 || candidate.gridX >= Studio.COLS ||
-                     candidate.gridY < 0 || candidate.gridY >= Studio.ROWS;
-        var hasWall = !atEdge && Studio.getWallValue(candidate.gridY, candidate.gridX);
-        if (atEdge || hasWall || candidate.score === 0) {
+        if (candidate.score === 0 || this.atEdge(candidate) || this.hasWall(candidate)) {
           candidates.splice(i, 1);
         }
       }
@@ -277,6 +284,15 @@ export default class Item extends Collidable {
     }
   }
 
+  atEdge(candidate) {
+    return candidate.gridX < 0 || candidate.gridX >= Studio.COLS ||
+        candidate.gridY < 0 || candidate.gridY >= Studio.ROWS;
+  }
+
+  hasWall(candidate) {
+    return Studio.getWallValue(candidate.gridY, candidate.gridX);
+  }
+
   /**
    * Isolated update logic for "watchActor" activity where the "item" keeps
    * turning to look at the actor with the given sprite index.
@@ -309,9 +325,13 @@ export default class Item extends Collidable {
   /**
    * Sets the activity property for this item.
    * @param {string} type Valid options are: none, watchActor, roam, chase, or flee
+   * @param {number} targetSpriteIndex optional target sprite used with chase and flee
    */
-  setActivity(type) {
+  setActivity(type, targetSpriteIndex) {
     this.activity = type;
+    if (targetSpriteIndex !== undefined) {
+      this.targetSpriteIndex = targetSpriteIndex;
+    }
   }
 
   /**
@@ -389,6 +409,13 @@ export default class Item extends Collidable {
         Studio.tickCount);
   }
 
+  getCenterPos() {
+    return {
+      x: this.x,
+      y: this.y,
+    };
+  }
+
   getNextPosition() {
     var unit = Direction.getUnitVector(this.dir);
     var speed = this.speed;

apps/src/studio/Sprite.js

@@ -1,5 +1,5 @@
 import * as constants from './constants';
-import Collidable from './collidable';
+import Item from './Item';
 import StudioAnimation from './StudioAnimation';
 import StudioSpriteSheet from './StudioSpriteSheet';
 import { valueOr } from '../utils';
@@ -10,11 +10,11 @@ const Emotions = constants.Emotions;
 const NextTurn = constants.NextTurn;
 
 /**
- * A Sprite is a type of Collidable.
+ * A Sprite is a type of Item.
  * Note: x/y represent x/y of center in gridspace
- * @extends {Collidable}
+ * @extends {Item}
  */
-export default class Sprite extends Collidable {
+export default class Sprite extends Item {
   constructor(options) {
     // call collidable constructor
     super(options);
@@ -310,10 +310,8 @@ export default class Sprite extends Collidable {
   /**
    * This function should be called every frame, and moves the sprite around.
    */
-
-  // TODO (cpirich): ensure that update is called for Sprite object
-
   update() {
+    super.update();
 
     // Draw the sprite's current location.
     Studio.drawDebugRect("spriteCenter", this.x, this.y, 3, 3);
@@ -452,6 +450,15 @@ export default class Sprite extends Collidable {
     this.lastDrawPosition = drawPosition;
   }
 
+  // TODO(ram): make x and y props consistent with Item. In sprites they
+  // represent the top left corner, in items they're the center.
+  getCenterPos() {
+    return {
+      x: this.x + this.width / 2,
+      y: this.y + this.height / 2,
+    };
+  }
+
   getNextPosition() {
     var unit = Direction.getUnitVector(this.dir);
     var speed = this.speed;
@@ -527,4 +534,18 @@ export default class Sprite extends Collidable {
       this.legacyAnimation_.setOpacity(newOpacity);
     }
   }
+
+  atEdge(candidate) {
+    return candidate.gridX < 0 ||
+        (candidate.gridX * Studio.SQUARE_SIZE + this.width) > Studio.MAZE_WIDTH ||
+        candidate.gridY < 0 ||
+        (candidate.gridY * Studio.SQUARE_SIZE + this.height) > Studio.MAZE_HEIGHT;
+  }
+
+  hasWall(candidate) {
+    return Studio.willSpriteTouchWall(
+        this,
+        candidate.gridX * Studio.SQUARE_SIZE,
+        candidate.gridY * Studio.SQUARE_SIZE);
+  }
 }

apps/src/studio/api.js

@@ -99,6 +99,39 @@ exports.setSpriteXY = function (id, spriteIndex, xpos, ypos) {
   });
 };
 
+exports.setSpritesWander = function (id, spriteName) {
+  Studio.queueCmd(id, 'setSpritesWander', {
+    'spriteName': spriteName
+  });
+};
+
+exports.setSpritesStop = function (id, spriteName) {
+  Studio.queueCmd(id, 'setSpritesStop', {
+    'spriteName': spriteName
+  });
+};
+
+exports.setSpritesChase = function (id, targetSpriteIndex, spriteName) {
+  Studio.queueCmd(id, 'setSpritesChase', {
+    'spriteName': spriteName,
+    'targetSpriteIndex': targetSpriteIndex,
+  });
+};
+
+exports.setSpritesFlee = function (id, targetSpriteIndex, spriteName) {
+  Studio.queueCmd(id, 'setSpritesFlee', {
+    'spriteName': spriteName,
+    'targetSpriteIndex': targetSpriteIndex,
+  });
+};
+
+exports.setSpritesSpeed = function (id, speed, spriteName) {
+  Studio.queueCmd(id, 'setSpritesSpeed', {
+    'spriteName': spriteName,
+    'speed': speed,
+  });
+};
+
 exports.addGoal = function (id, value) {
   Studio.queueCmd(id, 'addGoal', {
     'value': Number(value)