EngineImportCOL: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
(11 intermediate revisions by 9 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | |||
{{Deprecated|engineReplaceCOL|}} | |||
This function imports a RenderWare Collision into the model identified by the model id. This function does not replace the collisions of all models of this type in-game. | This function imports a RenderWare Collision into the model identified by the model id. This function does not replace the collisions of all models of this type in-game. | ||
To ensure proper replacement, please do not use this function for vehicles. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool engineImportCOL ( col, | bool engineImportCOL ( col theCol, int model_id ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''col:''' The COL that was loaded with [[engineLoadCOL]] | ||
*'''model_id:''' The model id to import the COL into | *'''model_id:''' The model id to import the COL into | ||
Line 15: | Line 20: | ||
==Example== | ==Example== | ||
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" ) | |||
engineImportCOL ( col_floors, 3781 ) | |||
engineReplaceModel ( dff_floors, 3781 ) | |||
</syntaxhighlight> | |||
==See Also== | ==See Also== | ||
{{Engine_functions}} | {{Engine_functions}} |
Latest revision as of 12:40, 5 August 2021
This function is deprecated. This means that its use is discouraged and that it might not exist in future versions. | |
Please use engineReplaceCOL instead. |
This function imports a RenderWare Collision into the model identified by the model id. This function does not replace the collisions of all models of this type in-game.
To ensure proper replacement, please do not use this function for vehicles.
Syntax
bool engineImportCOL ( col theCol, int model_id )
Required Arguments
- col: The COL that was loaded with engineLoadCOL
- model_id: The model id to import the COL into
Returns
Returns true if the function executed succesfully, false otherwise.
Example
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" ) engineImportCOL ( col_floors, 3781 ) engineReplaceModel ( dff_floors, 3781 )
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