Adds respawning handler for agents - MUST UPDATE OLD ENV-SPECS

minerl/Malmo/Minecraft/src/main/java/com/microsoft/Malmo/MissionHandlers/AgentQuitFromDeathImplementation.java

@@ -0,0 +1,76 @@
+// --------------------------------------------------------------------------------------------------
+//  Copyright (c) 2016 Microsoft Corporation
+//  
+//  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+//  associated documentation files (the "Software"), to deal in the Software without restriction,
+//  including without limitation the rights to use, copy, modify, merge, publish, distribute,
+//  sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//  
+//  The above copyright notice and this permission notice shall be included in all copies or
+//  substantial portions of the Software.
+//  
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+//  NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+//  DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+// --------------------------------------------------------------------------------------------------
+
+package com.microsoft.Malmo.MissionHandlers;
+
+import com.microsoft.Malmo.MissionHandlerInterfaces.IWantToQuit;
+import com.microsoft.Malmo.Schemas.AgentQuitFromTimeUp;
+import com.microsoft.Malmo.Schemas.MissionInit;
+import net.minecraft.client.Minecraft;
+import net.minecraft.util.DamageSource;
+import net.minecraft.util.text.Style;
+import net.minecraft.util.text.TextComponentString;
+import net.minecraft.util.text.TextFormatting;
+import net.minecraftforge.common.ForgeHooks;
+import net.minecraftforge.event.entity.living.LivingDeathEvent;
+import net.minecraftforge.fml.common.eventhandler.EventPriority;
+import net.minecraftforge.fml.common.eventhandler.SubscribeEvent;
+import net.minecraftforge.fml.common.gameevent.TickEvent;
+
+/**
+ * IWantToQuit object that returns true when an agent dies.
+ * Also records the reason for death.
+ */
+
+public class AgentQuitFromDeathImplementation extends HandlerBase implements IWantToQuit
+{
+	private String quitCode = "";
+	private DamageSource deathSource = null;
+
+
+	@Override
+	public boolean parseParameters(Object params)
+	{
+		return true;
+	}
+
+
+	@SubscribeEvent(priority = EventPriority.LOWEST)
+	public void onClientTick(LivingDeathEvent event)
+	{
+		// Use the client tick to ensure we regularly update our state (from the client thread)
+		this.deathSource = event.getSource();
+		// TODO this could have a lot more info here about who killed the agent, location, ect.
+		this.quitCode = this.deathSource.getDamageType();
+	}
+
+	@Override
+	public boolean doIWantToQuit(MissionInit missionInit) {
+		return Minecraft.getMinecraft().player.isDead;
+	}
+
+	@Override
+    public void prepare(MissionInit missionInit) {}
+
+	@Override
+    public void cleanup() {}
+
+	@Override
+	public String getOutcome() { return this.quitCode; }
+}

minerl/Malmo/Minecraft/src/main/java/com/microsoft/Malmo/MissionHandlers/ServerQuitFromDeathImplementation.java

@@ -0,0 +1,66 @@
+// --------------------------------------------------------------------------------------------------
+//  Copyright (c) 2016 Microsoft Corporation
+//  
+//  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+//  associated documentation files (the "Software"), to deal in the Software without restriction,
+//  including without limitation the rights to use, copy, modify, merge, publish, distribute,
+//  sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//  
+//  The above copyright notice and this permission notice shall be included in all copies or
+//  substantial portions of the Software.
+//  
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+//  NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+//  DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+// --------------------------------------------------------------------------------------------------
+
+package com.microsoft.Malmo.MissionHandlers;
+
+import com.microsoft.Malmo.MissionHandlerInterfaces.IWantToQuit;
+import com.microsoft.Malmo.Schemas.ServerQuitFromDeath;
+import com.microsoft.Malmo.Schemas.MissionInit;
+import net.minecraft.client.Minecraft;
+import net.minecraft.entity.player.EntityPlayerMP;
+
+import java.util.Objects;
+
+/**
+ * IWantToQuit object that returns true when an agent dies.
+ * Also records the reason for death.
+ */
+
+public class ServerQuitFromDeathImplementation extends AgentQuitFromDeathImplementation implements IWantToQuit
+{
+	private ServerQuitFromDeath params = null;
+	private Boolean quitWhenAnyDead = true;
+
+	@Override
+	public boolean parseParameters(Object params) {
+		if (!(params instanceof ServerQuitFromDeath))
+			return false;
+
+		this.params = (ServerQuitFromDeath) params;
+		this.quitWhenAnyDead = this.params.isQuitWhenAnyDead();
+		return true;
+	}
+
+
+	@Override
+	public boolean doIWantToQuit(MissionInit missionInit) {
+		for (EntityPlayerMP playerMP : Objects.requireNonNull(Minecraft.getMinecraft().getIntegratedServer()).getPlayerList().playerEntityList) {
+			if (this.quitWhenAnyDead == playerMP.isDead)
+					return this.quitWhenAnyDead;
+		}
+		return !this.quitWhenAnyDead;
+	}
+
+	@Override
+    public void prepare(MissionInit missionInit) {}
+
+	@Override
+    public void cleanup() {}
+
+}

minerl/Malmo/Minecraft/src/main/java/com/microsoft/Malmo/Mixins/MixinMinecraftGameloop.java

