Elaztek Developer Hub
Blamite Game Engine - Keystone  00307.01.26.21.0804.blamite
A library that enables the use of Qt in Blamite's editing tools.
keystone_api.h
Go to the documentation of this file.
1 // Blamite Game Engine - keystone.dll Exports Header //
3 // Copyright (c) 2013-2020 Elaztek Studios //
5 
6 #pragma once
7 
8 #include "shared/callbacks.h"
9 
10 #ifdef KEYSTONE_EXPORTS
11 
14 #define KEYSTONE_API extern "C" __declspec(dllexport)
15 #else
16 #define KEYSTONE_API extern "C" __declspec(dllimport)
17 #endif
18 
19 #ifndef KEYSTONE
20 #define KEYSTONE
21 #endif
22 
23 class BlamConfigurationFile;
24 enum BlamResult;
25 
30 {
31  OK,
36  Yes,
37  No,
38 
40 };
41 
47 namespace BlamKeystoneAPI
48 {
55 
68  KEYSTONE_API int ShowErrorDialog(bool classic, bool allow_safemode, bool allow_continue, const char* text);
69 
78 
87 
95  KEYSTONE_API int ShowGuerillaWindow(BlamConfigurationFile* guerilla_config);
96 
105 
113 
119  KEYSTONE_API bool OpenWebURL(std::string url);
120 
126  KEYSTONE_API bool OpenLocalURL(std::string url);
127 
135  KEYSTONE_API BlamResult LoadResourceGroup(std::string file_path);
136 }
137 
138 namespace BlamKeystone
139 {
146 }
BlamKeystoneAPI::ShowErrorDialog
KEYSTONE_API int ShowErrorDialog(bool classic, bool allow_safemode, bool allow_continue, const char *text)
Shows a Qt-driven error dialog.
Definition: keystone_api.cpp:35
Retry
@ Retry
The user pressed the 'Retry' button.
Definition: keystone_api.h:34
KeystoneDialogResult
KeystoneDialogResult
Enumerator containing all possible generic dialog results.
Definition: keystone_api.h:29
Abort
@ Abort
The user pressed the 'Abort' button.
Definition: keystone_api.h:33
BlamKeystoneAPI::ShowMainWindow
KEYSTONE_API int ShowMainWindow()
Shows a default testing window.
Definition: keystone_api.cpp:27
BlamKeystone
Namespace for anything within the Keystone library.
Definition: keystone_api.h:138
SapienCallbacksBundle
Definition: callbacks.h:8
BlamKeystoneAPI
Namespace containing any exported functions within Keystone.
Definition: keystone_api.h:47
BlamKeystoneAPI::SetupSapienCallbacks
KEYSTONE_API void SetupSapienCallbacks(SapienCallbacksBundle callbacks)
Loads and stores Sapien callbacks.
Definition: keystone_api.cpp:76
Default_NotSet
@ Default_NotSet
The dialog result has not yet been set.
Definition: keystone_api.h:39
Cancel
@ Cancel
The user pressed the 'Cancel' button.
Definition: keystone_api.h:32
No
@ No
The user pressed the 'No' button.
Definition: keystone_api.h:37
BlamKeystoneAPI::OpenLocalURL
KEYSTONE_API bool OpenLocalURL(std::string url)
Opens a local file with the user's default application.
Definition: keystone_api.cpp:91
BlamKeystoneAPI::ShowSapienAboutDialog
KEYSTONE_API int ShowSapienAboutDialog()
Shows the Sapien about window.
Definition: keystone_api.cpp:68
callbacks.h
BlamKeystoneAPI::ShowFoundryWindow
KEYSTONE_API int ShowFoundryWindow()
Shows the main Foundry window.
Definition: keystone_api.cpp:52
BlamKeystoneAPI::OpenWebURL
KEYSTONE_API bool OpenWebURL(std::string url)
Opens a URL in the user's default web browser.
Definition: keystone_api.cpp:86
BlamKeystoneAPI::ShowGuerillaWindow
KEYSTONE_API int ShowGuerillaWindow(BlamConfigurationFile *guerilla_config)
Shows the main Guerilla window.
Definition: keystone_api.cpp:60
KEYSTONE_API
#define KEYSTONE_API
Definition: keystone_api.h:16
Yes
@ Yes
The user pressed the 'Yes' button.
Definition: keystone_api.h:36
Ignore
@ Ignore
The user pressed the 'Ignore' button.
Definition: keystone_api.h:35
BlamKeystoneAPI::ShowSapienWindow
KEYSTONE_API int ShowSapienWindow()
Shows the main Sapien window.
Definition: keystone_api.cpp:44
OK
@ OK
The user pressed the 'OK' button.
Definition: keystone_api.h:31
BlamKeystone::GetSapienCallbacks
KEYSTONE SapienCallbacksBundle GetSapienCallbacks()
Retrieves the stored Sapien callbacks bundle.
Definition: keystone_api.cpp:81
BlamKeystoneAPI::LoadResourceGroup
KEYSTONE_API BlamResult LoadResourceGroup(std::string file_path)
Loads a resource group for use with Keystone's UI.
Definition: keystone_api.cpp:96
KEYSTONE
#define KEYSTONE
Definition: keystone_api.h:20