EngineImportCOL: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Visual improvement)
m (Changed "DeprecatedWithAlt" template to "Deprecated" and removed nonsensical example)
Line 1: Line 1:
__NOTOC__
{{Client function}}
{{Client function}}
__NOTOC__
{{Deprecated|engineReplaceCOL|}}
{{DeprecatedWithAlt|engineReplaceCOL|}}


This function imports a RenderWare Collision into the model identified by the model id. This function does not replace the collisions of all models of this type in-game.
This function imports a RenderWare Collision into the model identified by the model id. This function does not replace the collisions of all models of this type in-game.
Line 20: Line 20:


==Example==  
==Example==  
'''Example 1:''' This example loads a combination of a custom DFF and TXD file to replace the Euros vehicle in-game. The collisions are embedded inside the DFF file.
This example loads a combination of custom DFF, TXD and COL files to replace an in-game model of a set of floors.
<syntaxhighlight lang="lua">
outputChatBox ( "> replacing the euros vehicle" )
 
txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 587 )
engineReplaceModel ( dff, 587 )
</syntaxhighlight>
 
 
'''Example 2:''' This example loads a combination of custom DFF, TXD and COL files to replace an in-game model of a set of floors.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
outputChatBox ( "> loading floor objects" )
outputChatBox ( "> loading floor objects" )

Revision as of 16:30, 13 February 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 engineReplaceCOL instead.


This function imports a RenderWare Collision into the model identified by the model id. This function does not replace the collisions of all models of this type in-game.

To ensure proper replacement, please do not use this function for vehicles.

Syntax

bool engineImportCOL ( col, int model_id ) 

Required Arguments

  • col: The COL that was loaded with engineLoadCOL
  • model_id: The model id to import the COL into

Returns

Returns true if the function executed 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.

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 )
engineReplaceModel ( dff_floors, 3781 )

See Also