EngineRemoveImage: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Changed to a valid revision)
m (Added example)
Line 2: Line 2:
{{Client function}}
{{Client function}}


{{New feature/item|4|1.6.0|21695|This function removes an IMG container from GTA.}}
{{New feature/item|4|1.6.0|21708|This function removes an IMG container from GTA.}}
{{Warning|This article is incomplete and may contain errors}}
{{Warning|This article is incomplete and may contain errors}}


Line 17: Line 17:
Returns ''true'' if [[IMG]] file was successfully removed, ''false'' otherwise.
Returns ''true'' if [[IMG]] file was successfully removed, ''false'' otherwise.


<!-- TODO: Add examples
==Examples==
==Examples==
This example loads IMG file, adds it to GTA and after 10 seconds removes it.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
local img = engineLoadIMG('file.img') -- load IMG file to mta
engineAddImage(img) -- add it to GTA world
setTimer(engineRemoveImage, 10000, 1, img) -- remove it from GTA world
</syntaxhighlight>
</syntaxhighlight>
-->


==See Also==
==See Also==
{{Engine_functions}}
{{Engine_functions}}

Revision as of 17:59, 10 April 2023

ADDED/UPDATED IN VERSION 1.6.0 r21708:
This function removes an IMG container from GTA.
[[|link=|]] Warning: This article is incomplete and may contain errors

Syntax

img engineRemoveImage ( img img_file )


OOP Syntax Help! I don't understand this!

Method: EngineIMG(...)


Required Arguments

  • img_file: The IMG file you want to remove.

Returns

Returns true if IMG file was successfully removed, false otherwise.

Examples

This example loads IMG file, adds it to GTA and after 10 seconds removes it.

local img = engineLoadIMG('file.img') -- load IMG file to mta
engineAddImage(img) -- add it to GTA world
setTimer(engineRemoveImage, 10000, 1, img) -- remove it from GTA world

See Also