Engine Functions

Example: Engine.GetPlayerID()

AI

• ProfileStart
• ProfileStop
• ProfileAttribute
• PostCommand
• IncludeModule
• Exit
• ComputePath
• DumpImage
• GetTemplate
• ListDirectoryFiles
• FileExists
• ReadJSONFile

Simulation

• ProfileStartProfileStop
• ProfileAttribute
• ListDirectoryFiles
• FileExists
• ReadJSONFile
• RegisterComponentType
• RegisterSystemComponentType
• ReRegisterComponentType
• RegisterInterface
• RegisterMessageType
• RegisterGlobal
• GetEntitiesWithInterface
• GetComponentsWithInterface
• PostMessage
• BroadcastMessage
• AddEntity
• AddLocalEntity
• QueryInterface
• DestroyEntity
• FlushDestroyedEntities
• GetTemplate

GUI

• ProfileStart
• ProfileStop
• ProfileAttribute
• ConfigDB_HasChanges
• ConfigDB_SetChanges
• ConfigDB_GetValue
• ConfigDB_CreateValue
• ConfigDB_CreateValues
• ConfigDB_RemoveValue
• ConfigDB_RemoveValueAndSave
• ConfigDB_SaveChanges
• ConfigDB_SaveValue
• ConfigDB_CreateAndSaveValue
• ConfigDB_Reload
• PauseOnFocusLoss
• SetGUIScale
• Console_GetVisibleEnabled
• Console_SetVisibleEnabled
• GetMicroseconds
• Crash
• DebugWarn
• DisplayErrorDialog
• GetBuildDate
• GetBuildTimestamp
• GetBuildRevision
• PushGuiPage
• SwitchGuiPage
• PopGuiPage
• SetCursor
• ResetCursor
• TemplateExists
• GetTemplate
• GetGUIObjectByName
• SetGlobalHotkey
• UnsetGlobalHotkey
• IsGameStarted
• StartGame
• EndGame
• GetPlayerID
• SetPlayerID
• SetViewedPlayer
• GetSimRate
• SetSimRate
• GetPendingTurns
• IsPaused
• SetPaused
• IsVisualReplay
• GetCurrentReplayDirectory
• EnableTimeWarpRecording
• RewindTimeWarp
• DumpTerrainMipmap
• GameView_GetCullingEnabled
• GameView_SetCullingEnabled
• GameView_GetLockCullCameraEnabled
• GameView_SetLockCullCameraEnabled
• GameView_GetConstrainCameraEnabled
• GameView_SetConstrainCameraEnabled
• GetCameraRotation
• GetCameraZoom
• GetCameraPivot
• GetCameraPosition
• CameraMoveTo
• SetCameraTarget
• SetCameraData
• CameraFollow
• CameraFollowFPS
• GetFollowedEntity
• GetTerrainAtScreenPoint
• HotkeyIsPressed
• GetHotkeyMap
• GetScancodeKeyNames
• ReloadHotkeys
• GetConflicts
• Translate
• TranslateWithContext
• TranslatePlural
• TranslatePluralWithContext
• TranslateLines
• TranslateArray
• FormatMillisecondsIntoDateStringLocal
• FormatMillisecondsIntoDateStringGMT
• FormatDecimalNumberIntoString
• GetSupportedLocaleBaseNames
• GetSupportedLocaleDisplayNames
• GetCurrentLocale
• GetAllLocales
• GetDictionaryLocale
• GetDictionariesForLocale
• UseLongStrings
• GetLocaleLanguage
• GetLocaleBaseName
• GetLocaleCountry
• GetLocaleScript
• GetFallbackToAvailableDictLocale
• ValidateLocale
• SaveLocale
• ReevaluateCurrentLocaleAndReload
• HasXmppClient
• SetRankedGame
• StartXmppClient
• StartRegisterXmppClient
• StopXmppClient
• ConnectXmppClient
• DisconnectXmppClient
• IsXmppClientConnected
• SendGetBoardList
• SendGetProfile
• SendGameReport
• SendRegisterGame
• SendUnregisterGame
• SendChangeStateGame
• GetPlayerList
• GetGameList
• GetBoardList
• GetProfile
• LobbyGuiPollNewMessages
• LobbyGuiPollHistoricMessages
• LobbyGuiPollHasPlayerListUpdate
• LobbySendMessage
• LobbySetPlayerPresence
• LobbySetNick
• LobbyGetNick
• LobbyGetJID
• LobbyKick
• LobbyBan
• LobbyGetPlayerPresence
• LobbyGetPlayerRole
• LobbyGetPlayerRating
• LobbyGetRoomSubject
• EncryptPassword
• Exit
• RestartInAtlas
• AtlasIsAvailable
• IsAtlasRunning
• OpenURL
• GetSystemUsername
• GetMatchID
• LoadMapSettings
• GetFPS
• GetTextSize
• GetTextWidth
• CalculateMD5
• GetEngineInfo
• GetAvailableMods
• GetEnabledMods
• AreModsPlayCompatible
• HasIncompatibleMods
• GetIncompatibleMods
• SetModsAndRestartEngine
• ModIoStartGetGameId
• ModIoStartListMods
• ModIoStartDownloadMod
• ModIoAdvanceRequest
• ModIoCancelRequest
• ModIoGetMods
• ModIoGetDownloadProgress
• GetDefaultPort
• IsNetController
• HasNetServer
• HasNetClient
• StartNetworkHost
• StartNetworkJoin
• StartNetworkJoinLobby
• DisconnectNetworkGame
• GetPlayerGUID
• PollNetworkClient
• SendGameSetupMessage
• AssignNetworkPlayer
• KickPlayer
• SendNetworkChat
• SendNetworkReady
• ClearAllPlayerReady
• StartNetworkGame
• SetTurnLength
• Renderer_GetRenderPath
• TextureExists
• Renderer_GetRenderDebugMode
• Renderer_SetRenderDebugMode
• Renderer_GetDisplayFrustumEnabled
• Renderer_SetDisplayFrustumEnabled
• Renderer_GetDisplayShadowsFrustumEnabled
• Renderer_SetDisplayShadowsFrustumEnabled
• GetSavedGames
• DeleteSavedGame
• SaveGame
• SaveGamePrefix
• QuickSave
• QuickLoad
• ActivateRejoinTest
• StartSavedGame
• GuiInterfaceCall
• PostNetworkCommand
• DumpSimState
• GetAIs
• PickEntityAtPoint
• PickPlayerEntitiesInRect
• PickPlayerEntitiesOnScreen
• PickNonGaiaEntitiesOnScreen
• GetEntitiesWithStaticObstructionOnScreen
• GetEdgesOfStaticObstructionsOnScreenNearTo
• PickSimilarPlayerEntities
• SetBoundingBoxDebugOverlay
• StartMusic
• StopMusic
• ClearPlaylist
• AddPlaylistItem
• StartPlaylist
• PlayMusic
• PlayUISound
• PlayAmbientSound
• MusicPlaying
• SetMasterGain
• SetMusicGain
• SetAmbientGain
• SetActionGain
• SetUIGain
• IsUserReportEnabled
• SetUserReportEnabled
• GetUserReportStatus
• GetUserReportLogPath
• GetUserReportConfigPath
• ListDirectoryFiles
• FileExists
• GetFileMTime
• GetFileSize
• ReadFile
• ReadFileLines
• ReadJSONFile
• WriteJSONFile
• DeleteCampaignSave
• GetReplays
• DeleteReplay
• StartVisualReplay
• GetReplayAttributes
• GetReplayMetadata
• HasReplayMetadata
• AddReplayToCache
• GetReplayDirectoryName