EngineLoadIMG: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Client function}} {{New feature/item|4|1.6.0|21708|This function loads an IMG container into GTA.}} ==Syntax== <syntaxhighlight lang="lua">img engineLoadIMG( string img_file )</syntaxhighlight> {{OOP||EngineIMG}} ===Required Arguments=== * '''img_file''': The filepath to the IMG file you want to load. ===Returns=== Returns an IMG element if the IMG file loaded, ''false'' otherwise. ==See Also== {{Engine_functions}}") |
m (Add note for possible fixes) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{New feature/item| | {{New feature/item|3.0161|1.6.0|21708|This function loads an IMG container into GTA. '''Only 2 IMG archives can be loaded into GTA''' | ||
}} | |||
{{Note| | |||
If you're experiencing crashes/game hangs with default values, try to adjust memory/buffer/cache sizes with [[engineStreamingSetMemorySize]], [[engineStreamingSetBufferSize]] and/or [[engineStreamingSetModelCacheLimits]].}} | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">img engineLoadIMG( string img_file )</syntaxhighlight> | <syntaxhighlight lang="lua"> | ||
img engineLoadIMG ( string img_file ) | |||
</syntaxhighlight> | |||
{{OOP||[[DFF|EngineIMG]]}} | {{OOP||[[DFF|EngineIMG]]}} | ||
===Required Arguments=== | ===Required Arguments=== | ||
| Line 10: | Line 16: | ||
===Returns=== | ===Returns=== | ||
Returns an [[IMG]] element if the [[IMG]] file loaded, ''false'' otherwise. | Returns an [[IMG]] element if the [[IMG]] file loaded, ''false'' otherwise. | ||
===Examples=== | |||
This example loads IMG file from directory and then prints number of files in it | |||
<syntaxhighlight lang="lua"> | |||
local img = engineLoadIMG('file.img') | |||
iprint('Number of files: ',#engineImageGetFiles(img)) | |||
</syntaxhighlight> | |||
==See Also== | ==See Also== | ||
{{Engine_functions}} | {{Engine_functions}} | ||
[[Category:Changes in 1.6.0]] | |||
Latest revision as of 18:32, 5 January 2024
Syntax
img engineLoadIMG ( string img_file )
OOP Syntax Help! I don't understand this!
- Method: EngineIMG(...)
Required Arguments
Returns
Returns an IMG element if the IMG file loaded, false otherwise.
Examples
This example loads IMG file from directory and then prints number of files in it
local img = engineLoadIMG('file.img')
iprint('Number of files: ',#engineImageGetFiles(img))
See Also
- engineAddImage
- engineApplyShaderToWorldTexture
- engineFreeModel
- engineGetModelFlags
- engineGetModelIDFromName
- engineGetModelLODDistance
- engineGetModelNameFromID
- engineGetModelPhysicalPropertiesGroup
- engineGetModelTextureNames
- engineGetModelTextures
- engineGetModelTXDID
- engineGetModelVisibleTime
- engineGetObjectGroupPhysicalProperty
- engineGetSurfaceProperties
- engineGetVisibleTextureNames
- engineImageGetFilesCount
- engineImageGetFiles
- engineImageGetFile
- engineImageLinkDFF
- engineImageLinkTXD
- engineImportTXD
- engineLoadCOL
- engineLoadDFF
- engineLoadIMG
- engineLoadIFP
- engineLoadTXD
- engineRemoveImage
- engineRemoveShaderFromWorldTexture
- engineReplaceAnimation
- engineReplaceCOL
- engineReplaceModel
- engineRequestModel
- engineResetModelFlags
- engineResetModelLODDistance
- engineResetSurfaceProperties
- engineRestoreAnimation
- engineRestoreCOL
- engineRestoreDFFImage
- engineRestoreModel
- engineRestoreModelPhysicalPropertiesGroup
- engineRestoreObjectGroupPhysicalProperties
- engineRestoreTXDImage
- engineRestreamWorld
- engineSetAsynchronousLoading
- engineSetModelFlag
- engineSetModelFlags
- engineSetModelLODDistance
- engineSetModelPhysicalPropertiesGroup
- engineSetModelVisibleTime
- engineSetObjectGroupPhysicalProperty
- engineSetSurfaceProperties
- engineStreamingFreeUpMemory
- engineStreamingGetUsedMemory