Difference between revisions of "EngineRestoreModel"

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
 
(9 intermediate revisions by 8 users not shown)
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 engineRestoreModel ( number modelID )
+
bool engineRestoreModel ( int modelID )
 
</syntaxhighlight>  
 
</syntaxhighlight>  
 
+
{{OOP||Engine.restoreModel}}
 
===Required Arguments===  
 
===Required Arguments===  
 
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
 
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
Line 20: Line 20:
 
==Example==  
 
==Example==  
 
<!-- Explain what the example is in a single sentance -->
 
<!-- Explain what the example is in a single sentance -->
This example does...
 
 
<!-- 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 -->
 
<!-- 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 -->
 
<section name="Client" class="client" show="true">
 
<section name="Client" class="client" show="true">
Line 26: Line 25:
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
function ResetModel ( )
 
function ResetModel ( )
engineRestoreModel ( 587 )  -- Object / Vehicle to restore to default GTA one.
+
    engineRestoreModel ( 587 )  -- Object / Vehicle to restore to default GTA one.
 
end
 
end
  
 
addEvent ( "restoreClientModel", true )
 
addEvent ( "restoreClientModel", true )
addEventHandler ( "restoreClientModel", getRootElement(), ResetModel )
+
addEventHandler ( "restoreClientModel", root, ResetModel )
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</section>
 
</section>
Line 39: Line 38:
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
function RestoreModel ( )
 
function RestoreModel ( )
triggerClientEvent ( "restoreClientModel", getRootElement(), restoreClientModel )
+
    triggerClientEvent ( "restoreClientModel", root, restoreClientModel )
 
end
 
end
 
 
addCommandHandler( "restore", RestoreModel )
 
addCommandHandler( "restore", RestoreModel )
 
</syntaxhighlight>
 
</syntaxhighlight>
Line 49: Line 47:
 
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
 
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
 
{{Engine_functions}}
 
{{Engine_functions}}
[[Category:Needs_Example]] <!-- leave this until the example is completed. -->
 

Latest revision as of 09:45, 14 October 2015

This function restores the visual DFF model of the given model ID. This restores the result of engineReplaceModel.

Syntax

bool engineRestoreModel ( int modelID )

OOP Syntax Help! I don't understand this!

Method: Engine.restoreModel(...)

Required Arguments

  • modelID: The model ID to restore the visuals of

Returns

Returns true if the model was successfully restored, false or nil if it failed for some reason.

Example

Click to collapse [-]
Client

Client-Side example for restoring model / vehicle.

function ResetModel ( )
    engineRestoreModel ( 587 )  -- Object / Vehicle to restore to default GTA one.
end

addEvent ( "restoreClientModel", true )
addEventHandler ( "restoreClientModel", root, ResetModel )


Click to collapse [-]
Server

Server-Side example for triggering model / vehicle restore function with "restore" command.

function RestoreModel ( )
    triggerClientEvent ( "restoreClientModel", root, restoreClientModel )
end
addCommandHandler( "restore", RestoreModel )

See Also

BETA: FROM VERSION 1.5.8 r20704 ONWARDS
BETA: FROM VERSION 1.5.8 r20704 ONWARDS
BETA: FROM VERSION 1.5.8 r20704 ONWARDS