EngineLoadDFF: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 9: Line 9:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool engineLoadDFF ( string dff_file, [number model_id] )  
dff engineLoadDFF ( string dff_file, [number model_id] )  
</syntaxhighlight>  
</syntaxhighlight>  


Line 19: Line 19:


===Returns===
===Returns===
Returns ''true'' if the function executed succesfully, ''false'' otherwise.
Returns a ''dff'' object if the dff file loaded, ''false'' otherwise.


==Example==  
==Example==  
<syntaxhighlight lang="lua">
* See [[engineReplaceVehicleModel]] for a vehicle replacement example
-- example pending, please see models/carrier/bastage_hq resources
* See [[engineReplaceObjectModel]] for an object replacement example
</syntaxhighlight>


==See Also==
==See Also==
{{Engine_functions}}
{{Engine_functions}}

Revision as of 22:03, 9 June 2007

This function loads a RenderWare Model (DFF) file into GTA.

  • To successfully load vehicle models, it is necessary to pass the vehicle model id to the function so any embedded DFF extensions (such as collisions) will be loaded correctly.
  • To successfully load your model with textures, be sure to use engineLoadTXD and engineImportTXD before calling this function.

This is a client-side function. Be sure to transfer your DFF file by including it in the meta file.

Syntax

dff engineLoadDFF ( string dff_file, [number model_id] ) 

Required Arguments

  • dff_file: The relative path to the dff file you want to load

Optional Arguments

  • model_id: The model id that should be associated with the dff, when loading a vehicle. Always pass 0 (or nothing at all) if you are replacing something else than a vehicle.

Returns

Returns a dff object if the dff file loaded, false otherwise.

Example

See Also