EngineLoadDFF - Revision history

Srslyyyy at 13:01, 12 December 2024

2024-12-12T13:01:26Z

← Older revision		Revision as of 13:01, 12 December 2024
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__

	This function loads a RenderWare Model (DFF) file into GTA.		This function loads a RenderWare Model (DFF) file into GTA.

2024-12-12T13:01:03Z

Update load order info

← Older revision		Revision as of 13:01, 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 Model (DFF) file into GTA.		This function loads a RenderWare Model (DFF) file into GTA.
Line 9:		Line 9:

	The returned [[DFF]] element is an element in the element tree, just like vehicles and objects. When the dff is destroyed, ie on resource unload or using [[destroyElement]], any elements that use the DFF, such as vehicles or objects will be reset.		The returned [[DFF]] element is an element in the element tree, just like vehicles and objects. When the dff is destroyed, ie on resource unload or using [[destroyElement]], any elements that use the DFF, such as vehicles or objects will be reset.
			{{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.}}

	==Syntax==		==Syntax==

2024-05-01T15:03:00Z

← 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 Model (DFF) file into GTA.		This function loads a RenderWare Model (DFF) file into GTA.

2024-04-29T21:36:54Z

Example

@@ Line 22: / Line 22: @@
 ==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==

2019-09-07T08:35:43Z

prefer normal note

← Older revision		Revision as of 08:35, 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 Model (DFF) file into GTA.		This function loads a RenderWare Model (DFF) file into GTA.

2018-08-29T15:08:47Z

Example

← Older revision		Revision as of 15:08, 29 August 2018
Line 35:		Line 35:
	'''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 54:		Line 54:

	end		end
	addEventHandler ( "onClientResourceStart", ~~getResourceRootElement(getThisResource())~~, replaceWeapon)		addEventHandler ( "onClientResourceStart", resourceRoot, replaceWeapon)
	</syntaxhighlight>		</syntaxhighlight>

2017-06-20T18:31:26Z

Removed the second argument from examples due to confusions

← Older revision		Revision as of 18:31, 20 June 2017
Line 39:		Line 39:
	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 50:		Line 50:
	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

2017-06-10T21:07:46Z

Add another code example that I missed on last edit

@@ Line 45: / Line 45: @@
 </syntaxhighlight>
-'''Example 3:''' This example loads a combination of custom TXD, COL 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" )

2017-06-10T20:49:41Z

rephrased my last edit

← Older revision		Revision as of 20:49, 10 June 2017
Line 33:		Line 33:
	</syntaxhighlight>		</syntaxhighlight>

	'''Example 2:''' This example ~~loads~~ a ~~custom skin mod and replaces~~ SA skin ~~of the defined ID~~ (in this example ~~being~~ '190')		'''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", getResourceRootElement ( getThisResource() ),

2017-06-10T20:47:29Z

Added code example and lifted it up in sequence due to how typical the usage scenario is (more than previous example #2)

@@ Line 33: / Line 33: @@
 </syntaxhighlight>
-'''Example 2:''' This example loads a combination of custom TXD, COL and DFF files to replace an in-game model of a set of floors.
+'''Example 2:''' This example loads a custom skin mod and replaces SA skin of the defined ID (in this example being '190')
 <syntaxhighlight lang="lua">
 outputChatBox ( "> loading floor objects" )