EngineReplaceCOL: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 7: Line 7:
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool engineReplaceCOL ( col theCol, number modelID )
bool engineReplaceCOL ( col theCol, int modelID )
</syntaxhighlight>  
</syntaxhighlight>  



Revision as of 09:40, 25 March 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.

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