// --------------------------------------------------------------------------------------------------
//  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.Server;

import java.lang.reflect.Field;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Random;
import java.util.UUID;

import javax.xml.bind.JAXBElement;
import javax.xml.bind.JAXBException;

import net.minecraft.client.Minecraft;
import net.minecraft.entity.EntityList;
import net.minecraft.entity.EntityLivingBase;
import net.minecraft.entity.SharedMonsterAttributes;
import net.minecraft.entity.ai.attributes.AttributeModifier;
import net.minecraft.entity.ai.attributes.IAttributeInstance;
import net.minecraft.entity.player.EntityPlayerMP;
import net.minecraft.item.ItemStack;
import net.minecraft.launchwrapper.Launch;
import net.minecraft.server.MinecraftServer;
import net.minecraft.server.management.PlayerList;
import net.minecraft.util.FoodStats;
import net.minecraft.util.math.BlockPos;
import net.minecraft.util.math.Vec3d;
import net.minecraft.util.text.TextComponentString;
import net.minecraft.util.text.TextFormatting;
import net.minecraft.world.GameType;
import net.minecraft.world.World;
import net.minecraft.world.WorldServer;
import net.minecraft.world.biome.Biome.SpawnListEntry;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.entity.living.LivingSpawnEvent.CheckSpawn;
import net.minecraftforge.event.world.WorldEvent.PotentialSpawns;
import net.minecraftforge.event.entity.player.PlayerEvent.BreakSpeed;
import net.minecraftforge.fml.common.FMLCommonHandler;
import net.minecraftforge.fml.common.eventhandler.Event.Result;
import net.minecraftforge.fml.common.eventhandler.SubscribeEvent;
import net.minecraftforge.fml.common.gameevent.TickEvent;
import net.minecraftforge.fml.common.gameevent.TickEvent.Phase;
import net.minecraftforge.fml.common.gameevent.TickEvent.ServerTickEvent;

import com.microsoft.Malmo.IState;
import com.microsoft.Malmo.MalmoMod;
import com.microsoft.Malmo.MalmoMod.IMalmoMessageListener;
import com.microsoft.Malmo.MalmoMod.MalmoMessageType;
import com.microsoft.Malmo.StateEpisode;
import com.microsoft.Malmo.StateMachine;
import com.microsoft.Malmo.MissionHandlerInterfaces.IWorldDecorator.DecoratorException;
import com.microsoft.Malmo.MissionHandlers.MissionBehaviour;
import com.microsoft.Malmo.Schemas.AgentSection;
import com.microsoft.Malmo.Schemas.AgentStart.EnderBoxInventory;
import com.microsoft.Malmo.Schemas.AgentStart.Inventory;
import com.microsoft.Malmo.Schemas.AgentStart.*;
import com.microsoft.Malmo.Schemas.DrawItem;
import com.microsoft.Malmo.Schemas.EntityTypes;
import com.microsoft.Malmo.Schemas.InventoryObjectType;
import com.microsoft.Malmo.Schemas.MissionInit;
import com.microsoft.Malmo.Schemas.ModSettings;
import com.microsoft.Malmo.Schemas.PosAndDirection;
import com.microsoft.Malmo.Schemas.ServerInitialConditions;
import com.microsoft.Malmo.Schemas.ServerSection;
import com.microsoft.Malmo.Utils.EnvironmentHelper;
import com.microsoft.Malmo.Utils.MinecraftTypeHelper;
import com.microsoft.Malmo.Utils.SchemaHelper;
import com.microsoft.Malmo.Utils.ScreenHelper;
import com.microsoft.Malmo.Utils.SeedHelper;
import com.microsoft.Malmo.Utils.TimeHelper;

/**
 * Class designed to track and control the state of the mod, especially regarding mission launching/running.<br>
 * States are defined by the MissionState enum, and control is handled by MissionStateEpisode subclasses.
 * The ability to set the state directly is restricted, but hooks such as onPlayerReadyForMission etc are exposed to allow
 * subclasses to react to certain state changes.<br>
 * The ProjectMalmo mod app class inherits from this and uses these hooks to run missions.
 */
public class ServerStateMachine extends StateMachine
{
    private MissionInit currentMissionInit = null;   	// The MissionInit object for the mission currently being loaded/run.
    private MissionInit queuedMissionInit = null;		// The MissionInit requested from elsewhere - dormant episode will check for its presence.
    private MissionBehaviour missionHandlers = null;	// The Mission handlers for the mission currently being loaded/run.
    protected String quitCode = "";						// Code detailing the reason for quitting this mission.
    
    // agentConnectionWatchList is used to keep track of the clients in a multi-agent mission. If, at any point, a username appears in
    // this list, but can't be found in the MinecraftServer.getServer().getAllUsernames(), that constitutes an error, and the mission will exit.
    private ArrayList<String> userConnectionWatchList = new ArrayList<String>();
    private ArrayList<String> userTurnSchedule = new ArrayList<String>();

    protected void clearUserConnectionWatchList()
    {
        this.userConnectionWatchList.clear();
    }
    
    protected void clearUserTurnSchedule()
    {
        this.userTurnSchedule.clear();
    }

    protected String getNextAgentInTurnSchedule(String currentAgent)
    {
        int i = this.userTurnSchedule.indexOf(currentAgent);
        if (i < 0)
            return null;    // Big problem!
        i += 1;
        return this.userTurnSchedule.get(i % this.userTurnSchedule.size());
    }

    protected void removeFromTurnSchedule(String agent)
    {
        this.userTurnSchedule.remove(agent);    // Does nothing if the agent wasn't in the list to begin with.
    }

    protected void addUsernameToWatchList(String username)
    {
        this.userConnectionWatchList.add(username); // Must be username, not agentname.
    }

    protected void setUserTurnSchedule(ArrayList<String> schedule)
    {
        this.userTurnSchedule = schedule;
    }

    protected boolean checkWatchList()
    {
        String[] connected_users = FMLCommonHandler.instance().getMinecraftServerInstance().getOnlinePlayerNames();
        if (connected_users.length < this.userConnectionWatchList.size())
            return false;

        // More detailed check (since there may be non-mission-required connections - eg a human spectator).
        for (String username : this.userConnectionWatchList)
        {
            boolean bFound = false;
            for (int i = 0; i < connected_users.length && !bFound; i++)
            {
                if (connected_users[i].equals(username))
                    bFound = true;
            }
            if (!bFound)
                return false;
        }
        return true;
    }

    protected void initialiseHandlers(MissionInit init) throws Exception
    {
        this.missionHandlers = MissionBehaviour.createServerHandlersFromMissionInit(init);
    }

    protected MissionBehaviour getHandlers()
    {
        return this.missionHandlers;
    }

