EngineLoadTXD: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 23: Line 23:
===Returns===
===Returns===
Returns a [[TXD]] if the file was loaded, ''false'' otherwise.
Returns a [[TXD]] if the file was loaded, ''false'' otherwise.
{{New feature/item|3.0150|1.4.1|7088|
==Syntax==
<syntaxhighlight lang="lua">
txd engineLoadTXD ( string txd_file / string raw_data [, bool filteringEnabled = true, bool is_raw = false ] )
</syntaxhighlight>
===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.
*'''is_raw:''' If set to ''true'', first argument will be recognized as data buffer.
===Returns===
Returns a [[TXD]] if the file was loaded, ''false'' otherwise.
}}


==Example==  
==Example==  

Revision as of 16:05, 25 February 2015

This template is no longer in use as it results in poor readability.

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.

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

Syntax

txd engineLoadTXD ( string txd_file [, 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: The filepath to the txd file you want to load

Optional Arguments

  • filteringEnabled: Whether to enable texture filtering.

Returns

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

Syntax

txd engineLoadTXD ( string txd_file / string raw_data [, bool filteringEnabled = true, bool is_raw = false ] )

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.
  • is_raw: If set to true, first argument will be recognized as data buffer.

Returns

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

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.

outputChatBox ( "> replacing the euros vehicle" )

txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 0 )
engineReplaceModel ( dff, 587 )


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.

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 )

See Also