EngineReplaceModel

2013-07-09T09:03:07Z

Tren:

__NOTOC__
{{Client function}}
{{Note box|Please note the loading order that is used in the examples as other orders can cause textures, collisions or the DFF not to load due to technical limitations}}

This function replaces the given model in the given model ID with the DFF file passed. This function supports vehicles and objects at the moment.

As of 1.1.1 This supports Ped and Weapon models. For replace weapon models you can't use weapon ID's, you should use object ID's. All weapon model ID's here: [[Weapons]].

Note: Due to a bug, when replacing models with built in collisions (i.e. vehicles), the collision may not get replaced correctly. The current work around is to load the dff again and do another replace after a short delay.

==Syntax==
<syntaxhighlight lang="lua">
bool engineReplaceModel ( dff theModel, int modelID [, bool alphaTransparency = false ] )
</syntaxhighlight>

===Required Arguments===
*'''theModel:''' The model to replace the given model ID with
*'''modelID:''' The model it to replace the model of

===Optional Arguments===
*'''alphaTransparency:''' Set to true to enable special thing

===Returns===
Returns ''true'' if the model was successfully replaced, ''false'' if it failed for some reason, ie. the DFF or the model ID is not valid.

==Example==
'''Example 1:'''
<section name="Client" class="client" show="true">
Client-Side example for replacing vehicle model and texture with custom ones.
<syntaxhighlight lang="lua">
function ReplaceVehicle ( )
outputChatBox ( "> replacing the euros vehicle" )

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

addEvent ( "replaceVeh", true )
addEventHandler ( "replaceVeh", getRootElement(), ReplaceVehicle )
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
Server-side example function for triggering the replace.
<syntaxhighlight lang="lua">
function ReplaceCommand ( )
triggerClientEvent( "replaceVeh", getRootElement(), replaceVeh )
end
addCommandHandler( "replace", ReplaceCommand )
</syntaxhighlight>
</section>

'''Example 2:'''
<section name="Client" class="client" show="true">
Client-Side example for replacing object model, collision and texture with custom ones.
<syntaxhighlight lang="lua">
function ReplaceObject ( )

txd = engineLoadTXD( "MyModel.txd" )
col = engineLoadCOL( "MyModel.col" )
dff = engineLoadDFF( "MyModel.dff", 0 ) --modelid is everytime 0, when you replace no vehicle

engineImportTXD( txd, 1234 )
engineReplaceCOL( col, 1234 )
engineReplaceModel( dff, 1234 )-- replace the model at least

end

addEvent ( "replaceObj", true )
addEventHandler ( "replaceObj", getRootElement(), ReplaceObject )
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
Server-side example function for triggering the replace.
<syntaxhighlight lang="lua">
function ReplaceCommand ( )
triggerClientEvent( "replaceObj", getRootElement(), replaceObj )
end
addCommandHandler( "replace", ReplaceCommand )
</syntaxhighlight>
</section>

==See Also==
{{Engine_functions}}

Multi Theft Auto: Wiki - User contributions [en]

EngineReplaceModel