@@ -78,12 +78,12 @@ public abstract class MixinMinecraftGameloop {
     @Shadow public Snooper usageSnooper;
     @Shadow public abstract int getLimitFramerate();
     @Shadow public abstract boolean isFramerateLimitBelowMax();
-    
-    @Shadow public boolean inGameHasFocus; 
+
+    @Shadow public boolean inGameHasFocus;
     @Shadow private int leftClickCounter; 
 
     @Shadow public abstract void displayGuiScreen(GuiScreen guiScreen);
-    
+
     private  int numTicksPassed = 0;
 
 
@@ -268,14 +268,14 @@ private void runGameLoop() throws IOException
 
         this.mcProfiler.endSection(); //root
     }
-    
+
     @Overwrite
     public void setIngameFocus()
     {
         if (!this.inGameHasFocus) {
             this.inGameHasFocus = true;
             this.displayGuiScreen((GuiScreen) null);
-            this.leftClickCounter = 10000;
+            this.leftClickCounter = 0;
         }
     }
 

minerl/Malmo/Schemas/Mission.xsd

@@ -496,6 +496,7 @@
             <!-- When adding a new command handler, make sure to update MissionSpec::getListOfCommandHandlers and MissionSpec::getAllowedCommands, and add to TurnBasedApplicableCommandHandlers (below) if appropriate -->
 
             <xs:element ref="AgentQuitFromTimeUp" minOccurs="0"/>
+            <xs:element ref="AgentQuitFromDeath" minOccurs="0"/>
             <xs:element ref="AgentQuitFromReachingPosition" minOccurs="0"/>
             <xs:element ref="AgentQuitFromTouchingBlockType" minOccurs="0"/>
             <xs:element ref="AgentQuitFromCollectingItem" minOccurs="0"/>
@@ -580,6 +581,7 @@
                         </xs:appinfo>
                     </xs:annotation>
                     <xs:element ref="ServerQuitFromTimeUp"/>
+                    <xs:element ref="ServerQuitFromDeath"/>
                     <xs:element ref="ServerQuitWhenAnyAgentFinishes"/>
                 </xs:choice>
             </xs:sequence>

minerl/Malmo/Schemas/MissionHandlers.xsd

@@ -1255,6 +1255,17 @@
         </xs:complexType>
     </xs:element>
 
+    <xs:element name="ServerQuitFromDeath">
+        <xs:annotation>
+            <xs:documentation>
+                Specifies a time limit that applies to all agents.
+            </xs:documentation>
+        </xs:annotation>
+        <xs:complexType>
+            <xs:attribute name="quitWhenAnyDead" type="xs:boolean" use="optional" default="false"/>
+        </xs:complexType>
+    </xs:element>
+
     <xs:element name="ServerQuitWhenAnyAgentFinishes">
         <xs:annotation>
             <xs:documentation>
@@ -3109,6 +3120,15 @@
         </xs:complexType>
     </xs:element>
 
+    <xs:element name="AgentQuitFromDeath">
+        <xs:annotation>
+            <xs:documentation>
+                Allows the agent to quit on death. If not specified, agents will respawn per vanilla spawn mechanics.
+                Sets the quit code of the agent based on how the agent died, e.g. "lava", "cactus", "flyIntoWall"
+            </xs:documentation>
+        </xs:annotation>
+    </xs:element>
+
     <xs:element name="AgentQuitFromTouchingBlockType">
         <xs:annotation>
             <xs:documentation>

minerl/herobraine/hero/handlers/agent/quit.py

@@ -28,6 +28,17 @@ def __init__(self, blocks: List[str]):
         self.blocks = blocks
 
 
+#  <AgentQuitFromDeath/>
+class AgentQuitFromDeath(Handler):
+    def to_string(self) -> str:
+        return "agent_quit_from_death"
+
+    def xml_template(self) -> str:
+        return str(
+            """<AgentQuitFromDeath/>"""
+        )
+
+
 # <AgentQuitFromCraftingItem>
 #     <Item type="iron_pickaxe"/>
 #     <Item type="wooden_axe"/>

minerl/herobraine/hero/handlers/server/quit.py

@@ -25,6 +25,23 @@ def __init__(self, time_limit_ms: int, description="out_of_time"):
         self.time_limit_ms = time_limit_ms
         self.description = description
 
+class ServerQuitFromDeath(Handler):
+    """ Forces the server to quit after a certain time_limit_ms
+    also specifies a description parameter for the xml."""
+
+    def to_string(self) -> str:
+        return "server_quit_from_death"
+
+    def xml_template(self) -> str:
+        return str(
+            """<ServerQuitFromTimeUp 
+                    quitWhenAnyDead="{{quit_when_any_agent_dies}}"/>
+            """
+        )
+
+    def __init__(self, quit_when_any_agent_dies: bool):
+        self.quit_when_any_agent_dies = quit_when_any_agent_dies
+
 
 class ServerQuitWhenAnyAgentFinishes(Handler):
     """ Forces the server to quit if any of the agents involved quits.

scripts/test_build_deploy.sh

@@ -19,7 +19,7 @@ mkdir -p $MINERL_DATA_ROOT
 pip install -e .
 #az storage copy -s $AZ_MINERL_DATA -d $MINERL_DATA_ROOT --recursive --subscription sci
 
-pytest .
+pytest . -n 2
 pip uninstall -y minerl
 
 pip list