    public void setMissionInit(MissionInit minit)
    {
        this.queuedMissionInit = minit;
    }

    public ServerStateMachine(ServerState initialState)
    {
        super(initialState);
        initBusses();
    }

    /** Called to initialise a state machine for a specific Mission request.<br>
     * Most likely caused by the client creating an integrated server.
     * @param initialState Initial state of the machine
     * @param minit The MissionInit object requested
     */
    public ServerStateMachine(ServerState initialState, MissionInit minit)
    {
        super(initialState);
        this.currentMissionInit = minit;
        initBusses();
    }

    private void initBusses()
    {
        // Register ourself on the event busses, so we can harness the server tick:
        MinecraftForge.EVENT_BUS.register(this);
    }

    @Override
    protected String getName() { return "SERVER"; }

    @Override
    protected void onPreStateChange(IState toState)
    {
        String text = "SERVER: " + toState;
        Map<String, String> data = new HashMap<String, String>();
        data.put("text", text);
        data.put("category", ScreenHelper.TextCategory.TXT_SERVER_STATE.name());
        MalmoMod.safeSendToAll(MalmoMessageType.SERVER_TEXT, data);
    }

    @SubscribeEvent
    public void onServerTick(TickEvent.ServerTickEvent ev)
    {
        // Use the server tick to ensure we regularly update our state (from the server thread)
        updateState();
    }

    @SubscribeEvent
    public void onGetBreakSpeed(BreakSpeed bs)
    {
        String agentname = bs.getEntityPlayer().getName();
        if (currentMissionInit() != null && currentMissionInit().getMission() != null) {
            List<AgentSection> agents = currentMissionInit().getMission().getAgentSection();
            if (agents != null)
            {
                for (AgentSection ascandidate : agents)
                {
                    if (ascandidate.getName().equals(agentname)) {
                        Float mul = ascandidate.getAgentStart().getBreakSpeedMultiplier();
                        if (mul != null) {
                            bs.setNewSpeed(bs.getNewSpeed() * mul);
                        }
                    }
                }
            }
        }
    }

    /** Called by Forge - call setCanceled(true) to prevent spawning in our world.*/
    @SubscribeEvent
    public void onGetPotentialSpawns(PotentialSpawns ps)
    {
        // Decide whether or not to allow spawning.
        // We shouldn't allow spawning unless it has been specifically turned on - whether
        // a mission is running or not. (Otherwise spawning may happen in between missions.)
        boolean allowSpawning = false;
        if (currentMissionInit() != null && currentMissionInit().getMission() != null)
        {
            // There is a mission running - does it allow spawning?
            ServerSection ss = currentMissionInit().getMission().getServerSection();
            ServerInitialConditions sic = (ss != null) ? ss.getServerInitialConditions() : null;
            if (sic != null)
                allowSpawning = (sic.isAllowSpawning() == Boolean.TRUE);

            if (allowSpawning && sic.getAllowedMobs() != null && !sic.getAllowedMobs().isEmpty())
            {
                // Spawning is allowed, but restricted to our list:
                Iterator<SpawnListEntry> it = ps.getList().iterator();
                while (it.hasNext())
                {
                    // Is this on our list?
                    SpawnListEntry sle = it.next();
                    net.minecraftforge.fml.common.registry.EntityEntry entry = net.minecraftforge.fml.common.registry.EntityRegistry.getEntry(sle.entityClass);
                    String mobName = entry == null ? null : entry.getName();
                    boolean allowed = false;
                    for (EntityTypes mob : sic.getAllowedMobs())
                    {
                        if (mob.value().equals(mobName))
                            allowed = true;
                    }
                    if (!allowed)
                        it.remove();
                }
            }
        }
        // Cancel spawn event:
        if (!allowSpawning)
            ps.setCanceled(true);
    }

    /** Called by Forge - return ALLOW, DENY or DEFAULT to control spawning in our world.*/
    @SubscribeEvent
    public void onCheckSpawn(CheckSpawn cs)
    {
        // Decide whether or not to allow spawning.
        // We shouldn't allow spawning unless it has been specifically turned on - whether
        // a mission is running or not. (Otherwise spawning may happen in between missions.)
        boolean allowSpawning = false;
        if (currentMissionInit() != null && currentMissionInit().getMission() != null)
        {
            // There is a mission running - does it allow spawning?
            ServerSection ss = currentMissionInit().getMission().getServerSection();
            ServerInitialConditions sic = (ss != null) ? ss.getServerInitialConditions() : null;
            if (sic != null)
                allowSpawning = (sic.isAllowSpawning() == Boolean.TRUE);

            if (allowSpawning && sic.getAllowedMobs() != null && !sic.getAllowedMobs().isEmpty())
            {
                // Spawning is allowed, but restricted to our list.
                // Is this mob on our list?
                String mobName = EntityList.getEntityString(cs.getEntity());
                allowSpawning = false;
                for (EntityTypes mob : sic.getAllowedMobs())
                {
                    if (mob.value().equals(mobName))
                    {
                        allowSpawning = true;
                        break;
                    }
                }
            }
        }
        if (allowSpawning)
            cs.setResult(Result.DEFAULT);
        else
            cs.setResult(Result.DENY);
    }

    /** Create the episode object for the requested state.
     * @param state the state the mod is entering
     * @return a MissionStateEpisode that localises all the logic required to run this state
     */
    @Override
    protected StateEpisode getStateEpisodeForState(IState state)
    {
        if (!(state instanceof ServerState))
            return null;

        ServerState sstate = (ServerState)state;
        switch (sstate)
        {
        case WAITING_FOR_MOD_READY:
            return new InitialiseServerModEpisode(this);
        case DORMANT:
            return new DormantEpisode(this);
        case BUILDING_WORLD:
            return new BuildingWorldEpisode(this);
        case WAITING_FOR_AGENTS_TO_ASSEMBLE:
            return new WaitingForAgentsEpisode(this);
        case RUNNING:
            return new RunningEpisode(this);
        case WAITING_FOR_AGENTS_TO_QUIT:
            return new WaitingForAgentsToQuitEpisode(this);
        case ERROR:
            return new ErrorEpisode(this);
        case CLEAN_UP:
            return new CleanUpEpisode(this);
        case MISSION_ENDED:
            return null;//new MissionEndedEpisode(this, MissionResult.ENDED);
        case MISSION_ABORTED:
            return null;//new MissionEndedEpisode(this, MissionResult.AGENT_QUIT);
        default:
            break;
        }
        return null;
    }

    protected MissionInit currentMissionInit()
    {
        return this.currentMissionInit;
    }

    protected boolean hasQueuedMissionInit()
    {
        return this.queuedMissionInit != null;
    }

