AtomicGameEngine/Script/AtomicEditor/editor/EditorEvents.ts

//
// Copyright (c) 2014-2016 THUNDERBEAST GAMES LLC
//
// 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.
//

// TODO: migrate these interfaces out to the d.ts and migrate the static strings to some common location
export const ModalError = "ModalError";
export interface ModalErrorEvent {

  title: string;
  message: string;

}
export const PlayerStartRequest = "EditorPlayRequest";
export const PlayerStarted = "EditorPlayerStarted";
export const PlayerStopped = "EditorPlayerStopped";
export const PlayerPaused = "EditorPlayerPaused";
export const PlayerResumed = "EditorPlayerResumed";
export const PlayerLog = "EditorPlayerLog";
export interface PlayerLogEvent {

  message: string;
  level: number;

}


export const ActiveSceneEditorChange = "EditorActiveSceneEditorChange";
export interface ActiveSceneEditorChangeEvent {

  sceneEditor: Editor.SceneEditor3D;

}


export const SceneClosed = "EditorSceneClosed";
export interface SceneClosedEvent {

  scene: Atomic.Scene;

}

export const ContentFolderChanged = "ContentFolderChanged";
export interface ContentFolderChangedEvent {

  path: string;

}

export const CloseProject = "EditorCloseProject";
export const ProjectClosed = "EditorProjectClosed";
export const ProjectUnloadedNotification = "ProjectUnloadedNotification";

export const RequestProjectLoad = "RequestProjectLoad";
export interface RequestProjectLoadEvent {

  // The full path to the .atomic file
  path: string;

}

export const LoadProject = "EditorLoadProject";
export const LoadProjectNotification = "EditorLoadProjectNotification";
export interface LoadProjectEvent {

  // The full path to the .atomic file
  path: string;

}

export const SaveAllResources = "EditorSaveAllResources";

export const SaveResource = "EditorSaveResource";
/**
 * Called once the resource has been saved
 * @type {String}
 */
export const SaveResourceNotification = "EditorSaveResourceNotification";
export interface SaveResourceEvent {

  // The full path to the resource to save / empty or undefined for current
  path: string;

}

export const EditorResourceClose = "EditorResourceClose";
export interface EditorCloseResourceEvent {

  editor:Editor.ResourceEditor;
  navigateToAvailableResource:boolean;

}

export const EditResource = "EditorEditResource";
export interface EditResourceEvent {

  // The full path to the resource to edit
  path: string;

}

export const DeleteResource = "EditorDeleteResource";
/**
 * Called once the resource has been deleted
 * @type {String}
 */
export const DeleteResourceNotification = "DeleteResourceNotification";
export interface DeleteResourceEvent {

  // The full path to the resource to edit
  path: string;

}

export const RenameResource = "EditorRenameResource";
/**
 * Called once the resource has been renamed
 * @type {String}
 */
export const RenameResourceNotification = "RenameResourceNotification";
export interface RenameResourceEvent {

  // The full path to the resource to edit
  path: string;
  newPath: string;
  newName: string;

  // the asset to delete
  asset: ToolCore.Asset;
}

export const SceneEditStateChange = "SceneEditStateChange";
export interface SceneEditStateChangeEvent {

  serializable: Atomic.Serializable;

}

export const InspectorProjectReference = "InspectorProjectReference";
export interface InspectorProjectReferenceEvent {

    // The full path to the resource to edit
    path: string;

}

export const RemoveCurrentAssetAssigned = "RemoveCurrentAssetAssigned";
export interface RemoveCurrentAssetAssignedEvent {

}

export const UserPreferencesChangedNotification  = "UserPreferencesChangedNotification";
export interface UserPreferencesChangedEvent {
    /**
     * JSON string of the project preferences
     */
    projectPreferences: string;

    /**
     * JSON string of the application preferences
     */
    applicationPreferences: string;
}

export const WebViewLoadEnd = "WebViewLoadEnd";
export const WebMessage = "WebMessage";

// interface to pass modal error messages from core modules
export const EditorModal = "EditorModal";
export interface EditorModalEvent {
    uiType: number;     // EDITOR_ERROR_MODAL, etc)
    title: string;      // for modal errors, title text
    message: string;    // for modal errors, error text
}