EngineLoadIFP - Revision history

Qaisjp: Undo revision 64795 by Qaisjp (talk)

2019-12-21T14:49:05Z

Undo revision 64795 by Qaisjp (talk)

← Older revision		Revision as of 14:49, 21 December 2019
Line 16:		Line 16:
	===Returns===		===Returns===
	Returns an [[IFP]] element if the IFP file loaded, ''false'' otherwise.		Returns an [[IFP]] element if the IFP file loaded, ''false'' otherwise.
	{{Tip\|If you want to synchronize animations, you can check [https://drive.google.com/open?id=1L2NkQYuLS0YdoHECvxVRMdPBbEgaYUfH ifp_demo] resource}}		{{Tip\|If you want to synchronize animations, you can check [[https://drive.google.com/open?id=1L2NkQYuLS0YdoHECvxVRMdPBbEgaYUfH ifp_demo]] resource}}

	==Example==		==Example==

Qaisjp: fix ifp_demo link

2019-12-21T14:48:43Z

fix ifp_demo link

← Older revision		Revision as of 14:48, 21 December 2019
Line 16:		Line 16:
	===Returns===		===Returns===
	Returns an [[IFP]] element if the IFP file loaded, ''false'' otherwise.		Returns an [[IFP]] element if the IFP file loaded, ''false'' otherwise.
	{{Tip\|If you want to synchronize animations, you can check [[https://drive.google.com/open?id=1L2NkQYuLS0YdoHECvxVRMdPBbEgaYUfH ifp_demo]] resource}}		{{Tip\|If you want to synchronize animations, you can check [https://drive.google.com/open?id=1L2NkQYuLS0YdoHECvxVRMdPBbEgaYUfH ifp_demo] resource}}

	==Example==		==Example==

Qaisjp: namespace exampel

2019-12-21T14:48:29Z

namespace exampel

← Older revision		Revision as of 14:48, 21 December 2019
Line 34:		Line 34:

	-- you can choose any name you want, do not choose a default GTA:SA block name		-- you can choose any name you want, do not choose a default GTA:SA block name
	local customBlockName = "myNewBlock"		-- Remember to namespace your block. That's why it starts with `test.`
			local customBlockName = "test.myNewBlock"

	-- load the IFP file		-- load the IFP file

Saml1er: Rename customBlockName to custom_block_name in syntax

2019-12-20T20:09:11Z

Rename customBlockName to custom_block_name in syntax

← Older revision		Revision as of 20:09, 20 December 2019
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	ifp engineLoadIFP ( string ifp_file / string raw_data, string ~~CustomBlockName~~ )		ifp engineLoadIFP ( string ifp_file / string raw_data, string custom_block_name )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''ifp_file / raw_data:''' the [[filepath\|filepath]] to the IFP file you want to load or whole data buffer of the IFP file.		*'''ifp_file / raw_data:''' the [[filepath\|filepath]] to the IFP file you want to load or whole data buffer of the IFP file.
	*'''~~CustomBlockName~~:''' the new block name for the IFP file. You cannot use the GTA default [[Animations\|internal block]] names. '''You should namespace this name''' using a string like ''resource.blockname''		*'''custom_block_name:''' the new block name for the IFP file. You cannot use the GTA default [[Animations\|internal block]] names. '''You should namespace this name''' using a string like ''resource.blockname''

	===Returns===		===Returns===

Qaisjp at 03:53, 26 August 2018

2018-08-26T03:53:22Z

← Older revision		Revision as of 03:53, 26 August 2018
Line 12:		Line 12:
	===Required Arguments===		===Required Arguments===
	*'''ifp_file / raw_data:''' the [[filepath\|filepath]] to the IFP file you want to load or whole data buffer of the IFP file.		*'''ifp_file / raw_data:''' the [[filepath\|filepath]] to the IFP file you want to load or whole data buffer of the IFP file.
	*'''CustomBlockName:''' the new block name for the IFP file. You cannot use the GTA default [[Animations\|internal block]] names.		*'''CustomBlockName:''' the new block name for the IFP file. You cannot use the GTA default [[Animations\|internal block]] names. '''You should namespace this name''' using a string like ''resource.blockname''

	===Returns===		===Returns===

GTX: Added raw data parameter

2018-07-22T15:34:27Z

Added raw data parameter

← Older revision		Revision as of 15:34, 22 July 2018
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	ifp engineLoadIFP ( string ~~IfpFilePath~~, string CustomBlockName )		ifp engineLoadIFP ( string ifp_file / string raw_data, string CustomBlockName )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~IfpFilePath~~:''' the [[filepath\|~~file path~~]] to the IFP file you want to load.		*'''ifp_file / raw_data:''' the [[filepath\|filepath]] to the IFP file you want to load or whole data buffer of the IFP file.
	*'''CustomBlockName:''' the new block name for the IFP file. You cannot use the GTA default [[Animations\|internal block]] names.		*'''CustomBlockName:''' the new block name for the IFP file. You cannot use the GTA default [[Animations\|internal block]] names.

Saml1er: Undo revision 55707 by Saml1er (talk)

2018-07-18T17:52:12Z

Undo revision 55707 by Saml1er (talk)

← Older revision		Revision as of 17:52, 18 July 2018
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
			{{New feature/item\|3.0156\|1.5.5\|12195\|
	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]].		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]].

	If you wish to replace a GTA internal animation with a custom one, you can use [[EngineReplaceAnimation\|engineReplaceAnimation]]. To unload the IFP file, use [[DestroyElement\|destroyElement]], restarting or stopping the resource can also unload the IFP file automatically.		If you wish to replace a GTA internal animation with a custom one, you can use [[EngineReplaceAnimation\|engineReplaceAnimation]]. 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">

Saml1er: Removed version transclusion

2018-07-07T09:52:30Z

Removed version transclusion

← Older revision		Revision as of 09:52, 7 July 2018
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	~~{{New feature/item\|3.0156\|1.5.5\|12195\|~~
	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]].		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]].

	If you wish to replace a GTA internal animation with a custom one, you can use [[EngineReplaceAnimation\|engineReplaceAnimation]]. To unload the IFP file, use [[DestroyElement\|destroyElement]], restarting or stopping the resource can also unload the IFP file automatically.}}		If you wish to replace a GTA internal animation with a custom one, you can use [[EngineReplaceAnimation\|engineReplaceAnimation]]. 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">

Myonlake: /* Example */

2018-07-02T09:49:51Z

Example

← Older revision		Revision as of 09:49, 2 July 2018
Line 19:		Line 19:

	==Example==		==Example==
	~~'''Example 1:'''~~ This example loads a custom IFP file ([https://drive.google.com/file/d/1XZNNCCn7xhBNbhaIbsBubky3BEj06zWp/view?usp=sharing parkour.ifp]), adds a command "animation" that takes 1 parameter as animation name for playing animations within that IFP.		This example loads a custom IFP file ([https://drive.google.com/file/d/1XZNNCCn7xhBNbhaIbsBubky3BEj06zWp/view?usp=sharing parkour.ifp]), adds a command "animation" that takes 1 parameter as animation name for playing animations within that IFP.
	~~<section name="client.lua" class="client" show="true">~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--[[		--[[
Line 37:		Line 37:

	-- load the IFP file		-- load the IFP file
	local IFP = engineLoadIFP("parkour.ifp", customBlockName)		local IFP = engineLoadIFP( "parkour.ifp", customBlockName )

	-- let us know if IFP failed to load		-- let us know if IFP failed to load
	if not IFP then		if not IFP then
	outputChatBox("Failed to load 'parkour.ifp'")		outputChatBox( "Failed to load 'parkour.ifp'" )
	end		end

	-- execute the command using /animation <NameOfCustomAnimation>		-- execute the command using /animation <NameOfCustomAnimation>
	-- for example, /animation CartWheel		-- for example, /animation CartWheel
	function setanimation ( ~~commandName~~, animationName )		function setanimation( _, animationName )
	-- check if IFP file has loaded		-- check if IFP file has loaded
	if IFP then		if IFP then
	-- now play our custom animation		-- now play our custom animation
	setPedAnimation(localPlayer, customBlockName, animationName)		setPedAnimation( localPlayer, customBlockName, animationName )
	end		end
	end		end
	addCommandHandler ( "animation", setanimation )		addCommandHandler( "animation", setanimation )
	~~</syntaxhighlight>~~
	~~</section>~~
	~~<section name="meta.xml" class="server" show="true">~~
	~~<syntaxhighlight lang="lua">~~
	~~<meta>~~
	~~<info author="Saml1er" version="1.0.0" description="Just a simple test resource for custom ped IFP animations" />~~
	~~<file src="parkour.ifp" />~~
	~~<script src="client.lua" type="client" />~~
	~~</meta>~~
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

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

Myonlake at 00:49, 2 July 2018

2018-07-02T00:49:12Z

← Older revision		Revision as of 00:49, 2 July 2018
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	{{New feature/item\|3.0156\|1.5.5\|~~12213~~\|		{{New feature/item\|3.0156\|1.5.5\|12195\|
	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]].		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]].