package greenfoot.platforms;

import greenfoot.Actor;
import greenfoot.World;
import threadchecker.OnThread;
import threadchecker.Tag;




| Interface to classes that contain specialized behaviour for the WorldHandler
| depending on where and how the Greenfoot project is running.
|
| @author Poul Henriksen
|
@OnThread(Tag.Simulation)
public interface WorldHandlerDelegate
{           



| A new world has been set as the active world.
| @param oldWorld   The previously active world
| @param newWorld   The new active world
|
@OnThread(Tag.Any)
   p.public void setWorld(World oldWorld, World newWorld);

   
   


| Instantiate a new world and do any initialisation needed to activate that world.
|
| @param className The fully qualified name of the world class to instantiate
|                  if a specific class is wanted.  If null, use the most recently
|                  instantiated world class.
| @param runIfError A piece of code to run if there is an error during instantiation.
|                   This is passed as a Runnable rather than handled by return because
|                   we may hop thread to do the instantiation, so we cannot directly
|                   return the result without blocking.
|
@OnThread(Tag.Any)
   p.public void instantiateNewWorld(String className, Runnable runIfError);

   @OnThread(Tag.Any)
   p.public void discardWorld(World world);
    
   
   


| An actor was added into the world (by any means, possibly programmatically). Called with the world locked.
|
public void objectAddedToWorld(Actor actor);

   
   


| Show a text prompt asking for input, with given prompt string
|
public String ask(String prompt);

   
   


| A world of the given class name is now being initialised.
|
public default void initialisingWorld(String className)
{   
};



| Repaint the world.
| @param drawWorld The world to be painted
| @param forcePaint Force paint (ignore any optimisations to not paint frames too often, etc)
|
p.public void paint(World drawWorld, boolean forcePaint);

   



| The simulation had some user code which threw an exception
| that was not caught by the user code.
|
void notifyStoppedWithError();

   



| The world construction has completed.
|
default void finishedInitialisingWorld()
{
};
}