    protected MissionInit releaseQueuedMissionInit()
    {
        MissionInit minit = null;
        synchronized (this.queuedMissionInit)
        {
            minit = this.queuedMissionInit;
            this.queuedMissionInit = null;
        }
        return minit;
    }

    //---------------------------------------------------------------------------------------------------------
    // Episode helpers - each extends a MissionStateEpisode to encapsulate a certain state
    //---------------------------------------------------------------------------------------------------------

    public abstract class ErrorAwareEpisode extends StateEpisode implements IMalmoMessageListener
    {
        protected Boolean errorFlag = false;
        protected Map<String, String> errorData = null;

        public ErrorAwareEpisode(ServerStateMachine machine)
        {
            super(machine);
            MalmoMod.MalmoMessageHandler.registerForMessage(this, MalmoMessageType.CLIENT_BAILED);
        }

        @Override
        public void onMessage(MalmoMessageType messageType, Map<String, String> data)
        {
            if (messageType == MalmoMod.MalmoMessageType.CLIENT_BAILED)
            {
                synchronized(this.errorFlag)
                {
                    this.errorFlag = true;
                    this.errorData = data;
                    onError(data);
                }
            }
        }

        @Override
        public void cleanup()
        {
            super.cleanup();
            MalmoMod.MalmoMessageHandler.deregisterForMessage(this, MalmoMessageType.CLIENT_BAILED);
        }

        protected boolean inErrorState()
        {
            synchronized(this.errorFlag)
            {
                return this.errorFlag;
            }
        }

        protected Map<String, String> getErrorData()
        {
            synchronized(this.errorFlag)
            {
                return this.errorData;
            }
        }

        protected void onError(Map<String, String> errorData) {}	// Default does nothing, but can be overridden.
    }

    /** Initial episode - perform client setup */
    public class InitialiseServerModEpisode extends StateEpisode
    {
        ServerStateMachine ssmachine;

        protected InitialiseServerModEpisode(ServerStateMachine machine)
        {
            super(machine);
            this.ssmachine = machine;
        }

        @Override
        protected void execute() throws Exception
        {
        }

        @Override
        protected void onServerTick(ServerTickEvent ev)
        {
            // We wait until we start to get server ticks, at which point we assume Minecraft has finished starting up.
            episodeHasCompleted(ServerState.DORMANT);
        }
    }

    //---------------------------------------------------------------------------------------------------------
    /** Dormant state - receptive to new missions */
    public class DormantEpisode extends ErrorAwareEpisode
    {
        private ServerStateMachine ssmachine;

        protected DormantEpisode(ServerStateMachine machine)
        {
            super(machine);
            this.ssmachine = machine;
            if (machine.hasQueuedMissionInit())
            {
                // This is highly suspicious - the queued mission init is a mechanism whereby the client state machine can pass its mission init
                // on to the server - which should only happen if the client has accepted the mission init, which in turn should only happen if the
                // server is dormant.
                // If a mission is queued up now, as we enter the dormant state, that would indicate an error - we've seen this in cases where the client
                // has passed the mission across, then hit an error case and aborted. In such cases this mission is now stale, and should be abandoned.
                // To guard against errors of this sort, simply clear the mission now:
                MissionInit staleMinit = machine.releaseQueuedMissionInit();
                String summary = staleMinit.getMission().getAbout().getSummary();
                System.out.println("SERVER DITCHING SUSPECTED STALE MISSIONINIT: " + summary);
            }
        }

        @Override
        protected void execute()
        {
            // Clear out our error state:
            clearErrorDetails();

            // There are two ways we can receive a mission command. In order of priority, they are:
            // 1: Via a MissionInit object, passed directly in to the state machine's constructor.
            // 2: Requested directly - usually as a result of the client that owns the integrated server needing to pass on its MissionInit.
            // The first of these can be checked for here.
            // The second will be checked for repeatedly during server ticks.
            if (currentMissionInit() != null)
            {
                System.out.println("INCOMING MISSION: Received MissionInit directly through ServerStateMachine constructor.");
                onReceiveMissionInit(currentMissionInit());
            }
        }

        @Override
        protected void onServerTick(TickEvent.ServerTickEvent ev)
        {
            try
            {
                checkForMissionCommand();
            }
            catch (Exception e)
            {
                // TODO: What now?
                e.printStackTrace();
            }
        }

        private void checkForMissionCommand() throws Exception
        {
            // Check whether a mission request has come in "directly":
            if (ssmachine.hasQueuedMissionInit())
            {
                System.out.println("INCOMING MISSION: Received MissionInit directly through queue.");
                onReceiveMissionInit(ssmachine.releaseQueuedMissionInit());
            }
        }

        protected void onReceiveMissionInit(MissionInit missionInit)
        {
        	MinecraftServer server = FMLCommonHandler.instance().getMinecraftServerInstance();
            System.out.println("Mission received: " + missionInit.getMission().getAbout().getSummary());
            TextComponentString txtMission = new TextComponentString("Received mission: " + TextFormatting.BLUE + missionInit.getMission().getAbout().getSummary());
            TextComponentString txtSource = new TextComponentString("Source: " + TextFormatting.GREEN + missionInit.getClientAgentConnection().getAgentIPAddress());
            server.getPlayerList().sendMessage(txtMission);
            server.getPlayerList().sendMessage(txtSource);

            ServerStateMachine.this.currentMissionInit = missionInit;
            // Create the Mission Handlers
            try
            {
                this.ssmachine.initialiseHandlers(missionInit);
            }
            catch (Exception e)
            {
                // TODO: What?
            }
            // Move on to next state:
            episodeHasCompleted(ServerState.BUILDING_WORLD);
        }
    }

    //---------------------------------------------------------------------------------------------------------
    /** Building world episode - assess world requirements and set up our server accordingly */
    public class BuildingWorldEpisode extends ErrorAwareEpisode
    {
        private ServerStateMachine ssmachine;

        protected BuildingWorldEpisode(ServerStateMachine machine)
        {
            super(machine);
            this.ssmachine = machine;
        }

        @Override
        protected void execute()
        {
        	MinecraftServer server = FMLCommonHandler.instance().getMinecraftServerInstance();
        	World world = server.getEntityWorld();
            MissionBehaviour handlers = this.ssmachine.getHandlers();
            // Assume the world has been created correctly - now do the necessary building.
            boolean builtOkay = true;
            if (handlers != null && handlers.worldDecorator != null)
            {
                try
                {
                    handlers.worldDecorator.buildOnWorld(this.ssmachine.currentMissionInit(), world);
                }
                catch (DecoratorException e)
                {
                    // Error attempting to decorate the world - abandon the mission.
                    builtOkay = false;
                    if (e.getMessage() != null)
                        saveErrorDetails(e.getMessage());
                    // Tell all the clients to abort:
                    Map<String, String>data = new HashMap<String, String>();
                    data.put("message", getErrorDetails());
                    MalmoMod.safeSendToAll(MalmoMessageType.SERVER_ABORT, data);
                    // And abort ourselves:
                    episodeHasCompleted(ServerState.ERROR);
                }
            }


            if (builtOkay)
            {
                // Now set up other attributes of the environment (eg weather)
                EnvironmentHelper.setMissionWeather(currentMissionInit(), server.getEntityWorld().getWorldInfo());
                episodeHasCompleted(ServerState.WAITING_FOR_AGENTS_TO_ASSEMBLE);
            }
        }

