Elaztek Developer Hub
Blamite Game Engine - Keystone  00427.01.12.25.2146.blamite
A library that enables the use of Qt in Blamite's editing tools.
keystone_api.h File Reference
#include <string>
#include <Strings/components/diagnostics/errors/errors.h>
+ Include dependency graph for keystone_api.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

 BlamKeystoneAPI
 Namespace containing any exported functions within Keystone.
 

Macros

#define KEYSTONE_API   extern "C" __declspec(dllimport)
 
#define KEYSTONE
 

Enumerations

enum  KeystoneDialogResult {
  KeystoneDialogResult::OK, KeystoneDialogResult::Cancel, KeystoneDialogResult::Abort, KeystoneDialogResult::Retry,
  KeystoneDialogResult::Ignore, KeystoneDialogResult::Yes, KeystoneDialogResult::No, KeystoneDialogResult::SafeMode,
  KeystoneDialogResult::Continue, KeystoneDialogResult::Exit, KeystoneDialogResult::Default_NotSet
}
 Enumerator containing all possible generic dialog results. More...
 
enum  BlamEditorWindowType {
  BlamEditorWindowType::Tool = 0, BlamEditorWindowType::Sapien = 1, BlamEditorWindowType::Guerilla = 2, BlamEditorWindowType::Foundry = 3,
  BlamEditorWindowType::Unspecified = 4
}
 Enumerator used to identify the type of the main editor window. More...
 

Functions

KEYSTONE_API KeystoneDialogResult BlamKeystoneAPI::ShowErrorDialog (bool allow_safemode, bool allow_continue, std::string text)
 Shows a Qt-driven error dialog. More...
 
KEYSTONE_API int BlamKeystoneAPI::ShowSapienWindow ()
 Shows the main Sapien window. More...
 
KEYSTONE_API int BlamKeystoneAPI::ShowFoundryWindow ()
 Shows the main Foundry window. More...
 
KEYSTONE_API int BlamKeystoneAPI::ShowGuerillaWindow ()
 Shows the main Guerilla window. More...
 
KEYSTONE_API int BlamKeystoneAPI::ShowFontToolWindow ()
 Shows the main FontTool window. More...
 
KEYSTONE_API int BlamKeystoneAPI::ShowToolWindow ()
 Shows the Tool GUI window. More...
 
KEYSTONE_API bool BlamKeystoneAPI::ShowEngineFirstbootDialog ()
 Shows the engine first boot notice dialog. More...
 
KEYSTONE_API void BlamKeystoneAPI::SetEditorWindowType (BlamEditorWindowType _type)
 

Macro Definition Documentation

◆ KEYSTONE

#define KEYSTONE

◆ KEYSTONE_API

#define KEYSTONE_API   extern "C" __declspec(dllimport)

Enumeration Type Documentation

◆ BlamEditorWindowType

enum BlamEditorWindowType
strong

Enumerator used to identify the type of the main editor window.

The BlamEditorWindow class stores this value, and this can later be used to call specific methods to ensure that certain functionality can be used between tools (mainly between the classic tools and Foundry).

Enumerator
Tool 

The editor window is the GUI for Tool (see tool_gui_window).

Sapien 

The editor window is the main window for Sapien (see #sapien_main_window).

Guerilla 

The editor window is the main window for Guerilla (see guerilla_window).

Foundry 

The editor window is the main window for Foundry (see foundry_main_window).

Unspecified 

Indicates that the editor window type is unknown. This should never happen.

◆ KeystoneDialogResult

enum KeystoneDialogResult
strong

Enumerator containing all possible generic dialog results.

Enumerator
OK 

The user pressed the 'OK' button.

Cancel 

The user pressed the 'Cancel' button.

Abort 

The user pressed the 'Abort' button.

Retry 

The user pressed the 'Retry' button.

Ignore 

The user pressed the 'Ignore' button.

Yes 

The user pressed the 'Yes' button.

No 

The user pressed the 'No' button.

SafeMode 

Indicates the user choosed the "Continue in Safe Mode" option.

Continue 

Indicates the user choosed the "Continue" option.

Exit 

Indicates the user choosed the "Exit" option.

Default_NotSet 

The dialog result has not yet been set.