EngineLoadCOL: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Client function}} | {{Client function}} | ||
__NOTOC__ | __NOTOC__ | ||
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. | 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. | ||
Line 7: | Line 7: | ||
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. | ||
{{Note|Collision libraries (.col files containing multiple collision models) are not supported. See [[COL]] for details. Or you can try [[engineGetCOLsFromLibrary]], if you'd like.}} | {{Note| | ||
* Follow loading order ('''COL''' -> '''TXD''' -> '''DFF''') which is used in the example - as other orders can cause collisions, textures or the DFF not to load due to technical limitations. | |||
* Collision libraries (.col files containing multiple collision models) are not supported. See [[COL]] for details. Or you can try [[engineGetCOLsFromLibrary]], if you'd like.}} | |||
==Syntax== | ==Syntax== |
Latest revision as of 12:55, 12 December 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
See unified example available in engineReplaceModel.
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