EngineLoadCOL: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Added links to COL)
Line 3: Line 3:
This function loads a RenderWare Collision (COL3) file into GTA. The collisions can then be used to provide collisions for in-game objects.
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]].
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.
This is a client side function. Be sure to transfer your COL file by including it in the meta file.
Line 13: Line 13:


===Required Arguments===  
===Required Arguments===  
*'''col_file:''' The relative path to the col file you want to load
*'''col_file:''' The relative path to the [[COL]] file you want to load


===Returns===
===Returns===
Returns a ''col'' object if the file was loaded, ''false'' otherwise.
Returns a [[COL]] if the file was loaded, ''false'' otherwise.


==Example==  
==Example==  
Line 28: Line 28:
engineReplaceModel ( dff, 587 )
engineReplaceModel ( dff, 587 )
</syntaxhighlight>
</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.
'''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.
Line 40: Line 39:
engineReplaceModel ( dff_floors, 3781 )
engineReplaceModel ( dff_floors, 3781 )
</syntaxhighlight>
</syntaxhighlight>


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

Revision as of 23:16, 21 November 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 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" )

txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 587 )
engineReplaceModel ( 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 )
engineReplaceModel ( dff_floors, 3781 )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/EngineLoadCOL?oldid=13218"