EngineImportTXD: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(14 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__{{Note|Please note the loading order that is used in the examples as other orders can cause collisions, textures or the DFF not to load due to technical limitations}}
{{Note box|Please note the loading order that is used in the examples as other orders can cause collisions, textures or the DFF not to load due to technical limitations}}


This function imports (adds) a loaded RenderWare Texture Dictionary into a specific model. This is necessary in order for the DFF loader to find any new textures. Please '''call this function before loading the DFF model file''', in order to allow the DFF loading process to find the new textures. This function can also replace default GTA textures, so that it becomes possible to e.g. put custom images on existing billboards. Ped and weapon textures are also supported.
This function imports (adds) a loaded RenderWare Texture Dictionary into a specific model. This is necessary in order for the DFF loader to find any new textures. Please '''call this function before loading the DFF model file''', in order to allow the DFF loading process to find the new textures. This function can also replace default GTA textures, so that it becomes possible to e.g. put custom images on existing billboards. Ped and weapon textures are also supported.
Line 9: Line 8:
* CJ clothing component textures can be replaced by using the ids listed on [[Clothing Component IDs|this page]]
* CJ clothing component textures can be replaced by using the ids listed on [[Clothing Component IDs|this page]]
}}
}}
{{Note|Load order is important: COL then TXD then DFF}}
 
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool engineImportTXD ( txd texture, int model_id )  
bool engineImportTXD ( txd texture, int model_id )  
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[TXD|txd]]:import}}
===Required Arguments===  
===Required Arguments===  
*'''texture:''' The [[TXD]] that was loaded with [[engineLoadTXD]]
*'''texture:''' The [[TXD]] that was loaded with [[engineLoadTXD]]
Line 23: Line 22:


==Example==  
==Example==  
'''Example 1:''' This example loads a combination of a custom TXD and DFF file to replace the Euros vehicle in-game. The collisions are embedded inside the DFF file.
See [https://wiki.multitheftauto.com/wiki/EngineReplaceModel#Example unified example available in engineReplaceModel.]
<syntaxhighlight lang="lua">
outputChatBox ( "> replacing the euros vehicle" )
 
txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 0 )
engineReplaceModel ( dff, 587 )
</syntaxhighlight>
 
 
'''Example 2:''' This example loads a combination of custom COL, TXD and DFF files to replace an in-game model of a set of floors.
<syntaxhighlight lang="lua">
outputChatBox ( "> loading floor objects" )
col_floors = engineLoadCOL ( "models/office_floors.col" )
engineReplaceCOL ( col_floors, 3781 )
txd_floors = engineLoadTXD ( "models/office_floors.txd" )
engineImportTXD ( txd_floors, 3781 )
dff_floors = engineLoadDFF ( "models/office_floors.dff", 3781 )
engineReplaceModel ( dff_floors, 3781 )
</syntaxhighlight>
 
 
{{New feature|3|1.0|
'''Example 3:''' This example replaces the victim billboards in last venturas (when replacing default models you do not need to replace a COL or DFF)
<syntaxhighlight lang="lua">
outputChatBox ( "> replacing billboards" )
txd_floors = engineLoadTXD ( "models/vgsn_billboard.txd" )
engineImportTXD ( txd_floors, 7300 )
</syntaxhighlight>
}}


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

Latest revision as of 21:37, 29 April 2024

[[{{{image}}}|link=|]] Note: Please note the loading order that is used in the examples as other orders can cause collisions, textures or the DFF not to load due to technical limitations

This function imports (adds) a loaded RenderWare Texture Dictionary into a specific model. This is necessary in order for the DFF loader to find any new textures. Please call this function before loading the DFF model file, in order to allow the DFF loading process to find the new textures. This function can also replace default GTA textures, so that it becomes possible to e.g. put custom images on existing billboards. Ped and weapon textures are also supported.

See here for tips on reducing the size of TXD files.

  • CJ clothing component textures can be replaced by using the ids listed on this page

Syntax

bool engineImportTXD ( txd texture, int model_id ) 

OOP Syntax Help! I don't understand this!

Method: txd:import(...)


Required Arguments

  • texture: The TXD that was loaded with engineLoadTXD
  • model_id: The model id to import the TXD into

Returns

Returns true if the function executed succesfully, false otherwise.

Example

See unified example available in engineReplaceModel.

See Also