EngineUnloadModel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ This function "unloads" a custom model identified by a model id, and reloads the original GTA model. ==Syntax== <syntaxhighlight lang="lua"> bool engineUnloadModel ( model_id ) </syntaxhighlight> ==...)
 
No edit summary
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Deprecated|engineRestoreModel|}}
This function "unloads" a custom model identified by a model id, and reloads the original GTA model.
This function "unloads" a custom model identified by a model id, and reloads the original GTA model.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool engineUnloadModel ( model_id )  
bool engineUnloadModel ( int model_id )  
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''model_id:''' The model id used to identify the model that is being reloaded
*'''model_id:''' The model id used to identify the model that is being reloaded.


===Returns===
===Returns===
Returns ''true'' if the function executed succesfully, ''false'' otherwise.
Returns ''true'' if the custom model was unloaded succesfully, ''false'' otherwise.


==Example==  
==Example==  
This example loads a combination of custom DFF, TXD and COL files to replace an in-game model of a set of floors and unloads it again.
<syntaxhighlight lang="lua">
outputChatBox ( "> loading floor objects" )
txd_floors = engineLoadTXD ( "models/office_floors.txd" )
engineImportTXD ( txd_floors, 3781 )
col_floors = engineLoadCOL ( "models/office_floors.col" )
dff_floors = engineLoadDFF ( "models/office_floors.dff" )
engineImportCOL ( col_floors, 3781 )
engineReplaceObjectModel ( dff_floors, 3781 )
-- do your logic
engineUnloadModel ( 3781 )
</syntaxhighlight>


==See Also==
==See Also==
{{Engine_functions}}
{{Engine_functions}}

Latest revision as of 07:10, 30 May 2015

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use engineRestoreModel instead.


This function "unloads" a custom model identified by a model id, and reloads the original GTA model.

Syntax

bool engineUnloadModel ( int model_id )

Required Arguments

  • model_id: The model id used to identify the model that is being reloaded.

Returns

Returns true if the custom model was unloaded succesfully, false otherwise.

Example

This example loads a combination of custom DFF, TXD and COL files to replace an in-game model of a set of floors and unloads it again. 

outputChatBox ( "> loading floor objects" )
txd_floors = engineLoadTXD ( "models/office_floors.txd" )
engineImportTXD ( txd_floors, 3781 )
col_floors = engineLoadCOL ( "models/office_floors.col" )
dff_floors = engineLoadDFF ( "models/office_floors.dff" )
engineImportCOL ( col_floors, 3781 )
engineReplaceObjectModel ( dff_floors, 3781 )

-- do your logic

engineUnloadModel ( 3781 )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/EngineUnloadModel?oldid=45260"