        @Override
        protected void onError(Map<String, String> errorData)
        {
            episodeHasCompleted(ServerState.ERROR);
        }
    }

    //---------------------------------------------------------------------------------------------------------
    /** Wait for all agents to stop running and get themselves into a ready state.*/
    public class WaitingForAgentsToQuitEpisode extends ErrorAwareEpisode implements MalmoMod.IMalmoMessageListener
    {
        private HashMap<String, Boolean> agentsStopped = new HashMap<String, Boolean>();
        private Map<String, String> data = null;

        protected WaitingForAgentsToQuitEpisode(ServerStateMachine machine)
        {
            super(machine);
            MalmoMod.MalmoMessageHandler.registerForMessage(this, MalmoMessageType.CLIENT_AGENTSTOPPED);
        }

        @Override
        protected void execute()
        {
            // Get ready to track agent responses:
            List<AgentSection> agents = currentMissionInit().getMission().getAgentSection();
            for (AgentSection as : agents)
                this.agentsStopped.put(as.getName(), false);

            // Now tell all the agents to stop what they are doing:
            data = new HashMap<String, String>();
            data.put("QuitCode", ServerStateMachine.this.quitCode);
            MalmoMod.safeSendToAll(MalmoMessageType.SERVER_STOPAGENTS, data);
        }

        @Override
        public void onMessage(MalmoMessageType messageType, Map<String, String> data)
        {
            super.onMessage(messageType, data);
            if (messageType == MalmoMod.MalmoMessageType.CLIENT_AGENTSTOPPED)
            {
                String name = data.get("agentname");
                this.agentsStopped.put(name, true);
                if (!this.agentsStopped.containsValue(false))
                {
                    // Agents are all finished and awaiting our message.
                    MalmoMod.safeSendToAll(MalmoMessageType.SERVER_MISSIONOVER);
                    episodeHasCompleted(ServerState.CLEAN_UP);
                }
            } 
        }

        @Override
        public void cleanup()
        {
            super.cleanup();
            MalmoMod.MalmoMessageHandler.deregisterForMessage(this, MalmoMessageType.CLIENT_AGENTSTOPPED);
        }
        
        @Override
        protected void onServerTick(ServerTickEvent ev)
        {
            if (!ServerStateMachine.this.checkWatchList())
            {
                // Something has gone wrong - we've lost a connection.
                // Need to respond to this, otherwise we'll sit here forever waiting for a client that no longer exists
                // to tell us it's finished its mission.
                MalmoMod.safeSendToAll(MalmoMessageType.SERVER_ABORT);
                episodeHasCompleted(ServerState.ERROR);
            }
            if (data != null) {
                MalmoMod.safeSendToAll(MalmoMessageType.SERVER_STOPAGENTS, data);
            }
        }
    }

    //---------------------------------------------------------------------------------------------------------
    /** Wait for all participants to join the game.*/
    public class WaitingForAgentsEpisode extends ErrorAwareEpisode implements MalmoMod.IMalmoMessageListener
    {
        // pendingReadyAgents starts full - agent is removed when it joins the server. When list is empty, moves to next phase (waiting for running).
        private ArrayList<String> pendingReadyAgents = new ArrayList<String>();

        // pendingRunningAgents starts empty - agent is added when it joins the server, removed again when it starts running.
        private ArrayList<String> pendingRunningAgents = new ArrayList<String>();

        // Map between usernames and agent names.
        private HashMap<String, String> usernameToAgentnameMap = new HashMap<String, String>();

        // Map used to build turn schedule for turn-based agents.
        private Map<Integer, String> userTurnScheduleMap = new HashMap<Integer, String>();

        protected WaitingForAgentsEpisode(ServerStateMachine machine)
        {
            super(machine);
            MalmoMod.MalmoMessageHandler.registerForMessage(this,  MalmoMessageType.CLIENT_AGENTREADY);
            MalmoMod.MalmoMessageHandler.registerForMessage(this,  MalmoMessageType.CLIENT_AGENTRUNNING);
            
            ServerStateMachine.this.clearUserConnectionWatchList(); // We will build this up as agents join us.
            ServerStateMachine.this.clearUserTurnSchedule();        // We will build this up too, if needed.
        }

        @Override
        public void cleanup()
        {
            super.cleanup();
            MalmoMod.MalmoMessageHandler.deregisterForMessage(this, MalmoMessageType.CLIENT_AGENTREADY);
            MalmoMod.MalmoMessageHandler.deregisterForMessage(this, MalmoMessageType.CLIENT_AGENTRUNNING);
        }

        private void addUsernameToTurnSchedule(String username, Integer requestedPosition)
        {
            // Agent "username" has requested a certain position in the turn schedule.
            // Honour their request if possible.
            // If they selected a free slot, put them in it. Otherwise, or if they didn't specify,
            // give them an index which is guaranteed to be free, and which will be incorporated into
            // the order once all agents have been added.
            if (requestedPosition == null || this.userTurnScheduleMap.containsKey(requestedPosition))
                requestedPosition = -this.userTurnScheduleMap.size();
            this.userTurnScheduleMap.put(requestedPosition, username);
        }

        private void saveTurnSchedule()
        {
            if (this.userTurnScheduleMap.isEmpty())
                return;

            // Create an order from the map:
            List<Integer> keys = new ArrayList<Integer>(this.userTurnScheduleMap.keySet());
            Collections.sort(keys);
            ArrayList<String> schedule = new ArrayList<String>();
            // First add the agents with well-specified positions:
            for (Integer i : keys)
            {
                if (i >= 0)
                    schedule.add(this.userTurnScheduleMap.get(i));
            }
            // Now add the agents which didn't have well-specified positions.
            // Add them in reverse order:
            Collections.reverse(keys);
            for (Integer i : keys)
            {
                if (i < 0)
                    schedule.add(this.userTurnScheduleMap.get(i));
            }
            ServerStateMachine.this.setUserTurnSchedule(schedule);
        }

