EngineLoadCOL: Difference between revisions
Line 31: | Line 31: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Example 2:''' This example loads a combination of custom COL, TXD and | '''Example 2:''' This example loads a combination of custom COL, TXD and DFF 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 21:06, 29 April 2024
This function loads a RenderWare Collision (COL 1/2/3) 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
col engineLoadCOL ( string col_file / string raw_data )
OOP Syntax Help! I don't understand this!
- Method: EngineCOL(...)
Required Arguments
- col_file / raw_data: The filepath to the COL file you want to load or whole data buffer of the COL file.
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" ) local txd = engineLoadTXD ( "data/euros.txd" ) engineImportTXD ( txd, 587 ) local dff = engineLoadDFF ( "data/euros.dff" ) engineReplaceModel ( dff, 587 )
Example 2: This example loads a combination of custom COL, TXD and DFF files to replace an in-game model of a set of floors.
outputChatBox ( "> loading floor objects" ) local col_floors = engineLoadCOL ( "models/office_floors.col" ) engineReplaceCOL ( col_floors, 3781 ) local txd_floors = engineLoadTXD ( "models/office_floors.txd" ) engineImportTXD ( txd_floors, 3781 ) local dff_floors = engineLoadDFF ( "models/office_floors.dff" ) engineReplaceModel ( dff_floors, 3781 )
Changelog
Version | Description |
---|
1.4.1-9.07088 | Added option to use raw data instead of a file name |
See Also
- engineAddImage
- engineApplyShaderToWorldTexture
- engineFreeModel
- engineGetModelFlags
- engineGetModelIDFromName
- engineGetModelLODDistance
- engineGetModelNameFromID
- engineGetModelPhysicalPropertiesGroup
- engineGetModelTextureNames
- engineGetModelTextures
- engineGetModelTXDID
- engineGetModelVisibleTime
- engineGetObjectGroupPhysicalProperty
- engineGetSurfaceProperties
- engineGetVisibleTextureNames
- engineImageGetFilesCount
- engineImageGetFiles
- engineImageGetFile
- engineImageLinkDFF
- engineImageLinkTXD
- engineImportTXD
- engineLoadCOL
- engineLoadDFF
- engineLoadIMG
- engineLoadIFP
- engineLoadTXD
- engineRemoveImage
- engineRemoveShaderFromWorldTexture
- engineReplaceAnimation
- engineReplaceCOL
- engineReplaceModel
- engineRequestModel
- engineResetModelFlags
- engineResetModelLODDistance
- engineResetSurfaceProperties
- engineRestoreAnimation
- engineRestoreCOL
- engineRestoreDFFImage
- engineRestoreModel
- engineRestoreModelPhysicalPropertiesGroup
- engineRestoreObjectGroupPhysicalProperties
- engineRestoreTXDImage
- engineRestreamWorld
- engineSetAsynchronousLoading
- engineSetModelFlag
- engineSetModelFlags
- engineSetModelLODDistance
- engineSetModelPhysicalPropertiesGroup
- engineSetModelVisibleTime
- engineSetObjectGroupPhysicalProperty
- engineSetSurfaceProperties
- engineStreamingFreeUpMemory
- engineStreamingGetUsedMemory