Difference between revisions of "EngineLoadIFP"

From Multi Theft Auto: Wiki
Jump to: navigation, search
m
Line 1: Line 1:
 
{{Client function}}
 
{{Client function}}
{{Disabled|Function disabled because it was unstable|4571}}
+
 
 
__NOTOC__
 
__NOTOC__
This function loads an animation library (IFP) file into GTA.
+
ifp engineLoadIFP ( string IfpFilePath, string CustomBlockName )  
* This function '''does not replace''' the default animations yet.
 
* To use this correctly, you need to use an IFP file with '''new''' animation blocks with different names than existing ones.
 
 
 
  
Be sure to transfer your IFP file by including it in the meta file.
+
This function loads an animation library (IFP) file into GTA with a custom block name. All three IFP formats are supported ANPK, ANP2, and ANP3. Unfortunately, GTA 3 animations are not supported, however, you can load GTA:VC IFP files using this function. You don't have to replace any animation to play a custom one, to play a custom animation, load the IFP file using this function, then use [[SetPedAnimation|setPedAnimation]].
  
 +
To unload the IFP file, use [[DestroyElement|destroyElement]], restarting or stopping the resource can also unload the IFP file automatically.
 
==Syntax==  
 
==Syntax==  
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
ifp engineLoadIFP ( string ifp_file )  
+
ifp engineLoadIFP ( string IfpFilePath, string CustomBlockName )
 
</syntaxhighlight>  
 
</syntaxhighlight>  
  
 
===Required Arguments===  
 
===Required Arguments===  
*'''ifp_file:''' The [[filepath]] to the IFP file you want to load
+
*'''IfpFilePath:''' the [[filepath|file path]] to the IFP file you want to load.
 +
*'''CustomBlockName:''' the new block name for the IFP file.
  
 
===Returns===
 
===Returns===

Revision as of 18:47, 18 June 2018


ifp engineLoadIFP ( string IfpFilePath, string CustomBlockName )

This function loads an animation library (IFP) file into GTA with a custom block name. All three IFP formats are supported ANPK, ANP2, and ANP3. Unfortunately, GTA 3 animations are not supported, however, you can load GTA:VC IFP files using this function. You don't have to replace any animation to play a custom one, to play a custom animation, load the IFP file using this function, then use setPedAnimation.

To unload the IFP file, use destroyElement, restarting or stopping the resource can also unload the IFP file automatically.

Syntax

ifp engineLoadIFP ( string IfpFilePath, string CustomBlockName )

Required Arguments

  • IfpFilePath: the file path to the IFP file you want to load.
  • CustomBlockName: the new block name for the IFP file.

Returns

Returns an IFP element if the IFP file loaded, false otherwise.

Example

Click to collapse [-]
animation.lua
function setanimation()
  if engineLoadIFP("data/ani.ifp") then
    setPedAnimation(getLocalPlayer(), "ANIMATIONBLOCK", "animation1")
  end
end

addCommandHandler("animation", setanimation)
Click to collapse [-]
meta.xml
<meta>
  <info author="lukry" version="1.0" type="script" />

  <script src="animation.lua" type="client" />
  <file src="data/ani.ifp" />
</meta>

See Also

FROM VERSION 1.5.6 r16365 ONWARDS