EngineLoadTXD: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(22 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__{{Note|Please note the loading order that is used in the example 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, texturesor the DFF not to load due to technical limitations}}


This function loads a RenderWare Texture Dictionary (TXD) file into GTA. The texture dictionary can then be used to provide textures.
This function loads a RenderWare Texture Dictionary (TXD) file into GTA. The texture dictionary can then be used to provide textures.


This is a client side function. Be sure to transfer your TXD file by including it in the meta file.
This is a client side function. Be sure to transfer your TXD file by including it in the meta file.
{{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.}}


See here for [[Optimize_Custom_TXD|tips on reducing the size of TXD files]].
==Syntax==
 
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
txd engineLoadTXD ( string txd_file [, bool filteringEnabled = true ] )  
txd engineLoadTXD ( string txd_file / string raw_data [, bool filteringEnabled = true ] )
</syntaxhighlight>  
</syntaxhighlight>
[[Image:Filtering.jpg|thumb|Difference between texture filtering modes (left = filtering disabled, right = filtering enabled).|284x230px]]
[[Image:Filtering.jpg|thumb|Difference between texture filtering modes (left = filtering disabled, right = filtering enabled).|284x230px]]
{{OOP||[[TXD|EngineTXD]]}}
===Required Arguments===  
===Required Arguments===  
*'''txd_file:''' The [[filepath]] to the txd file you want to load
*'''txd_file / raw_data:''' The [[filepath]] to the TXD file you want to load or whole data buffer of the TXD file.
 
===Optional Arguments===
===Optional Arguments===
*'''filteringEnabled:''' Whether to enable texture filtering.
*'''filteringEnabled:''' Whether to enable texture filtering.
===Returns===
===Returns===
Returns a [[TXD]] if the file was loaded, ''false'' otherwise.
Returns a [[TXD]] if the file was loaded, ''false'' otherwise.
===Remarks===
[[Image:Texfilter_comparison.png|thumb|'''Left:''' anisotropic + mipmaps; '''Middle:''' filteringEnabled = true; '''Right:''': linear interpolation + mipmaps without anisot]]
The '''filteringEnabled''' property overrides the filtering modes in each texture of the TXD with point filtering. It also sets the uAddressing and vAddressing to WRAP. If textures come with mipmaps then they are disabled which is especially visible without ''anisotropic filtering''. It is recommended to set ''filteringEnabled'' to false if the TXD was created with mipmaps (the filtering mode can be changed in a TXD editor).


==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" )
==Changelog==
engineImportTXD ( txd, 587 )
{{ChangelogHeader}}
dff = engineLoadDFF ( "data/euros.dff", 0 )
{{ChangelogItem|1.4.1-9.07088|Added option to use raw data instead of a file name}}
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", 0 )
engineReplaceModel ( dff_floors, 3781 )
</syntaxhighlight>


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

Latest revision as of 15:03, 1 May 2024

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

This function loads a RenderWare Texture Dictionary (TXD) file into GTA. The texture dictionary can then be used to provide textures.

This is a client side function. Be sure to transfer your TXD file by including it in the meta file.

[[{{{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

txd engineLoadTXD ( string txd_file / string raw_data [, bool filteringEnabled = true ] )
Difference between texture filtering modes (left = filtering disabled, right = filtering enabled).

OOP Syntax Help! I don't understand this!

Method: EngineTXD(...)


Required Arguments

  • txd_file / raw_data: The filepath to the TXD file you want to load or whole data buffer of the TXD file.

Optional Arguments

  • filteringEnabled: Whether to enable texture filtering.

Returns

Returns a TXD if the file was loaded, false otherwise.

Remarks

Left: anisotropic + mipmaps; Middle: filteringEnabled = true; Right:: linear interpolation + mipmaps without anisot

The filteringEnabled property overrides the filtering modes in each texture of the TXD with point filtering. It also sets the uAddressing and vAddressing to WRAP. If textures come with mipmaps then they are disabled which is especially visible without anisotropic filtering. It is recommended to set filteringEnabled to false if the TXD was created with mipmaps (the filtering mode can be changed in a TXD editor).

Example

See unified example available in engineReplaceModel.

Changelog

Version Description
1.4.1-9.07088 Added option to use raw data instead of a file name

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/EngineLoadTXD?oldid=79281"