EngineImportTXD: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(35 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function imports a RenderWare Texture Dictionary into the model identified by the model id. This is necessary in order for the DFF loader to find any new textures. This does however not replace the original textures of the model.
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.


* To prevent issues with textures (object models) please call this function before loading the DFF model file, in order to allow the DFF loading process to find the new textures.
CJ clothing component textures can be replaced by using the ids listed on [[Clothing Component IDs|this page]].
{{Note|Follow loading order ('''COL''' -> '''TXD''' -> '''DFF''') which is used in the example - as other orders can cause collisions, textures or the DFF not to load due to technical limitations.}}
{{Tip|Do your TXD files take megabytes of disk space? You can read some [[Optimize_Custom_TXD|tips on reducing the size of TXD files]] to compress them without ruining texture quality.}}


==Syntax==  
==Syntax==  
Line 9: Line 11:
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 18: Line 20:


==Example==  
==Example==  
'''Example 1:''' This example loads a combination of a custom DFF and TXD 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", 587 )
engineReplaceModel ( dff, 587 )
</syntaxhighlight>
 
 
'''Example 2:''' This example loads a combination of custom DFF, TXD and COL files to replace an in-game model of a set of floors.
<syntaxhighlight lang="lua">
outputChatBox ( "> loading floor objects" )
txd_floors = engineLoadTXD ( "models/office_floors.txd" )
engineImportTXD ( txd_floors, 3781 )
col_floors = engineLoadCOL ( "models/office_floors.col" )
dff_floors = engineLoadDFF ( "models/office_floors.dff", 0 )
engineReplaceCOL ( col_floors, 3781 )
engineReplaceModel ( dff_floors, 3781 )
</syntaxhighlight>
 


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

Latest revision as of 13:08, 12 December 2024

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.

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

[[{{{image}}}|link=|]] Note: Follow loading order (COL -> TXD -> DFF) which is used in the example - as other orders can cause collisions, textures or the DFF not to load due to technical limitations.
[[{{{image}}}|link=|]] Tip: Do your TXD files take megabytes of disk space? You can read some tips on reducing the size of TXD files to compress them without ruining texture quality.

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


Retrieved from "https://wiki.multitheftauto.com/wiki/EngineImportTXD?oldid=81480"