package electrosphere.entity.scene;

import java.util.List;

/**
 * Model class for scene files
 */
public class SceneFile {
    
    /**
     * The entities in the scene
     */
    List<EntityDescriptor> entities;

    /**
     * The paths relative to the assets folder of each script to be loaded when the scene is loaded
     */
    List<String> scriptPaths;

    /**
     * The initial script to run when the scene is loaded into the engine
     */
    String initScriptPath;

    /**
     * The realm this scene is created within
     */
    RealmDescriptor realmDescriptor;

    /**
     * Gets the paths of all scripts in this scene
     * @return The list of all paths
     */
    public List<String> getScriptPaths(){
        return scriptPaths;
    }

    /**
     * Gets the entity descriptors for all entities created on init of this scene
     * @return The list of all entity descriptors
     */
    public List<EntityDescriptor> getEntities(){
        return entities;
    }

    /**
     * Gets the path to the initial script run when this scene is initialized
     * @return The path to the initial script
     */
    public String getInitScriptPath(){
        return initScriptPath;
    }

}