EngineReplaceModel - Revision history

Srslyyyy at 10:57, 1 May 2025

2025-05-01T10:57:01Z

← Older revision		Revision as of 10:57, 1 May 2025
Line 3:		Line 3:

	This function replaces the given model ID with the model contained in a DFF file loaded by [[engineLoadDFF]]. This function supports [[vehicle\|vehicles]], [[object\|objects]], [[ped\|peds]] and [[player\|players]].		This function replaces the given model ID with the model contained in a DFF file loaded by [[engineLoadDFF]]. This function supports [[vehicle\|vehicles]], [[object\|objects]], [[ped\|peds]] and [[player\|players]].

	Since version [https://buildinfo.multitheftauto.com/?Revision=23124&Branch= r23124] and above replacing CJ clothing became possible - see: [[Clothing Component IDs]]. Body parts replacements aren't supported at the moment.		Since version [https://buildinfo.multitheftauto.com/?Revision=23124&Branch= r23124] and above replacing CJ clothing became possible - see: [[Clothing Component IDs]]. Body parts replacements aren't supported at the moment.
	~~{{Deprecated feature\|3.0111\|1.1.1\|This function does not support ped and weapon models.}}~~

	To replace weapon models you must use their object IDs, not weapon IDs. There is a weapon model list available at [[~~weapons~~]].		To replace weapon models you must use their object IDs, not weapon IDs. There is a weapon model list available at [[Weapons]].

	{{Note\|		{{Note\|

Srslyyyy at 10:55, 1 May 2025

2025-05-01T10:55:44Z

← Older revision		Revision as of 10:55, 1 May 2025
Line 2:		Line 2:
	{{Client function}}		{{Client function}}

	This function replaces the given model ID with the model contained in a DFF file loaded by [[engineLoadDFF]]. This function supports [[vehicle\|vehicles]], [[object\|objects]], [[ped\|peds]] and [[player\|players]] ~~but not~~ CJ clothing ~~and body~~ parts.		This function replaces the given model ID with the model contained in a DFF file loaded by [[engineLoadDFF]]. This function supports [[vehicle\|vehicles]], [[object\|objects]], [[ped\|peds]] and [[player\|players]].
			Since version [https://buildinfo.multitheftauto.com/?Revision=23124&Branch= r23124] and above replacing CJ clothing became possible - see: [[Clothing Component IDs]]. Body parts replacements aren't supported at the moment.
	{{Deprecated feature\|3.0111\|1.1.1\|This function does not support ped and weapon models.}}		{{Deprecated feature\|3.0111\|1.1.1\|This function does not support ped and weapon models.}}

Line 9:		Line 9:

	{{Note\|		{{Note\|
	* '''[NEW]''' CJ clothing component models can be replaced by using the IDs listed in the [[Clothing Component IDs]] article.
	* 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.		* 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.
	* Default GTA map objects behave inconsistently when using this function on them. If you want to replace models in the original GTA map, you need to call [[engineRestreamWorld]] after replacing models as well.		* Default GTA map objects behave inconsistently when using this function on them. If you want to replace models in the original GTA map, you need to call [[engineRestreamWorld]] after replacing models as well.

Fernando187 at 12:13, 19 February 2025

2025-02-19T12:13:56Z

← Older revision		Revision as of 12:13, 19 February 2025
Line 8:		Line 8:
	To replace weapon models you must use their object IDs, not weapon IDs. There is a weapon model list available at [[weapons]].		To replace weapon models you must use their object IDs, not weapon IDs. There is a weapon model list available at [[weapons]].

	~~{{Note\|CJ clothing component models can be replaced by using the IDs listed in the [[Clothing Component IDs]] article.}}~~
	{{Note\|		{{Note\|
			* '''[NEW]''' CJ clothing component models can be replaced by using the IDs listed in the [[Clothing Component IDs]] article.
	* 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.		* 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.
	* Default GTA map objects behave inconsistently when using this function on them. If you want to replace models in the original GTA map, you need to call [[engineRestreamWorld]] after replacing models as well.		* Default GTA map objects behave inconsistently when using this function on them. If you want to replace models in the original GTA map, you need to call [[engineRestreamWorld]] after replacing models as well.

Fernando187: add note about CJ clothing models

2025-02-19T12:10:42Z

add note about CJ clothing models

← Older revision		Revision as of 12:10, 19 February 2025
Line 7:		Line 7:

	To replace weapon models you must use their object IDs, not weapon IDs. There is a weapon model list available at [[weapons]].		To replace weapon models you must use their object IDs, not weapon IDs. There is a weapon model list available at [[weapons]].

			{{Note\|CJ clothing component models can be replaced by using the IDs listed in the [[Clothing Component IDs]] article.}}
	{{Note\|		{{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.		* 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.

Srslyyyy at 12:52, 12 December 2024

2024-12-12T12:52:39Z

← Older revision		Revision as of 12:52, 12 December 2024
Line 8:		Line 8:
	To replace weapon models you must use their object IDs, not weapon IDs. There is a weapon model list available at [[weapons]].		To replace weapon models you must use their object IDs, not weapon IDs. There is a weapon model list available at [[weapons]].
	{{Note\|		{{Note\|
	* Follow loading order ('''COL''' -> '''TXD''' -> '''DFF''') ~~that~~ is used in the example - as other orders can cause collisions, textures or the DFF not to load due to technical limitations.		* 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.
	* Default GTA map objects behave inconsistently when using this function on them. If you want to replace models in the original GTA map, you need to call [[engineRestreamWorld]] after replacing models as well.		* Default GTA map objects behave inconsistently when using this function on them. If you want to replace models in the original GTA map, you need to call [[engineRestreamWorld]] after replacing models as well.
	* A raw data DFF element can only be used once, because the underlying memory for the model is released after replacement.		* A raw data DFF element can only be used once, because the underlying memory for the model is released after replacement.

Srslyyyy: Update load order info

2024-12-12T12:47:14Z

Update load order info

← Older revision		Revision as of 12:47, 12 December 2024
Line 8:		Line 8:
	To replace weapon models you must use their object IDs, not weapon IDs. There is a weapon model list available at [[weapons]].		To replace weapon models you must use their object IDs, not weapon IDs. There is a weapon model list available at [[weapons]].
	{{Note\|		{{Note\|
	* Follow loading order ('''COL''' -> '''TXD''' -> '''DFF''') that is used in the example as other orders can cause collisions, textures or the DFF not to load due to technical limitations.		* Follow loading order ('''COL''' -> '''TXD''' -> '''DFF''') that is used in the example - as other orders can cause collisions, textures or the DFF not to load due to technical limitations.
	* Default GTA map objects behave inconsistently when using this function on them. If you want to replace models in the original GTA map, you need to call [[engineRestreamWorld]] after replacing models as well.		* Default GTA map objects behave inconsistently when using this function on them. If you want to replace models in the original GTA map, you need to call [[engineRestreamWorld]] after replacing models as well.
	* A raw data DFF element can only be used once, because the underlying memory for the model is released after replacement.		* A raw data DFF element can only be used once, because the underlying memory for the model is released after replacement.

Srslyyyy: Update load order info

2024-12-12T12:46:37Z

Update load order info

← Older revision		Revision as of 12:46, 12 December 2024
Line 8:		Line 8:
	To replace weapon models you must use their object IDs, not weapon IDs. There is a weapon model list available at [[weapons]].		To replace weapon models you must use their object IDs, not weapon IDs. There is a weapon model list available at [[weapons]].
	{{Note\|		{{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.		* Follow loading order ('''COL''' -> '''TXD''' -> '''DFF''') that is used in the example as other orders can cause collisions, textures or the DFF not to load due to technical limitations.
	* Default GTA map objects behave inconsistently when using this function on them. If you want to replace models in the original GTA map, you need to call [[engineRestreamWorld]] after replacing models as well.		* Default GTA map objects behave inconsistently when using this function on them. If you want to replace models in the original GTA map, you need to call [[engineRestreamWorld]] after replacing models as well.
	* A raw data DFF element can only be used once, because the underlying memory for the model is released after replacement.		* A raw data DFF element can only be used once, because the underlying memory for the model is released after replacement.

Srslyyyy at 12:43, 12 December 2024

2024-12-12T12:43:01Z

← Older revision		Revision as of 12:43, 12 December 2024
Line 9:		Line 9:
	{{Note\|		{{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.		* 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.
	* Default GTA map objects behave inconsistently when using this function on them. If you want to replace models in the original GTA map, you need to ~~use~~ [[engineRestreamWorld]] after replacing models as well.		* Default GTA map objects behave inconsistently when using this function on them. If you want to replace models in the original GTA map, you need to call [[engineRestreamWorld]] after replacing models as well.
	* A raw data DFF element can only be used once, because the underlying memory for the model is released after replacement.		* A raw data DFF element can only be used once, because the underlying memory for the model is released after replacement.
	* If the replacement model is broken and the original model is not loaded/streamed-in at the time of replacement, this function will succeed and you won't see any error message, neither when the model replacement fails once the original model starts to load/stream-in.}}		* If the replacement model is broken and the original model is not loaded/streamed-in at the time of replacement, this function will succeed and you won't see any error message, neither when the model replacement fails once the original model starts to load/stream-in.}}

Srslyyyy: Replace hacky workarounds with engineRestreamWorld

2024-12-12T12:42:14Z

Replace hacky workarounds with engineRestreamWorld

← Older revision		Revision as of 12:42, 12 December 2024
Line 9:		Line 9:
	{{Note\|		{{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.		* 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.
	* Default GTA map objects behave inconsistently when using this function on them. If you want to replace models in the original GTA map, use ~~one of the~~ [[~~EngineReplaceModel notes\|methods shown here~~]].		* Default GTA map objects behave inconsistently when using this function on them. If you want to replace models in the original GTA map, you need to use [[engineRestreamWorld]] after replacing models as well.
	* A raw data DFF element can only be used once, because the underlying memory for the model is released after replacement.		* A raw data DFF element can only be used once, because the underlying memory for the model is released after replacement.
	* If the replacement model is broken and the original model is not loaded/streamed-in at the time of replacement, this function will succeed and you won't see any error message, neither when the model replacement fails once the original model starts to load/stream-in.}}		* If the replacement model is broken and the original model is not loaded/streamed-in at the time of replacement, this function will succeed and you won't see any error message, neither when the model replacement fails once the original model starts to load/stream-in.}}

Srslyyyy: /* Example */

2024-08-02T21:35:29Z

Example

← Older revision		Revision as of 21:35, 2 August 2024
Line 75:		Line 75:
	local modelID = modelData.modelID		local modelID = modelData.modelID

	if modelCol then		if (modelCol) then
	local colData = engineLoadCOL(modelCol)		local colData = engineLoadCOL(modelCol)

	if colData then		if (colData) then
	engineReplaceCOL(colData, modelID)		engineReplaceCOL(colData, modelID)
	end		end
	end		end

	if modelTxd then		if (modelTxd) then
	local filteringEnabled = modelData.filteringEnabled		local filteringEnabled = modelData.filteringEnabled
	local txdData = engineLoadTXD(modelTxd, filteringEnabled)		local txdData = engineLoadTXD(modelTxd, filteringEnabled)

	if txdData then		if (txdData) then
	engineImportTXD(txdData, modelID)		engineImportTXD(txdData, modelID)
	end		end
	end		end

	if modelDff then		if (modelDff) then
	local dffData = engineLoadDFF(modelDff)		local dffData = engineLoadDFF(modelDff)

	if dffData then		if (dffData) then
	local alphaTransparency = modelData.alphaTransparency		local alphaTransparency = modelData.alphaTransparency