EngineRestoreCOL: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ {{Client function}}<!-- Change this to "Client function" or "Server function" appropriately--> <!-- Describe in plain english what this function does. Don't go into details, jus...)
 
Line 19: Line 19:


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
<section name="Client" class="client" show="true">
This example does...
Client-Side example for restoring object collision with default one.
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
TODO
function RestoreCollision ( )
engineRestoreCOL ( 3356 )
end
 
addEvent ( "collisionRestore", true )
addEventHandler ( "collisionRestore", getRootElement(), RestoreCollision )
</syntaxhighlight>
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
Server-side example function for triggering the restore.
<syntaxhighlight lang="lua">
function RestoreCols ( )
triggerClientEvent ( "collisionRestore", getRootElement(), collisionRestore )
end
addCommandHandler("restorecol", RestoreCols)
</syntaxhighlight>
</section>


==See Also==
==See Also==

Revision as of 11:47, 27 January 2008

This function restores the original collision model of the given model ID. Reverses the effect of engineReplaceCOL.

Syntax

bool engineRestoreCOL ( number modelID )

Required Arguments

  • modelID: The ID of the model to restore the model of

Returns

Returns true if this function succeeds, false or nil if it fails for some reason.

Example

Click to collapse [-]
Client

Client-Side example for restoring object collision with default one.

function RestoreCollision ( )
engineRestoreCOL ( 3356 )
end

addEvent ( "collisionRestore", true )
addEventHandler ( "collisionRestore", getRootElement(), RestoreCollision )


Click to collapse [-]
Server

Server-side example function for triggering the restore.

function RestoreCols ( )
triggerClientEvent ( "collisionRestore", getRootElement(), collisionRestore )
end
addCommandHandler("restorecol", RestoreCols)

See Also