EngineImageLinkDFF: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Fix API description, add example)
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
{{Client function}}
{{Client function}}


{{New feature/item|4|1.6.0|21695|This function links DFF file with an IMG container.}}
{{New feature/item|4|1.6.0|21695|This function links DFF file with an IMG container. This function does not change a model immediately. You should use [[engineRestreamWorld]] to reload models.}}


==Syntax==
==Syntax==
Line 24: Line 24:
-- Load IMG
-- Load IMG
local img = engineLoadIMG( "file.img" )
local img = engineLoadIMG( "file.img" )
-- Enable streaming from this IMG
-- Enable streaming from this IMG
engineAddImage( img )
engineAddImage( img )
Line 34: Line 35:
engineImageLinkDFF( img, "infernus.dff", infernusModelID )
engineImageLinkDFF( img, "infernus.dff", infernusModelID )
engineImageLinkTXD( img, "infernus.txd", infernusModelTxdID )
engineImageLinkTXD( img, "infernus.txd", infernusModelTxdID )
-- Reload game models
engineRestreamWorld()
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 20:32, 21 July 2024

ADDED/UPDATED IN VERSION 1.6.0 r21695:
This function links DFF file with an IMG container. This function does not change a model immediately. You should use engineRestreamWorld to reload models.

Syntax

boolean engineImageLinkDFF ( img img_file, string file_path, int modelID )


OOP Syntax Help! I don't understand this!

Method: img:linkDFF(...)


Required Arguments

  • img_file: The IMG file you want to link.
  • file_path: Path to the DFF file you want to link.
  • modelID: ID of the model you want to link to.

Returns

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

Example

You could use the following code:

-- Load IMG
local img = engineLoadIMG( "file.img" )

-- Enable streaming from this IMG
engineAddImage( img )

-- Get model TXD id
local infernusModelID = 411
local infernusModelTxdID = engineGetModelTXDID( infernusModelID )

-- Link DFF and TXD to IMG files
engineImageLinkDFF( img, "infernus.dff", infernusModelID )
engineImageLinkTXD( img, "infernus.txd", infernusModelTxdID )

-- Reload game models
engineRestreamWorld()

See Also