EngineReplaceModel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}<!-- Change this to "Client function" or "Server function" appropriately-->
{{Client function}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
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.
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.


==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool engineReplaceModel ( dff theModel, number modelID )
bool engineReplaceModel ( dff theModel, number modelID )
Line 11: Line 9:


===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''theModel:''' The model to replace the given model ID with
*'''theModel:''' The model to replace the given model ID with
*'''modelID:''' The model it to replace the model of
*'''modelID:''' The model it to replace the model of


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
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.
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.


Line 31: Line 27:


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{Engine_functions}}
{{Engine_functions}}
[[Category:Needs_Example]] <!-- leave this until the example is completed. -->

Revision as of 16:18, 3 January 2008

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.

Syntax

bool engineReplaceModel ( dff theModel, number modelID )

Required Arguments

  • theModel: The model to replace the given model ID with
  • modelID: The model it to replace the model of

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

This example replaces a vehicle model. 

outputChatBox ( "> replacing the euros vehicle" )

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

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/EngineReplaceModel?oldid=14409"