gdjs::PreviewExportOptions Struct Reference

The options used to export a project for a preview. More...

#include <ExporterHelper.h>

Public Member Functions
	PreviewExportOptions (gd::Project &project_, const gd::String &exportPath_)
PreviewExportOptions &	UseWebsocketDebuggerClientWithServerAddress (const gd::String &address, const gd::String &port)
	Set the address of the debugger server that the game should reach out to, using the "WebSockets" debugger client.
PreviewExportOptions &	SetInAppTutorialMessageInPreview (const gd::String &message, const gd::String &position)
	Set the message to display to the user in a preview (as part of an in-app tutorial).
PreviewExportOptions &	SetFallbackAuthor (const gd::String &id, const gd::String &username)
	Set the fallback author info (if info not present in project properties).
PreviewExportOptions &	SetAuthenticatedPlayer (const gd::String &id, const gd::String &username, const gd::String &token)
	Set the fallback author info (if info not present in project properties).
PreviewExportOptions &	UseWindowMessageDebuggerClient ()
	Set that the game should connect to the debugger server using the "Window Message " debugger client.
PreviewExportOptions &	UseMinimalDebuggerClient ()
	Set that the game should have a minimal debugger client.
PreviewExportOptions &	SetNativeMobileApp (bool enable)
	Set that the preview is launched from a GDevelop native mobile app (iOS or Android).
PreviewExportOptions &	SetLayoutName (const gd::String &layoutName_)
	Set the layout to be run first in the previewed game.
PreviewExportOptions &	SetExternalLayoutName (const gd::String &externalLayoutName_)
	Set the (optional) external layout to be instantiated in the scene at the beginning of the previewed game.
PreviewExportOptions &	SetEventsBasedObjectType (const gd::String &eventsBasedObjectType_)
	Set the (optional) events-based object to be instantiated in the scene at the beginning of the previewed game.
PreviewExportOptions &	SetEventsBasedObjectVariantName (const gd::String &eventsBasedObjectVariantName_)
	Set the (optional) events-based object variant to be instantiated in the scene at the beginning of the previewed game.
PreviewExportOptions &	SetIncludeFileHash (const gd::String &includeFile, int hash)
	Set the hash associated to an include file. Useful for the preview hot-reload, to know if a file changed.
PreviewExportOptions &	SetShouldClearExportFolder (bool enable)
	Set if the exported folder should be cleared befor the export.
PreviewExportOptions &	SetShouldReloadProjectData (bool enable)
	Set if the ProjectData must be reloaded.
PreviewExportOptions &	SetShouldReloadLibraries (bool enable)
	Set if GDJS libraries must be reloaded.
PreviewExportOptions &	SetShouldGenerateScenesEventsCode (bool enable)
	Set if the export should export events code.
PreviewExportOptions &	SetFullLoadingScreen (bool enable)
	Set if the export should show the full loading screen (false by default, skipping the minimum duration and GDevelop logo).
PreviewExportOptions &	SetIsDevelopmentEnvironment (bool enable)
	Set if the export should consider to be in a development environment of GDevelop (the game should use GDevelop development APIs).
PreviewExportOptions &	SetIsInGameEdition (bool enable)
	Set if the export is made for being edited in the editor.
PreviewExportOptions &	SetInGameEditorSettingsJson (const gd::String &inGameEditorSettingsJson_)
	Set the JSON string representation of the in-game editor settings.
PreviewExportOptions &	SetEditorId (const gd::String &editorId_)
	Set the in-game editor identifier.
PreviewExportOptions &	SetEditorCameraState3D (const gd::String &cameraMode, double positionX, double positionY, double positionZ, double rotationAngle, double elevationAngle, double distance)
	Set the camera state to use in the in-game editor.
PreviewExportOptions &	SetNonRuntimeScriptsCacheBurst (unsigned int value)
	If set to a non zero value, the exported script URLs will have an extra search parameter added (with the given value) to ensure browser cache is bypassed when they are loaded.
PreviewExportOptions &	SetElectronRemoteRequirePath (const gd::String &electronRemoteRequirePath_)
PreviewExportOptions &	SetGDevelopResourceToken (const gd::String &gdevelopResourceToken_)
PreviewExportOptions &	SetAllowAuthenticationUsingIframeForPreview (bool allowAuthenticationUsingIframeForPreview_)
PreviewExportOptions &	SetCrashReportUploadLevel (const gd::String &crashReportUploadLevel_)
	Set the level of crash reports to be sent to GDevelop APIs.
