EngineUnloadModel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(added {{Client function}})
No edit summary
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__  
__NOTOC__  
{{Deprecated}}
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.



Revision as of 17:27, 24 June 2010


Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions, but there should be a more generic way to perform what it does.

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", 0 )
engineImportCOL ( col_floors, 3781 )
engineReplaceObjectModel ( dff_floors, 3781 )

-- do your logic

engineUnloadModel ( 3781 )

See Also