EngineLoadTXD - Revision history

Srslyyyy: Update load order info

2024-12-12T13:04:08Z

Update load order info

← Older revision		Revision as of 13:04, 12 December 2024
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__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}}~~		__NOTOC__

	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.
			{{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.}}		{{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.}}

Srslyyyy at 15:03, 1 May 2024

2024-05-01T15:03:35Z

← Older revision		Revision as of 15:03, 1 May 2024
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__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}}		__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}}

	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.

Srslyyyy: /* Example */

2024-04-29T21:42:24Z

Example

@@ Line 25: / Line 25: @@
 ==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.]
 ==Changelog==

Srslyyyy: Add missing locals.

2022-10-17T11:01:55Z

Add missing locals.

← Older revision		Revision as of 11:01, 17 October 2022
Line 27:		Line 27:
	'''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.		'''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.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	txd = engineLoadTXD ("data/euros.txd")		local txd = engineLoadTXD("data/euros.txd")
	~~engineImportTXD (txd, 587~~)

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

			engineReplaceModel(dff, 587)
	</syntaxhighlight>		</syntaxhighlight>

	'''Example 2:''' This example replaces a standard SA skin (in this example ID '190) with a custom skin model (DFF & TXD)		'''Example 2:''' This example replaces a standard SA skin (in this example ID 190) with a custom skin model (DFF & TXD)
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler ( "onClientResourceStart", resourceRoot,		addEventHandler("onClientResourceStart", resourceRoot,
	function ()		function()
	txd = engineLoadTXD ( "skinmodel.txd" ); -- change 'skinmodel' to your mod's file name		local txd = engineLoadTXD("skinmodel.txd") -- change 'skinmodel' to your mod's file name
	~~engineImportTXD ( txd, 190 ); -- change the ID 190 into the GTA skin ID you with to replace with mod~~

	dff = engineLoadDFF ( "skinmodel.dff" ); -- change 'skinmodel' to your mod's file name		engineImportTXD(txd, 190) -- change the ID 190 into the GTA skin ID you with to replace with mod
	engineReplaceModel ( dff, 190 ); -- change the ID 190 into the GTA skin ID you with to replace with mod
			local dff = engineLoadDFF("skinmodel.dff") -- change 'skinmodel' to your mod's file name

			engineReplaceModel(dff, 190) -- change the ID 190 into the GTA skin ID you with to replace with mod
	end		end
	);		)
	</syntaxhighlight>		</syntaxhighlight>

	'''Example 3:''' This example replaces a default weapon with a custom weapon mod (TXD & DFF)		'''Example 3:''' This example replaces a default weapon with a custom weapon mod (TXD & DFF)
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler ( "onClientResourceStart", resourceRoot,		addEventHandler("onClientResourceStart", resourceRoot,
	function ()		function()
	txd = engineLoadTXD ( "m4.txd" )		local txd = engineLoadTXD("m4.txd")
	~~engineImportTXD ( txd, 356~~)

	dff = engineLoadDFF ( "m4.dff" ) -- use weapon model ID, not GTA weapon ID (model ID from https://wiki.multitheftauto.com/wiki/Weapons)		engineImportTXD(txd, 356)
	engineReplaceModel ( dff, 356) -- Likewise, model ID, for M4 as example it's 356
			local dff = engineLoadDFF("m4.dff") -- use weapon model ID, not GTA weapon ID (model ID from https://wiki.multitheftauto.com/wiki/Weapons)

			engineReplaceModel(dff, 356) -- Likewise, model ID, for M4 as example it's 356
	end		end
	);		)
	</syntaxhighlight>		</syntaxhighlight>

	'''Example 4:''' This example loads a combination of custom COL, TXD and DFF files to replace an in-game model of a set of floors.		'''Example 4:''' 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">		<syntaxhighlight lang="lua">
	col_floors = engineLoadCOL ("models/office_floors.col")		local col_floors = engineLoadCOL("models/office_floors.col")
	engineReplaceCOL (col_floors, 3781 )
			engineReplaceCOL(col_floors, 3781)

			local txd_floors = engineLoadTXD ("models/office_floors.txd")

			engineImportTXD(txd_floors, 3781)

	~~txd_floors~~ = ~~engineLoadTXD~~ ("models/office_floors.~~txd~~")		local dff_floors = engineLoadDFF("models/office_floors.dff")
	~~engineImportTXD (txd_floors, 3781~~ )

	~~dff_floors = engineLoadDFF ("models/office_floors.dff")~~		engineReplaceModel(dff_floors, 3781)
	engineReplaceModel (dff_floors, 3781)
	</syntaxhighlight>		</syntaxhighlight>

Qaisjp: prefer normal note

2019-09-07T08:36:06Z

prefer normal note

← Older revision		Revision as of 08:36, 7 September 2019
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 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.

Dutchman101 at 04:33, 12 June 2019

2019-06-12T04:33:04Z

← Older revision		Revision as of 04:33, 12 June 2019
Line 41:		Line 41:
	txd = engineLoadTXD ( "skinmodel.txd" ); -- change 'skinmodel' to your mod's file name		txd = engineLoadTXD ( "skinmodel.txd" ); -- change 'skinmodel' to your mod's file name
	engineImportTXD ( txd, 190 ); -- change the ID 190 into the GTA skin ID you with to replace with mod		engineImportTXD ( txd, 190 ); -- change the ID 190 into the GTA skin ID you with to replace with mod

	dff = engineLoadDFF ( "skinmodel.dff" ); -- change 'skinmodel' to your mod's file name		dff = engineLoadDFF ( "skinmodel.dff" ); -- change 'skinmodel' to your mod's file name
	engineReplaceModel ( dff, 190 ); -- change the ID 190 into the GTA skin ID you with to replace with mod		engineReplaceModel ( dff, 190 ); -- change the ID 190 into the GTA skin ID you with to replace with mod

Dutchman101: code examples: style fixes

2019-06-12T04:32:46Z

code examples: style fixes

← Older revision		Revision as of 04:32, 12 June 2019
Line 28:		Line 28:
	'''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.		'''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.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~outputChatBox~~ ( "~~> replacing the~~ euros ~~vehicle~~" )		txd = engineLoadTXD ("data/euros.txd")
			engineImportTXD (txd, 587)

	~~txd = engineLoadTXD ( "data/euros.txd" )~~		dff = engineLoadDFF ("data/euros.dff")
	~~engineImportTXD ( txd, 587 )~~		engineReplaceModel (dff, 587)
	dff = engineLoadDFF ( "data/euros.dff" )
	engineReplaceModel ( dff, 587 )
	</syntaxhighlight>		</syntaxhighlight>

	'''Example 2:''' This example replaces a standard SA skin (in this example ID '190) with a custom skin model (DFF & TXD)		'''Example 2:''' This example replaces a standard SA skin (in this example ID '190) with a custom skin model (DFF & TXD)
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler ( "onClientResourceStart", ~~getResourceRootElement ( getThisResource() )~~,		addEventHandler ( "onClientResourceStart", resourceRoot,
	function ()		function ()
	txd = engineLoadTXD ( "skinmodel.txd" ); -- change 'skinmodel' to your mod's file name		txd = engineLoadTXD ( "skinmodel.txd" ); -- change 'skinmodel' to your mod's file name
Line 50:		Line 49:
	'''Example 3:''' This example replaces a default weapon with a custom weapon mod (TXD & DFF)		'''Example 3:''' This example replaces a default weapon with a custom weapon mod (TXD & DFF)
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~replaceWeapon~~()		addEventHandler ( "onClientResourceStart", resourceRoot,
	txd = engineLoadTXD ( "m4.txd" )		function ()
	engineImportTXD ( txd, 356)		txd = engineLoadTXD ( "m4.txd" )
	~~dff = engineLoadDFF ( "m4.dff" ) -- use weapon model ID, not GTA weapon ID (model ID from https://wiki.multitheftauto.com/wiki/Weapons)~~		engineImportTXD ( txd, 356)
	~~engineReplaceModel ( dff, 356) -- Likewise, model ID, for M4 as example it's 356~~

	~~end~~		dff = engineLoadDFF ( "m4.dff" ) -- use weapon model ID, not GTA weapon ID (model ID from https://wiki.multitheftauto.com/wiki/Weapons)
	~~addEventHandler~~ ( "~~onClientResourceStart~~", ~~getResourceRootElement~~(~~getThisResource~~()), ~~replaceWeapon~~)		engineReplaceModel ( dff, 356) -- Likewise, model ID, for M4 as example it's 356
			end
			);
	</syntaxhighlight>		</syntaxhighlight>

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

Danilo: Fixed an extra wiki syntax

2019-06-10T21:48:22Z

Fixed an extra wiki syntax

← Older revision		Revision as of 21:48, 10 June 2019
Line 34:		Line 34:
	dff = engineLoadDFF ( "data/euros.dff" )		dff = engineLoadDFF ( "data/euros.dff" )
	engineReplaceModel ( dff, 587 )		engineReplaceModel ( dff, 587 )
	~~</syntaxhighlight>~~

	</syntaxhighlight>		</syntaxhighlight>

CrosRoad95: /* Example */

2018-03-17T18:11:11Z

Example

← Older revision		Revision as of 18:11, 17 March 2018
Line 44:		Line 44:
	txd = engineLoadTXD ( "skinmodel.txd" ); -- change 'skinmodel' to your mod's file name		txd = engineLoadTXD ( "skinmodel.txd" ); -- change 'skinmodel' to your mod's file name
	engineImportTXD ( txd, 190 ); -- change the ID 190 into the GTA skin ID you with to replace with mod		engineImportTXD ( txd, 190 ); -- change the ID 190 into the GTA skin ID you with to replace with mod
	dff = engineLoadDFF ( "skinmodel.dff"~~, 190~~ ); -- change 'skinmodel' to your mod's file name		dff = engineLoadDFF ( "skinmodel.dff" ); -- change 'skinmodel' to your mod's file name
	engineReplaceModel ( dff, 190 ); -- change the ID 190 into the GTA skin ID you with to replace with mod		engineReplaceModel ( dff, 190 ); -- change the ID 190 into the GTA skin ID you with to replace with mod
	end		end
Line 55:		Line 55:
	txd = engineLoadTXD ( "m4.txd" )		txd = engineLoadTXD ( "m4.txd" )
	engineImportTXD ( txd, 356)		engineImportTXD ( txd, 356)
	dff = engineLoadDFF ( "m4.dff"~~, 356~~) -- use weapon model ID, not GTA weapon ID (model ID from https://wiki.multitheftauto.com/wiki/Weapons)		dff = engineLoadDFF ( "m4.dff" ) -- use weapon model ID, not GTA weapon ID (model ID from https://wiki.multitheftauto.com/wiki/Weapons)
	engineReplaceModel ( dff, 356) -- Likewise, model ID, for M4 as example it's 356		engineReplaceModel ( dff, 356) -- Likewise, model ID, for M4 as example it's 356

Dutchman101: Add another code example that I missed on last edit

2017-06-10T21:11:45Z

Add another code example that I missed on last edit

@@ Line 50: / Line 50: @@
 </syntaxhighlight>
-'''Example 3:''' This example loads a combination of custom COL, TXD and DFF files to replace an in-game model of a set of floors.
+'''Example 3:''' This example replaces a default weapon with a custom weapon mod (TXD & DFF)
 <syntaxhighlight lang="lua">
 outputChatBox ( "> loading floor objects" )