EngineReplaceCOL: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 3: Line 3:
This function replaces the collision file of the given model id to the collision file passed. Use [[engineLoadCOL]] to load the collision file first.
This function replaces the collision file of the given model id to the collision file passed. Use [[engineLoadCOL]] to load the collision file first.


'''Note:''' collision libraries (.col files containing multiple collision models) are not supported at the moment.
'''Note:''' collision libraries (.col files containing multiple collision models) are not supported. See [[COL]] for details.


==Syntax==  
==Syntax==  

Revision as of 21:28, 20 May 2009

This function replaces the collision file of the given model id to the collision file passed. Use engineLoadCOL to load the collision file first.

Note: collision libraries (.col files containing multiple collision models) are not supported. See COL for details.

Syntax

bool engineReplaceCOL ( col theCol, int modelID )

Required Arguments

  • theCol: The collision file to replace with
  • modelID: The model ID whose collision file you want to replace

Returns

Returns true if the collision was successfully replaced, false or nil if the collision could not be replaced for a reason.

Example

Click to collapse [-]
Client

Client-Side example for replacing object collision with custom one.

function ReplaceCollision ( )
outputChatBox ( "> Replacing Collision Data." )
col = engineLoadCOL( "myColFile.col" )
engineReplaceCOL( col, 3356 )
end

addEvent ( "collisionReplace", true )
addEventHandler ( "collisionReplace", getRootElement(), ReplaceCollision )


Click to collapse [-]
Server

Server-side example function for triggering the replace.

function ReplaceCols ( )
triggerClientEvent ( "collisionReplace", getRootElement(), collisionReplace )
end
addCommandHandler("replacecol", ReplaceCols)

See Also