Changes between Version 2 and Version 3 of EngineFunctions


Ignore:
Timestamp:
May 12, 2023, 5:10:07 PM (12 months ago)
Author:
Grapjas
Comment:

sort ascending

Legend:

Unmodified
Added
Removed
Modified
  • EngineFunctions

    v2 v3  
    11= Engine Functions =
    2 [[TOC]]
    3 Example: `Engine.GetPlayerID()`
     2[[TOC]] Example: `Engine.GetPlayerID()`
    43
    54== AI ==
     5 *  * !ComputePath
     6 * !DumpImage
     7 * Exit
     8 * !FileExists
     9 * !GetTemplate
     10 * !IncludeModule
     11 * !ListDirectoryFiles
     12 * !PostCommand
     13 * !ProfileAttribute
    614 * !ProfileStart
    715 * !ProfileStop
    8  * !ProfileAttribute
    9  * !PostCommand
    10  * !IncludeModule
    11  * Exit
    12  * !ComputePath
    13  * !DumpImage
    14  * !GetTemplate
    15  * !ListDirectoryFiles
    16  * !FileExists
    1716 * ReadJSONFile
    1817
    1918== Simulation ==
     19 *  * !AddEntity
     20 * !AddLocalEntity
     21 * !BroadcastMessage
     22 * !DestroyEntity
     23 * !FileExists
     24 * !FlushDestroyedEntities
     25 * !GetComponentsWithInterface
     26 * !GetEntitiesWithInterface
     27 * !GetTemplate
     28 * !ListDirectoryFiles
     29 * !PostMessage
     30 * !ProfileAttribute
    2031 * !ProfileStartProfileStop
    21  * !ProfileAttribute
    22  * !ListDirectoryFiles
    23  * !FileExists
     32 * !QueryInterface
    2433 * ReadJSONFile
    2534 * !RegisterComponentType
     35 * !RegisterGlobal
     36 * !RegisterInterface
     37 * !RegisterMessageType
    2638 * !RegisterSystemComponentType
    2739 * !ReRegisterComponentType
    28  * !RegisterInterface
    29  * !RegisterMessageType
    30  * !RegisterGlobal
    31  * !GetEntitiesWithInterface
    32  * !GetComponentsWithInterface
    33  * !PostMessage
    34  * !BroadcastMessage
    35  * !AddEntity
    36  * !AddLocalEntity
    37  * !QueryInterface
    38  * !DestroyEntity
    39  * !FlushDestroyedEntities
    40  * !GetTemplate
    4140
    4241== GUI ==
    43  * !ProfileStart
    44  * !ProfileStop
    45  * !ProfileAttribute
    46  * ConfigDB_HasChanges
    47  * ConfigDB_SetChanges
    48  * ConfigDB_GetValue
     42 *  * !ActivateRejoinTest
     43 * !AddPlaylistItem
     44 * !AddReplayToCache
     45 * !AreModsPlayCompatible
     46 * !AssignNetworkPlayer
     47 * !AtlasIsAvailable
     48 * CalculateMD5
     49 * !CameraFollow
     50 * CameraFollowFPS
     51 * !CameraMoveTo
     52 * !ClearAllPlayerReady
     53 * !ClearPlaylist
     54 * ConfigDB_CreateAndSaveValue
    4955 * ConfigDB_CreateValue
    5056 * ConfigDB_CreateValues
     57 * ConfigDB_GetValue
     58 * ConfigDB_HasChanges
     59 * ConfigDB_Reload
    5160 * ConfigDB_RemoveValue
    5261 * ConfigDB_RemoveValueAndSave
    5362 * ConfigDB_SaveChanges
    5463 * ConfigDB_SaveValue
    55  * ConfigDB_CreateAndSaveValue
    56  * ConfigDB_Reload
    57  * !PauseOnFocusLoss
    58  * SetGUIScale
     64 * ConfigDB_SetChanges
     65 * !ConnectXmppClient
    5966 * Console_GetVisibleEnabled
    6067 * Console_SetVisibleEnabled
    61  * !GetMicroseconds
    6268 * Crash
    6369 * !DebugWarn
     70 * !DeleteCampaignSave
     71 * !DeleteReplay
     72 * !DeleteSavedGame
     73 * !DisconnectNetworkGame
     74 * !DisconnectXmppClient
    6475 * !DisplayErrorDialog
     76 * !DumpSimState
     77 * !DumpTerrainMipmap
     78 * !EnableTimeWarpRecording
     79 * !EncryptPassword
     80 * !EndGame
     81 * Exit
     82 * !FileExists
     83 * !FormatDecimalNumberIntoString
     84 * FormatMillisecondsIntoDateStringGMT
     85 * !FormatMillisecondsIntoDateStringLocal
     86 * GameView_GetConstrainCameraEnabled
     87 * GameView_GetCullingEnabled
     88 * GameView_GetLockCullCameraEnabled
     89 * GameView_SetConstrainCameraEnabled
     90 * GameView_SetCullingEnabled
     91 * GameView_SetLockCullCameraEnabled
     92 * GetAIs
     93 * !GetAllLocales
     94 * !GetAvailableMods
     95 * !GetBoardList
    6596 * !GetBuildDate
     97 * !GetBuildRevision
    6698 * !GetBuildTimestamp
    67  * !GetBuildRevision
    68  * !PushGuiPage
    69  * !SwitchGuiPage
    70  * !PopGuiPage
    71  * !SetCursor
    72  * !ResetCursor
    73  * !TemplateExists
    74  * !GetTemplate
    75  * GetGUIObjectByName
    76  * !SetGlobalHotkey
    77  * !UnsetGlobalHotkey
    78  * !IsGameStarted
    79  * !StartGame
    80  * !EndGame
    81  * GetPlayerID
    82  * SetPlayerID
    83  * !SetViewedPlayer
    84  * !GetSimRate
    85  * !SetSimRate
    86  * !GetPendingTurns
    87  * !IsPaused
    88  * !SetPaused
    89  * !IsVisualReplay
    90  * !GetCurrentReplayDirectory
    91  * !EnableTimeWarpRecording
    92  * !RewindTimeWarp
    93  * !DumpTerrainMipmap
    94  * GameView_GetCullingEnabled
    95  * GameView_SetCullingEnabled
    96  * GameView_GetLockCullCameraEnabled
    97  * GameView_SetLockCullCameraEnabled
    98  * GameView_GetConstrainCameraEnabled
    99  * GameView_SetConstrainCameraEnabled
     99 * !GetCameraPivot
     100 * !GetCameraPosition
    100101 * !GetCameraRotation
    101102 * !GetCameraZoom
    102  * !GetCameraPivot
    103  * !GetCameraPosition
    104  * !CameraMoveTo
    105  * !SetCameraTarget
    106  * !SetCameraData
    107  * !CameraFollow
    108  * CameraFollowFPS
     103 * !GetConflicts
     104 * !GetCurrentLocale
     105 * !GetCurrentReplayDirectory
     106 * !GetDefaultPort
     107 * !GetDictionariesForLocale
     108 * !GetDictionaryLocale
     109 * !GetEdgesOfStaticObstructionsOnScreenNearTo
     110 * !GetEnabledMods
     111 * !GetEngineInfo
     112 * !GetEntitiesWithStaticObstructionOnScreen
     113 * !GetFallbackToAvailableDictLocale
     114 * GetFileMTime
     115 * !GetFileSize
    109116 * !GetFollowedEntity
    110  * !GetTerrainAtScreenPoint
    111  * !HotkeyIsPressed
     117 * GetFPS
     118 * !GetGameList
     119 * GetGUIObjectByName
    112120 * !GetHotkeyMap
     121 * !GetIncompatibleMods
     122 * !GetLocaleBaseName
     123 * !GetLocaleCountry
     124 * !GetLocaleLanguage
     125 * !GetLocaleScript
     126 * GetMatchID
     127 * !GetMicroseconds
     128 * !GetPendingTurns
     129 * GetPlayerGUID
     130 * GetPlayerID
     131 * !GetPlayerList
     132 * !GetProfile
     133 * !GetReplayAttributes
     134 * !GetReplayDirectoryName
     135 * !GetReplayMetadata
     136 * !GetReplays
     137 * !GetSavedGames
    113138 * !GetScancodeKeyNames
    114  * !ReloadHotkeys
    115  * !GetConflicts
    116  * Translate
    117  * !TranslateWithContext
    118  * !TranslatePlural
    119  * !TranslatePluralWithContext
    120  * !TranslateLines
    121  * !TranslateArray
    122  * !FormatMillisecondsIntoDateStringLocal
    123  * FormatMillisecondsIntoDateStringGMT
    124  * !FormatDecimalNumberIntoString
     139 * !GetSimRate
    125140 * !GetSupportedLocaleBaseNames
    126141 * !GetSupportedLocaleDisplayNames
    127  * !GetCurrentLocale
    128  * !GetAllLocales
    129  * !GetDictionaryLocale
    130  * !GetDictionariesForLocale
    131  * !UseLongStrings
    132  * !GetLocaleLanguage
    133  * !GetLocaleBaseName
    134  * !GetLocaleCountry
    135  * !GetLocaleScript
    136  * !GetFallbackToAvailableDictLocale
    137  * !ValidateLocale
     142 * !GetSystemUsername
     143 * !GetTemplate
     144 * !GetTerrainAtScreenPoint
     145 * !GetTextSize
     146 * !GetTextWidth
     147 * !GetUserReportConfigPath
     148 * !GetUserReportLogPath
     149 * !GetUserReportStatus
     150 * !GuiInterfaceCall
     151 * !HasIncompatibleMods
     152 * !HasNetClient
     153 * !HasNetServer
     154 * !HasReplayMetadata
     155 * !HasXmppClient
     156 * !HotkeyIsPressed
     157 * !IsAtlasRunning
     158 * !IsGameStarted
     159 * !IsNetController
     160 * !IsPaused
     161 * !IsUserReportEnabled
     162 * !IsVisualReplay
     163 * !IsXmppClientConnected
     164 * !KickPlayer
     165 * !ListDirectoryFiles
     166 * !LoadMapSettings
     167 * !LobbyBan
     168 * LobbyGetJID
     169 * !LobbyGetNick
     170 * !LobbyGetPlayerPresence
     171 * !LobbyGetPlayerRating
     172 * !LobbyGetPlayerRole
     173 * !LobbyGetRoomSubject
     174 * !LobbyGuiPollHasPlayerListUpdate
     175 * !LobbyGuiPollHistoricMessages
     176 * !LobbyGuiPollNewMessages
     177 * !LobbyKick
     178 * !LobbySendMessage
     179 * !LobbySetNick
     180 * !LobbySetPlayerPresence
     181 * !ModIoAdvanceRequest
     182 * !ModIoCancelRequest
     183 * !ModIoGetDownloadProgress
     184 * !ModIoGetMods
     185 * !ModIoStartDownloadMod
     186 * !ModIoStartGetGameId
     187 * !ModIoStartListMods
     188 * !MusicPlaying
     189 * OpenURL
     190 * !PauseOnFocusLoss
     191 * !PickEntityAtPoint
     192 * !PickNonGaiaEntitiesOnScreen
     193 * !PickPlayerEntitiesInRect
     194 * !PickPlayerEntitiesOnScreen
     195 * !PickSimilarPlayerEntities
     196 * !PlayAmbientSound
     197 * !PlayMusic
     198 * PlayUISound
     199 * !PollNetworkClient
     200 * !PopGuiPage
     201 * !PostNetworkCommand
     202 * !ProfileAttribute
     203 * !ProfileStart
     204 * !ProfileStop
     205 * !PushGuiPage
     206 * !QuickLoad
     207 * !QuickSave
     208 * !ReadFile
     209 * !ReadFileLines
     210 * ReadJSONFile
     211 * !ReevaluateCurrentLocaleAndReload
     212 * !ReloadHotkeys
     213 * Renderer_GetDisplayFrustumEnabled
     214 * Renderer_GetDisplayShadowsFrustumEnabled
     215 * Renderer_GetRenderDebugMode
     216 * Renderer_GetRenderPath
     217 * Renderer_SetDisplayFrustumEnabled
     218 * Renderer_SetDisplayShadowsFrustumEnabled
     219 * Renderer_SetRenderDebugMode
     220 * !ResetCursor
     221 * !RestartInAtlas
     222 * !RewindTimeWarp
     223 * !SaveGame
     224 * !SaveGamePrefix
    138225 * !SaveLocale
    139  * !ReevaluateCurrentLocaleAndReload
    140  * !HasXmppClient
    141  * !SetRankedGame
    142  * !StartXmppClient
    143  * !StartRegisterXmppClient
    144  * !StopXmppClient
    145  * !ConnectXmppClient
    146  * !DisconnectXmppClient
    147  * !IsXmppClientConnected
     226 * !SendChangeStateGame
     227 * !SendGameReport
     228 * !SendGameSetupMessage
    148229 * !SendGetBoardList
    149230 * !SendGetProfile
    150  * !SendGameReport
     231 * !SendNetworkChat
     232 * !SendNetworkReady
    151233 * !SendRegisterGame
    152234 * !SendUnregisterGame
    153  * !SendChangeStateGame
    154  * !GetPlayerList
    155  * !GetGameList
    156  * !GetBoardList
    157  * !GetProfile
    158  * !LobbyGuiPollNewMessages
    159  * !LobbyGuiPollHistoricMessages
    160  * !LobbyGuiPollHasPlayerListUpdate
    161  * !LobbySendMessage
    162  * !LobbySetPlayerPresence
    163  * !LobbySetNick
    164  * !LobbyGetNick
    165  * LobbyGetJID
    166  * !LobbyKick
    167  * !LobbyBan
    168  * !LobbyGetPlayerPresence
    169  * !LobbyGetPlayerRole
    170  * !LobbyGetPlayerRating
    171  * !LobbyGetRoomSubject
    172  * !EncryptPassword
    173  * Exit
    174  * !RestartInAtlas
    175  * !AtlasIsAvailable
    176  * !IsAtlasRunning
    177  * OpenURL
    178  * !GetSystemUsername
    179  * GetMatchID
    180  * !LoadMapSettings
    181  * GetFPS
    182  * !GetTextSize
    183  * !GetTextWidth
    184  * CalculateMD5
    185  * !GetEngineInfo
    186  * !GetAvailableMods
    187  * !GetEnabledMods
    188  * !AreModsPlayCompatible
    189  * !HasIncompatibleMods
    190  * !GetIncompatibleMods
     235 * !SetActionGain
     236 * !SetAmbientGain
     237 * !SetBoundingBoxDebugOverlay
     238 * !SetCameraData
     239 * !SetCameraTarget
     240 * !SetCursor
     241 * !SetGlobalHotkey
     242 * SetGUIScale
     243 * !SetMasterGain
    191244 * !SetModsAndRestartEngine
    192  * !ModIoStartGetGameId
    193  * !ModIoStartListMods
    194  * !ModIoStartDownloadMod
    195  * !ModIoAdvanceRequest
    196  * !ModIoCancelRequest
    197  * !ModIoGetMods
    198  * !ModIoGetDownloadProgress
    199  * !GetDefaultPort
    200  * !IsNetController
    201  * !HasNetServer
    202  * !HasNetClient
     245 * !SetMusicGain
     246 * !SetPaused
     247 * SetPlayerID
     248 * !SetRankedGame
     249 * !SetSimRate
     250 * !SetTurnLength
     251 * SetUIGain
     252 * !SetUserReportEnabled
     253 * !SetViewedPlayer
     254 * !StartGame
     255 * !StartMusic
     256 * !StartNetworkGame
    203257 * !StartNetworkHost
    204258 * !StartNetworkJoin
    205259 * !StartNetworkJoinLobby
    206  * !DisconnectNetworkGame
    207  * GetPlayerGUID
    208  * !PollNetworkClient
    209  * !SendGameSetupMessage
    210  * !AssignNetworkPlayer
    211  * !KickPlayer
    212  * !SendNetworkChat
    213  * !SendNetworkReady
    214  * !ClearAllPlayerReady
    215  * !StartNetworkGame
    216  * !SetTurnLength
    217  * Renderer_GetRenderPath
     260 * !StartPlaylist
     261 * !StartRegisterXmppClient
     262 * !StartSavedGame
     263 * !StartVisualReplay
     264 * !StartXmppClient
     265 * !StopMusic
     266 * !StopXmppClient
     267 * !SwitchGuiPage
     268 * !TemplateExists
    218269 * !TextureExists
    219  * Renderer_GetRenderDebugMode
    220  * Renderer_SetRenderDebugMode
    221  * Renderer_GetDisplayFrustumEnabled
    222  * Renderer_SetDisplayFrustumEnabled
    223  * Renderer_GetDisplayShadowsFrustumEnabled
    224  * Renderer_SetDisplayShadowsFrustumEnabled
    225  * !GetSavedGames
    226  * !DeleteSavedGame
    227  * !SaveGame
    228  * !SaveGamePrefix
    229  * !QuickSave
    230  * !QuickLoad
    231  * !ActivateRejoinTest
    232  * !StartSavedGame
    233  * !GuiInterfaceCall
    234  * !PostNetworkCommand
    235  * !DumpSimState
    236  * GetAIs
    237  * !PickEntityAtPoint
    238  * !PickPlayerEntitiesInRect
    239  * !PickPlayerEntitiesOnScreen
    240  * !PickNonGaiaEntitiesOnScreen
    241  * !GetEntitiesWithStaticObstructionOnScreen
    242  * !GetEdgesOfStaticObstructionsOnScreenNearTo
    243  * !PickSimilarPlayerEntities
    244  * !SetBoundingBoxDebugOverlay
    245  * !StartMusic
    246  * !StopMusic
    247  * !ClearPlaylist
    248  * !AddPlaylistItem
    249  * !StartPlaylist
    250  * !PlayMusic
    251  * PlayUISound
    252  * !PlayAmbientSound
    253  * !MusicPlaying
    254  * !SetMasterGain
    255  * !SetMusicGain
    256  * !SetAmbientGain
    257  * !SetActionGain
    258  * SetUIGain
    259  * !IsUserReportEnabled
    260  * !SetUserReportEnabled
    261  * !GetUserReportStatus
    262  * !GetUserReportLogPath
    263  * !GetUserReportConfigPath
    264  * !ListDirectoryFiles
    265  * !FileExists
    266  * GetFileMTime
    267  * !GetFileSize
    268  * !ReadFile
    269  * !ReadFileLines
    270  * ReadJSONFile
     270 * Translate
     271 * !TranslateArray
     272 * !TranslateLines
     273 * !TranslatePlural
     274 * !TranslatePluralWithContext
     275 * !TranslateWithContext
     276 * !UnsetGlobalHotkey
     277 * !UseLongStrings
     278 * !ValidateLocale
    271279 * WriteJSONFile
    272  * !DeleteCampaignSave
    273  * !GetReplays
    274  * !DeleteReplay
    275  * !StartVisualReplay
    276  * !GetReplayAttributes
    277  * !GetReplayMetadata
    278  * !HasReplayMetadata
    279  * !AddReplayToCache
    280  * !GetReplayDirectoryName