        @Override
        public void onMessage(MalmoMessageType messageType, Map<String, String> data)
        {
            super.onMessage(messageType, data);
            if (messageType == MalmoMessageType.CLIENT_AGENTREADY)
            {
                // A client has joined and is waiting for us to tell us it can proceed.
                // Initialise the player, and store a record mapping from the username to the agentname.
                String username = data.get("username");
                String agentname = data.get("agentname");
                if (username != null && agentname != null && this.pendingReadyAgents.contains(agentname))
                {
                    initialisePlayer(username, agentname);
                    this.pendingReadyAgents.remove(agentname);
                    this.usernameToAgentnameMap.put(username, agentname);
                    this.pendingRunningAgents.add(username);
                    ServerStateMachine.this.addUsernameToWatchList(username);   // Now we've got it, we need to watch it - if it disappears, that's an error.
                    // Does this client want to be added to the turn scheduler?
                    String requestedTurnPosition = data.get("turnPosition");
                    if (requestedTurnPosition != null)
                    {
                        Integer pos = Integer.valueOf(requestedTurnPosition);
                        addUsernameToTurnSchedule(username, pos);
                    }
                    // If all clients have now joined, we can tell them to go ahead.
                    if (this.pendingReadyAgents.isEmpty())
                        onCastAssembled();
                }
            }
            else if (messageType == MalmoMessageType.CLIENT_AGENTRUNNING)
            {
                // A client has entered the running state (only happens once all CLIENT_AGENTREADY messages have arrived).
                String username = data.get("username");
                String agentname = this.usernameToAgentnameMap.get(username);
                if (username != null && this.pendingRunningAgents.contains(username))
                {
                    // Reset their position once more. We need to do this because the player can easily sink into
                    // a chunk if it takes too long to load.
                    if (agentname != null && !agentname.isEmpty())
                    {
                        AgentSection as = getAgentSectionFromAgentName(agentname);
                        EntityPlayerMP player = getPlayerFromUsername(username);
                        if (player != null && as != null)
                        {
                            // Set their initial position and speed:
                            PosAndDirection pos = as.getAgentStart().getPlacement();
                            if (pos != null) {
                                player.posX = pos.getX().doubleValue();
                                player.posY = pos.getY().doubleValue();
                                player.posZ = pos.getZ().doubleValue();
                            }
                            // And set their game type back now:
                            player.setGameType(GameType.getByName(as.getMode().name().toLowerCase()));
                            // Also make sure we haven't accidentally left the player flying:
                            player.capabilities.isFlying = false;
                            player.sendPlayerAbilities();
                            player.onUpdate();
                        }
                    }
                    this.pendingRunningAgents.remove(username);
                    // If all clients are now running, we can finally enter the running state ourselves.
                    if (this.pendingRunningAgents.isEmpty())
                        episodeHasCompleted(ServerState.RUNNING);
                }
            }
        }

        private AgentSection getAgentSectionFromAgentName(String agentname)
        {
            List<AgentSection> agents = currentMissionInit().getMission().getAgentSection();
            if (agents != null && agents.size() > 0)
            {
                for (AgentSection ascandidate : agents)
                {
                    if (ascandidate.getName().equals(agentname))
                        return ascandidate;
                }
            }
            return null;
        }

        private EntityPlayerMP getPlayerFromUsername(String username)
        {
            PlayerList scoman = FMLCommonHandler.instance().getMinecraftServerInstance().getPlayerList();
            EntityPlayerMP player = scoman.getPlayerByUsername(username);
            return player;
        }

        private void setMaxHealth(EntityLivingBase entity, float maxHealth) {
            // An arbitrary UUID, we just need it to be different than any other attribute modifier UUID
            // used in any other mod.
            UUID modifier_id = UUID.fromString("d7efc338-70d7-42dd-afc0-b198a67c926e");
            IAttributeInstance attribute = entity.getEntityAttribute(SharedMonsterAttributes.MAX_HEALTH);
            attribute.removeModifier(modifier_id);
            double toAdd = maxHealth - attribute.getAttributeValue();
            // Note: the last argument being 0 means that this is an addition modifier.
            // See https://minecraft.wiki/w/Attribute#Modifiers
            attribute.applyModifier(new AttributeModifier(modifier_id, "Set Max Health", toAdd, 0));
        }

        private void initialisePlayer(String username, String agentname)
        {
            System.out.println("Initializing player with username " + username + " and agentname " + agentname);
            AgentSection as = getAgentSectionFromAgentName(agentname);
            EntityPlayerMP player = getPlayerFromUsername(username);

            if (player != null && as != null) 
            {
                if ((player.getHealth() <= 0 || player.isDead || !player.isEntityAlive()))
                {
                    player.markPlayerActive();
                    player = FMLCommonHandler.instance().getMinecraftServerInstance().getPlayerList().recreatePlayerEntity(player, player.dimension, false);
                    player.connection.playerEntity = player;
                }

                // Reset their food and health:
                StartingHealth startingHealth = as.getAgentStart().getStartingHealth();
                if (startingHealth != null) {
                    setMaxHealth(player, startingHealth.getMaxHealth());
                    if (startingHealth.getHealth() == null) {
                        player.setHealth(player.getMaxHealth());
                    }
                    else {
                        player.setHealth(startingHealth.getHealth());
                    }
                }
                else {
                    player.setHealth(player.getMaxHealth());
                }

                FoodStats foodStats = player.getFoodStats();
                foodStats.addStats(20, 40);
                StartingFood startingFood = as.getAgentStart().getStartingFood();
                if (startingFood != null) {
                    foodStats.setFoodLevel(startingFood.getFood());
                    if (startingFood.getFoodSaturation() != null) {
                        foodStats.setFoodSaturationLevel(startingFood.getFoodSaturation());
                    }
                }
                player.maxHurtResistantTime = 1; // Set this to a low value so that lava will kill the player straight away.
                disablePlayerGracePeriod(player);   // Otherwise player will be invulnerable for the first 60 ticks.
                player.extinguish();	// In case the player was left burning.


                // Set their inventory:
                if (as.getAgentStart().getInventory() != null)
                initialiseInventory(player, as.getAgentStart().getInventory());
                // And their Ender inventory:
                if (as.getAgentStart().getEnderBoxInventory() != null)
                    initialiseEnderInventory(player, as.getAgentStart().getEnderBoxInventory());

                // Set their game mode to adventure for now, to protect them while we wait for the rest of the cast to assemble:
                // Note setting this to SPECTATOR will cause players to spawn in the ground for unknown reasons
                player.setGameType(GameType.ADVENTURE);
                player.onUpdateEntity();

                
                // Set their initial position and speed:
                PosAndDirection pos = as.getAgentStart().getPlacement();
                NearPlayer nearPlayer = as.getAgentStart().getNearPlayer();

                if (pos != null) {
                    if (nearPlayer != null) {
                        throw new RuntimeException(
                                "Either absolute starting position or NearAgent can be specified, but not both!");
                    }
                    setPlayerAbsolutePosition(player, pos);
                } else if (nearPlayer != null) {
                    setPlayerNearPlayer(player, nearPlayer);
                }
                player.setVelocity(0, 0, 0);	// Minimise chance of drift!
                player.onUpdateEntity();
            }
        }
        
