Difference between revisions of "EngineReplaceCOL"

From Multi Theft Auto: Wiki
m (prefer normal note)
 
Line 1: Line 1:
 
__NOTOC__  
 
__NOTOC__  
 
{{Client function}}
 
{{Client function}}
{{Note box|Please note the loading order that is used in the examples as other orders can cause collisions, textures or the DFF not to load due to technical limitations}}
+
{{Note|Please note the loading order that is used in the examples as other orders can cause collisions, textures or the DFF not to load due to technical limitations}}
  
 
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.

Latest revision as of 08:36, 7 September 2019

[[{{{image}}}|link=]] Note: Please note the loading order that is used in the examples as other orders can cause collisions, textures or the DFF not to load due to technical limitations

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

[[{{{image}}}|link=]] Note: Collision libraries (.col files containing multiple collision models) are not supported. See COL for details. Object models are supported only (no vehicles or players).

Syntax

bool engineReplaceCOL ( col theCol, int modelID )

OOP Syntax Help! I don't understand this!

Method: col:replace(...)

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", root, ReplaceCollision )


Click to collapse [-]
Server

Server-side example function for triggering the replace.

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

See Also

BETA: FROM VERSION 1.5.7 r19626 ONWARDS
BETA: FROM VERSION 1.5.7 r20147 ONWARDS
BETA: FROM VERSION 1.5.7 r20416 ONWARDS
BETA: FROM VERSION 1.5.7 r20383 ONWARDS
BETA: FROM VERSION 1.5.7 r20477 ONWARDS