EngineLoadCOL: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 6: Line 6:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool engineLoadCOL ( string col_file )
txd engineLoadCOL ( string col_file )  
</syntaxhighlight>  
</syntaxhighlight>  


Line 13: Line 13:


===Returns===
===Returns===
Returns ''true'' if the function executed succesfully, ''false'' otherwise.
Returns a ''col'' object if the file was loaded, ''false'' otherwise.


==Example==  
==Example==  
<syntaxhighlight lang="lua">
* See [[engineReplaceVehicleModel]] for a vehicle replacement example
-- example pending, please see models/carrier/bastage_hq resources
* See [[engineReplaceObjectModel]] for an object replacement example
</syntaxhighlight>


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

Revision as of 22:05, 9 June 2007

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

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

See Also