        private void setPlayerAbsolutePosition(EntityPlayerMP player, PosAndDirection pos) {
            player.rotationYaw = pos.getYaw().floatValue();
            player.rotationPitch = pos.getPitch().floatValue();
            player.setPositionAndUpdate(pos.getX().doubleValue(), pos.getY().doubleValue(), pos.getZ().doubleValue());
            player.onUpdate(); // Needed to force scene to redraw
        }

        private void setPlayerNearPlayer(EntityPlayerMP player, NearPlayer np) {

            if (player.getName().equals(np.getName())) {
                // Player is next to themselves by default - no need for further action
                return;
            }
            System.out.println("Setting player " + player.getName() + " next to " + np.getName());
            double maxDistance = np.getMaxDistance();
            double minDistance = np.getMinDistance();
            double maxVertDistance = np.getMaxVertDistance();
            int tries = 20;
            EntityPlayerMP anchor = getPlayerFromUsername(np.getName());
            anchor.onUpdate();

            Random rng = new Random();
            for (int i = 0; i < tries; i++) {
                double distance = minDistance + rng.nextDouble() * (maxDistance - minDistance);
                double angle = rng.nextDouble() * 2.0 * Math.PI;
                double Z = anchor.posZ + distance * Math.cos(angle);
                double X = anchor.posX + distance * Math.sin(angle);
                // ideally, should be determined by the width of the viewport, so that agents
                // are in each
                // other's field of view
                double angleNoise = 20.0;

                double Y = Minecraft.getMinecraft().world.getTopSolidOrLiquidBlock(new BlockPos(X, 0, Z)).getY();
                System.out.println("Y = " + String.valueOf(Y) + ", anchor.posY = " + String.valueOf(anchor.posY)
                        + ", anchor.posX = " + String.valueOf(anchor.posX) + ", anchor.posZ = "
                        + String.valueOf(anchor.posZ));
                if (np.isLookingAt()) {
                    double yaw = -angle * 180.0 / Math.PI;
                    double pitch = -Math.atan((anchor.posY - Y) / distance) * 180 / Math.PI;
                    player.rotationYaw = (float) (180.0 + yaw + angleNoise * (rng.nextDouble() - 0.5));
                    anchor.rotationYaw = (float) (yaw + angleNoise * (rng.nextDouble() - 0.5));
                    player.rotationPitch = (float) (pitch + angleNoise * (rng.nextDouble() - 0.5));
                    anchor.rotationPitch = -(float) (pitch + angleNoise * (rng.nextDouble() - 0.5));

                    System.out.println(
                            "Setting agents " + player.getName() + " and " + np.getName() + " looking at each other");
                    System.out.println("With yaw " + String.valueOf(yaw) + " and pitch " + String.valueOf(pitch));

                }
                player.setPositionAndUpdate(X, Y, Z);
                anchor.setPositionAndUpdate(anchor.posX, anchor.posY, anchor.posZ);
                if (Math.abs(Y - anchor.posY) < maxVertDistance) {

                    break;
                }

                System.out.println("(Attempt " + String.valueOf(i) + " of " + String.valueOf(tries)
                        + "):  Failed to place agent " + player.getName() + " within vertical distance "
                        + String.valueOf(maxVertDistance) + " of anchor player " + np.getName());
            }

            player.onUpdate();
        }

        private boolean disablePlayerGracePeriod(EntityPlayerMP player)
        {
            // Are we in the dev environment or deployed?
            boolean devEnv = (Boolean) Launch.blackboard.get("fml.deobfuscatedEnvironment");
            // We need to know, because the member name will either be obfuscated or not.
            String ritFieldName = devEnv ? "respawnInvulnerabilityTicks" : "field_147101_bU";
            // NOTE: obfuscated name may need updating if Forge changes - search for "respawnInvulnerabilityTicks" in Malmo\Minecraft\build\tasklogs\retromapSources.log
            // (If this file doesn't exist, comment out the line in build.gradle that sets makeObfSourceJar to false, and re-build.)
            Field rit;
            try
            {
                rit = EntityPlayerMP.class.getDeclaredField(ritFieldName);
                rit.setAccessible(true);
                rit.set(player, 0);
                return true;
            }
            catch (SecurityException e)
            {
                e.printStackTrace();
            }
            catch (IllegalAccessException e)
            {
                e.printStackTrace();
            }
            catch (IllegalArgumentException e)
            {
                e.printStackTrace();
            }
            catch (NoSuchFieldException e)
            {
                e.printStackTrace();
            }
            return false;
        }

        @Override
        protected void execute()
        {
            List<AgentSection> agents = currentMissionInit().getMission().getAgentSection();
            if (agents != null && agents.size() > 0)
            {
                System.out.println("Experiment requires: ");
                for (AgentSection as : agents)
                {
                    System.out.println(">>>> " + as.getName());
                    pendingReadyAgents.add(as.getName());
                }
            }
        }

        private void resetPlayerGameTypes()
        {
            // Go through and set all the players to their correct game type:
            for (Map.Entry<String, String> entry : this.usernameToAgentnameMap.entrySet())
            {
                AgentSection as = getAgentSectionFromAgentName(entry.getValue());
                EntityPlayerMP player = getPlayerFromUsername(entry.getKey());
                if (as != null && player != null)
                {
                    player.setGameType(GameType.getByName(as.getMode().name().toLowerCase()));
                    // Also make sure we haven't accidentally left the player flying:
                    player.capabilities.isFlying = false;
                    player.sendPlayerAbilities();
                }
            }
        }

        private void onCastAssembled()
        {
            // Build up any extra mission handlers required:
            MissionBehaviour handlers = getHandlers();
            List<Object> extraHandlers = new ArrayList<Object>();
            Map<String, String> data = new HashMap<String, String>();

            if (handlers.worldDecorator != null && handlers.worldDecorator.getExtraAgentHandlersAndData(extraHandlers, data))
            {
                for (Object handler : extraHandlers)
                {
                    String xml;
                    try
                    {
                        xml = SchemaHelper.serialiseObject(handler, MissionInit.class);
                        data.put(handler.getClass().getName(), xml);
                    }
                    catch (JAXBException e)
                    {
                        // TODO - is this worth aborting the mission for?
                        System.out.println("Exception trying to describe extra handlers: " + e);
                    }
                }
            }
            // Allow the world decorators to add themselves to the turn schedule if required.
            if (handlers.worldDecorator != null)
            {
                ArrayList<String> participants = new ArrayList<String>();
                ArrayList<Integer> participantSlots = new ArrayList<Integer>();
                handlers.worldDecorator.getTurnParticipants(participants, participantSlots);
                for (int i = 0; i < Math.min(participants.size(), participantSlots.size()); i++)
                {
                    addUsernameToTurnSchedule(participants.get(i), participantSlots.get(i));
                }
            }
            // Save the turn schedule, if there is one:
            saveTurnSchedule();

            // And tell them all they can proceed:
            MalmoMod.safeSendToAll(MalmoMessageType.SERVER_ALLPLAYERSJOINED, data);
        }