PreviewExportOptions &	SetPreviewContext (const gd::String &previewContext_)
	Set the context of the preview.
PreviewExportOptions &	SetGDevelopVersionWithHash (const gd::String &gdevelopVersionWithHash_)
	Set the GDevelop version so the game is aware of it.
PreviewExportOptions &	SetProjectTemplateSlug (const gd::String &projectTemplateSlug_)
	Set the template slug that was used to create the project.
PreviewExportOptions &	SetSourceGameId (const gd::String &sourceGameId_)
	Set the source game id that was used to create the project.
PreviewExportOptions &	AddScreenshotCapture (int delayTimeInSeconds, const gd::String &signedUrl, const gd::String &publicUrl)
	Set the capture options to be used for taking screenshots or videos of the preview.

Public Attributes
gd::Project &	project
gd::String	exportPath
gd::String	websocketDebuggerServerAddress
gd::String	websocketDebuggerServerPort
bool	useWindowMessageDebuggerClient
bool	useMinimalDebuggerClient
gd::String	layoutName
gd::String	externalLayoutName
gd::String	eventsBasedObjectType
gd::String	eventsBasedObjectVariantName
gd::String	fallbackAuthorUsername
gd::String	fallbackAuthorId
gd::String	playerId
gd::String	playerUsername
gd::String	playerToken
gd::String	inAppTutorialMessageInPreview
gd::String	inAppTutorialMessagePositionInPreview
bool	nativeMobileApp
std::map< gd::String, int >	includeFileHashes
bool	shouldClearExportFolder = true
bool	shouldReloadProjectData = true
bool	shouldReloadLibraries = true
bool	shouldGenerateScenesEventsCode = true
bool	fullLoadingScreen
bool	isDevelopmentEnvironment
bool	isInGameEdition
gd::String	editorId
gd::String	editorCamera3DCameraMode
gd::String	inGameEditorSettingsJson
double	editorCamera3DPositionX = 0
double	editorCamera3DPositionY = 0
double	editorCamera3DPositionZ = 0
double	editorCamera3DRotationAngle = 0
double	editorCamera3DElevationAngle = 0
double	editorCamera3DDistance = 0
unsigned int	nonRuntimeScriptsCacheBurst
gd::String	electronRemoteRequirePath
gd::String	gdevelopResourceToken
bool	allowAuthenticationUsingIframeForPreview
gd::String	crashReportUploadLevel
gd::String	previewContext
gd::String	gdevelopVersionWithHash
gd::String	projectTemplateSlug
gd::String	sourceGameId
gd::CaptureOptions	captureOptions

Detailed Description

The options used to export a project for a preview.

Constructor & Destructor Documentation

PreviewExportOptions()

gdjs::PreviewExportOptions::PreviewExportOptions ( gd::Project &  project_, const gd::String &  exportPath_  )

inline

Parameters

project_	The project to export
exportPath_	The path in the filesystem where to export the files

Member Function Documentation

SetAllowAuthenticationUsingIframeForPreview()

PreviewExportOptions& gdjs::PreviewExportOptions::SetAllowAuthenticationUsingIframeForPreview ( bool  allowAuthenticationUsingIframeForPreview_ )

inline

Set if, in some exceptional cases, we allow authentication to be done through a iframe. This is usually discouraged as the user can't verify that the authentication window is a genuine one. It's only to be used in trusted contexts.

SetElectronRemoteRequirePath()

PreviewExportOptions& gdjs::PreviewExportOptions::SetElectronRemoteRequirePath ( const gd::String &  electronRemoteRequirePath_ )

inline

Set the path to use for the game engine to require "@electron/remote". This is because the preview is run in a folder without any node_module, but this is still required for now for some features. This should be removed once the dependency to "@electron/remote" is removed.

SetGDevelopResourceToken()

PreviewExportOptions& gdjs::PreviewExportOptions::SetGDevelopResourceToken ( const gd::String &  gdevelopResourceToken_ )

inline

Set the token to use by the game engine when requiring any resource stored on GDevelop Cloud buckets. Note that this is only useful during previews.

---

The documentation for this struct was generated from the following file:

• ExporterHelper.h