Difference between revisions of "EngineLoadCOL"

From Multi Theft Auto: Wiki
m
Line 19: Line 19:
  
 
==Example==  
 
==Example==  
* See [[engineReplaceVehicleModel]] for a vehicle replacement 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.
* See [[engineReplaceObjectModel]] for an object replacement example
+
<syntaxhighlight lang="lua">
 +
outputChatBox ( "> replacing the euros vehicle" )
 +
 
 +
enginePreloadModel ( 587 )
 +
txd = engineLoadTXD ( "data/euros.txd" )
 +
engineImportTXD ( txd, 587 )
 +
dff = engineLoadDFF ( "data/euros.dff", 587 )
 +
engineReplaceVehicleModel ( 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">
 +
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 )
 +
</syntaxhighlight>
 +
 
  
 
==See Also==
 
==See Also==
 
{{Engine_functions}}
 
{{Engine_functions}}

Revision as of 14:38, 26 August 2007

This function loads a RenderWare Collision (COL3) file into GTA. The collisions can then be used to provide collisions for in-game objects.

For vehicles, please omit this function by embedding your COL file into your DFF file. This way, you can be sure that the COL file is correctly (and automatically) loaded when calling engineLoadDFF.

This is a client side function. Be sure to transfer your COL file by including it in the meta file.

Syntax

txd engineLoadCOL ( string col_file ) 

Required Arguments

  • col_file: The relative path to the col file you want to load

Returns

Returns a col object if the file was loaded, false otherwise.

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.

outputChatBox ( "> replacing the euros vehicle" )

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


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.

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 )


See Also

BETA: FROM VERSION 1.5.7 r19626 ONWARDS
BETA: FROM VERSION 1.5.7 r20147 ONWARDS
BETA: FROM VERSION 1.5.7 r20416 ONWARDS
BETA: FROM VERSION 1.5.7 r20383 ONWARDS
BETA: FROM VERSION 1.5.7 r20477 ONWARDS