        @Override
        protected void onError(Map<String, String> errorData)
        {
            // Something has gone wrong - one of the clients has been forced to bail.
            // Do some tidying:
            resetPlayerGameTypes();
            // And tell all the clients to abort:
            MalmoMod.safeSendToAll(MalmoMessageType.SERVER_ABORT, errorData);
            // And abort ourselves:
            episodeHasCompleted(ServerState.ERROR);
        }

        @Override
        protected void onServerTick(ServerTickEvent ev)
        {
            if (!ServerStateMachine.this.checkWatchList())
                onError(null);  // We've lost a connection - abort the mission.
        }

        private ItemStack itemStackFromInventoryObject(InventoryObjectType obj)
        {
            DrawItem di = new DrawItem();
            di.setColour(obj.getColour());
            di.setVariant(obj.getVariant());
            di.setType(obj.getType());
            ItemStack item = MinecraftTypeHelper.getItemStackFromDrawItem(di);
            if( item != null )
            {
                item.setCount(obj.getQuantity());
            }
            return item;
        }

        private void initialiseInventory(EntityPlayerMP player, Inventory inventory)
        {
            // Clear inventory:
            player.inventory.clearMatchingItems(null, -1, -1, null);
            player.inventoryContainer.detectAndSendChanges();
            if (!player.capabilities.isCreativeMode)
                player.updateHeldItem();

            // Now add specified items:
            for (JAXBElement<? extends InventoryObjectType> el : inventory.getInventoryObject())
            {
                InventoryObjectType obj = el.getValue();
                ItemStack item = itemStackFromInventoryObject(obj);
                if( item != null )
                {
                    player.inventory.setInventorySlotContents(obj.getSlot(), item);
                }
            }
        }

        private void initialiseEnderInventory(EntityPlayerMP player, EnderBoxInventory inventory)
        {
            player.getInventoryEnderChest().clear();
            for (JAXBElement<? extends InventoryObjectType> el : inventory.getInventoryObject())
            {
                InventoryObjectType obj = el.getValue();
                ItemStack item = itemStackFromInventoryObject(obj);
                if( item != null )
                {
                    player.getInventoryEnderChest().setInventorySlotContents(obj.getSlot(), item);
                }
            }
        }
    }

    //---------------------------------------------------------------------------------------------------------
    /** Mission running state.
     */
    public class RunningEpisode extends ErrorAwareEpisode
    {
        ArrayList<String> runningAgents = new ArrayList<String>();
        boolean missionHasEnded = false;
        long tickCount = 0;
        long secondStartTimeMs = 0;

        protected RunningEpisode(ServerStateMachine machine)
        {
            super(machine);

            // Build up list of running agents:
            List<AgentSection> agents = currentMissionInit().getMission().getAgentSection();
            if (agents != null && agents.size() > 0)
            {
                for (AgentSection as : agents)
                {
                    runningAgents.add(as.getName());
                }
            }

            // And register for the agent-finished message:
            MalmoMod.MalmoMessageHandler.registerForMessage(this, MalmoMessageType.CLIENT_AGENTFINISHEDMISSION);
            MalmoMod.MalmoMessageHandler.registerForMessage(this, MalmoMessageType.CLIENT_SHARE_REWARD);
            MalmoMod.MalmoMessageHandler.registerForMessage(this, MalmoMessageType.CLIENT_TURN_TAKEN);
        }

        @Override
        public void cleanup()
        {
            super.cleanup();
            MalmoMod.MalmoMessageHandler.deregisterForMessage(this, MalmoMessageType.CLIENT_AGENTFINISHEDMISSION);
            MalmoMod.MalmoMessageHandler.deregisterForMessage(this, MalmoMessageType.CLIENT_SHARE_REWARD);
            MalmoMod.MalmoMessageHandler.deregisterForMessage(this, MalmoMessageType.CLIENT_TURN_TAKEN);
        }

        @Override
        public void onMessage(MalmoMessageType messageType, Map<String, String> data)
        {
            super.onMessage(messageType, data);
            if (messageType == MalmoMessageType.CLIENT_AGENTFINISHEDMISSION)
            {
                String agentName = data.get("agentname");
                if (agentName != null)
                {
                    this.runningAgents.remove(agentName);
                    // If this agent is part of a turn-based scenario, it no longer needs
                    // to take its turn - we must remove it from the schedule or everything
                    // else will stall waiting for it.
                    ServerStateMachine.this.removeFromTurnSchedule(agentName);
                }
            }
            else if (messageType == MalmoMessageType.CLIENT_SHARE_REWARD)
            {
                MalmoMod.safeSendToAll(MalmoMessageType.SERVER_SHARE_REWARD, data);
            }
            else if (messageType == MalmoMessageType.CLIENT_TURN_TAKEN)
            {
                String agentName = data.get("agentname");
                //String userName = data.get("username");
                String nextAgentName = ServerStateMachine.this.getNextAgentInTurnSchedule(agentName);
                if (nextAgentName == null)
                {
                    // Couldn't find the next agent in the turn schedule. Abort!
                    String error = "ERROR IN TURN SCHEDULER - cannot find the successor to " +  agentName;
                    saveErrorDetails(error);
                    System.out.println(error);
                    MalmoMod.safeSendToAll(MalmoMessageType.SERVER_ABORT);
                    episodeHasCompleted(ServerState.ERROR);
                }
                else
                {
                    // Find the relevant agent; send a message to it.
                    PlayerList scoman = FMLCommonHandler.instance().getMinecraftServerInstance().getPlayerList();
                    EntityPlayerMP player = scoman.getPlayerByUsername(nextAgentName);
                    if (player != null)
                    {
                        MalmoMod.network.sendTo(new MalmoMod.MalmoMessage(MalmoMessageType.SERVER_YOUR_TURN, ""), player);
                    }
                    else if (getHandlers().worldDecorator != null)
                    {
                        // Not a player - is it a world decorator?
                        boolean handled = getHandlers().worldDecorator.targetedUpdate(nextAgentName);
                        if (!handled)
                        {
                            // Couldn't reach the client whose turn it is, and doesn't seem to be a decorator's turn - abort!
                            String error = "ERROR IN TURN SCHEDULER - could not find client for user " + nextAgentName;
                            saveErrorDetails(error);
                            System.out.println(error);
                            MalmoMod.safeSendToAll(MalmoMessageType.SERVER_ABORT);
                            episodeHasCompleted(ServerState.ERROR);
                        }
                    }
                }
            }
        }

        @Override
        protected void execute()
        {
            // Set up some initial conditions:
            ServerSection ss = currentMissionInit().getMission().getServerSection();
            ServerInitialConditions sic = (ss != null) ? ss.getServerInitialConditions() : null;
            if (sic != null && sic.getTime() != null)
            {
                boolean allowTimeToPass = (sic.getTime().isAllowPassageOfTime() != Boolean.FALSE);  // Defaults to true if unspecified.
                MinecraftServer server = FMLCommonHandler.instance().getMinecraftServerInstance();
                if (server.worlds != null && server.worlds.length != 0)
                {
                    for (int i = 0; i < server.worlds.length; ++i)
                    {
                        World world = server.worlds[i];
                        world.getGameRules().setOrCreateGameRule("doDaylightCycle", allowTimeToPass ? "true" : "false");
                        if (sic.getTime().getStartTime() != null)
                            world.setWorldTime(sic.getTime().getStartTime());
                    }
                }
            }
            ModSettings modsettings = currentMissionInit().getMission().getModSettings();
            if (modsettings != null && modsettings.getMsPerTick() != null)
                TimeHelper.serverTickLength = (long)(modsettings.getMsPerTick());
            // TimeHelper.serverTickLength = 5;
                
            if (getHandlers().quitProducer != null)
                getHandlers().quitProducer.prepare(currentMissionInit());

            if (getHandlers().worldDecorator != null)
                getHandlers().worldDecorator.prepare(currentMissionInit());

            // Fire the starting pistol:
            MalmoMod.safeSendToAll(MalmoMessageType.SERVER_GO);
            // And start the turn schedule turning, if there is one:
            if (!ServerStateMachine.this.userTurnSchedule.isEmpty())
            {
                String agentName = ServerStateMachine.this.userTurnSchedule.get(0);
                PlayerList scoman = FMLCommonHandler.instance().getMinecraftServerInstance().getPlayerList();
                EntityPlayerMP player = scoman.getPlayerByUsername(agentName);
                if (player != null)
                {
                    MalmoMod.network.sendTo(new MalmoMod.MalmoMessage(MalmoMessageType.SERVER_YOUR_TURN, ""), player);
                }
                else if (getHandlers().worldDecorator != null)
                {
                    // Not a player - is it a world decorator?
                    getHandlers().worldDecorator.targetedUpdate(agentName);
                }
            }
        }

        @Override
        protected void onServerTick(ServerTickEvent ev)
        {
            if (this.missionHasEnded)
                return;	// In case we get in here after deciding the mission is over.
            
            if (!ServerStateMachine.this.checkWatchList())
                onError(null);  // We've lost a connection - abort the mission.

            if (ev.phase == Phase.START)
            {
                // Measure our performance - especially useful if we've been overclocked.
                if (this.secondStartTimeMs == 0)
                    this.secondStartTimeMs = System.currentTimeMillis();

                long timeNow = System.currentTimeMillis();
                if (timeNow - this.secondStartTimeMs > 1000)
                {
                    long targetTicks = 1000 / TimeHelper.serverTickLength;
                    if (this.tickCount < targetTicks)
                        System.out.println("Warning: managed " + this.tickCount + "/" + targetTicks + " ticks this second.");
                    this.secondStartTimeMs = timeNow;
                    this.tickCount = 0;
                }
                this.tickCount++;
            }

        	MinecraftServer server = FMLCommonHandler.instance().getMinecraftServerInstance();

            if (ev.phase == Phase.END && getHandlers() != null && getHandlers().worldDecorator != null)
            {
                World world = server.getEntityWorld();
                getHandlers().worldDecorator.update(world);
            }

            if (ev.phase == Phase.END)
            {
                if (getHandlers() != null && getHandlers().quitProducer != null && getHandlers().quitProducer.doIWantToQuit(currentMissionInit()))
                {
                    ServerStateMachine.this.quitCode = getHandlers().quitProducer.getOutcome();
                    onMissionEnded(true);
                }
                else if (this.runningAgents.isEmpty())
                {
                    ServerStateMachine.this.quitCode = "All agents finished";
                    onMissionEnded(true);
                }
                // We need to make sure we keep the weather within mission parameters.
                // We set the weather just after building the world, but it's not a permanent setting,
                // and apparently there is a known bug in Minecraft that means the weather sometimes changes early.
                // To get around this, we reset it periodically.
                if (server.getTickCounter() % 500 == 0)
                {
                    EnvironmentHelper.setMissionWeather(currentMissionInit(), server.getEntityWorld().getWorldInfo());
                }
            }
        }

        private void onMissionEnded(boolean success)
        {
            this.missionHasEnded = true;

            if (getHandlers().quitProducer != null)
                getHandlers().quitProducer.cleanup();

            if (getHandlers().worldDecorator != null)
                getHandlers().worldDecorator.cleanup();

            TimeHelper.serverTickLength = 50;   // Return tick length to 50ms default.

            if (success)
            {
                // Mission is over - wait for all agents to stop.
                episodeHasCompleted(ServerState.WAITING_FOR_AGENTS_TO_QUIT);
            }
        }
        
        @Override
        protected void onError(Map<String, String> errorData)
        {
            // Something has gone wrong - one of the clients has been forced to bail.
            // Do some tidying:
            onMissionEnded(false);
            // Tell all the clients to abort:
            MalmoMod.safeSendToAll(MalmoMessageType.SERVER_ABORT);
            // And abort ourselves:
            episodeHasCompleted(ServerState.ERROR);
        }
    }

    //---------------------------------------------------------------------------------------------------------
    /** Generic error state */
    public class ErrorEpisode extends StateEpisode
    {
        public ErrorEpisode(StateMachine machine)
        {
            super(machine);
        }
        @Override
        protected void execute()
        {
            //TODO - tidy up.
            episodeHasCompleted(ServerState.CLEAN_UP);
        }
    }

    //---------------------------------------------------------------------------------------------------------
    public class CleanUpEpisode extends StateEpisode
    {
        public CleanUpEpisode(StateMachine machine)
        {
            super(machine);
        }
        @Override
        protected void execute()
        {
            // Put in all cleanup code here.
            MinecraftForge.EVENT_BUS.unregister(ServerStateMachine.this);
            ServerStateMachine.this.currentMissionInit = null;
            
            // TODO (R): Kick all of the clients out?

            episodeHasCompleted(ServerState.DORMANT);
        }
    }
}
