EngineRestoreAnimation: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Client function}} This function restores internal (default) animations that were replaced using engineReplaceAnimation function. This fu...") |
(Restored version transclusion) |
||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{New feature/item|3.0156|1.5.5|12195| | |||
This function restores internal (default) animations that were replaced using [[EngineReplaceAnimation|engineReplaceAnimation]] function. This function only affects a specific [[player]] or [[ped]] just like [[EngineReplaceAnimation|engineReplaceAnimation]]. | This function restores internal (default) animations that were replaced using [[EngineReplaceAnimation|engineReplaceAnimation]] function. This function only affects a specific [[player]] or [[ped]] just like [[EngineReplaceAnimation|engineReplaceAnimation]]. | ||
If only 1st parameter ([[Ped|ped]]) is provided to this function, all replaced animations are restored. | If only 1st parameter ([[Ped|ped]]) is provided to this function, all replaced animations are restored. | ||
If block name is also provided for 2nd parameter, then replaced animations within that block are restored. | If block name is also provided for 2nd parameter, then replaced animations within that block are restored. | ||
If 3rd parameter (animation name) is provided, then only that specific animation within that specific block is restored. | If 3rd parameter (animation name) is provided, then only that specific animation within that specific block is restored.}} | ||
==Syntax== | ==Syntax== | ||
| Line 14: | Line 15: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''thePed:''' the [[player]] or [[ped]] you want to restore an animation(s) for. | *'''thePed:''' the [[player]] or [[ped]] you want to restore an animation(s) for. | ||
===Optional Arguments=== | |||
{{OptionalArg}} | |||
*'''InternalBlockName:''' the [[Animations|internal block]] name. | *'''InternalBlockName:''' the [[Animations|internal block]] name. | ||
*'''InternalAnimName:''' the [[Animations|internal animation]] name inside InternalBlockName. | *'''InternalAnimName:''' the [[Animations|internal animation]] name inside InternalBlockName. | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' on success, ''false'' in case of failure. | Returns ''true'' on success, ''false'' in case of failure. | ||
==Example== | ==Example== | ||
'''Example 1:''' This example restores all replaced animations within every block for the local player. | |||
<syntaxhighlight lang="lua"> | |||
engineRestoreAnimation( localPlayer ) | |||
</syntaxhighlight> | |||
'''Example 2:''' This example restores all replaced animations only within "ped" block for the local player. | |||
<syntaxhighlight lang="lua"> | |||
engineRestoreAnimation( localPlayer, "ped" ) | |||
</syntaxhighlight> | |||
'''Example 3:''' This example restores "weapon_crouch" animation within "ped" block for the local player. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
engineRestoreAnimation( localPLayer, "ped", "weapon_crouch" ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Engine_functions}} | {{Engine_functions}} | ||
Latest revision as of 17:55, 18 July 2018
This function restores internal (default) animations that were replaced using engineReplaceAnimation function. This function only affects a specific player or ped just like engineReplaceAnimation.
If only 1st parameter (ped) is provided to this function, all replaced animations are restored. If block name is also provided for 2nd parameter, then replaced animations within that block are restored. If 3rd parameter (animation name) is provided, then only that specific animation within that specific block is restored.
Syntax
bool engineRestoreAnimation ( ped thePed [, string InternalBlockName, string InternalAnimName ] )
Required Arguments
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
- InternalBlockName: the internal block name.
- InternalAnimName: the internal animation name inside InternalBlockName.
Returns
Returns true on success, false in case of failure.
Example
Example 1: This example restores all replaced animations within every block for the local player.
engineRestoreAnimation( localPlayer )
Example 2: This example restores all replaced animations only within "ped" block for the local player.
engineRestoreAnimation( localPlayer, "ped" )
Example 3: This example restores "weapon_crouch" animation within "ped" block for the local player.
engineRestoreAnimation( localPLayer, "ped", "weapon_crouch" )
See Also
- engineAddImage
- engineApplyShaderToWorldTexture
- engineFreeModel
- engineGetModelFlags
- engineGetModelIDFromName
- engineGetModelLODDistance
- engineGetModelNameFromID
- engineGetModelPhysicalPropertiesGroup
- engineGetModelTextureNames
- engineGetModelTextures
- engineGetModelTXDID
- engineGetModelVisibleTime
- engineGetObjectGroupPhysicalProperty
- engineGetSurfaceProperties
- engineGetVisibleTextureNames
- engineImageGetFilesCount
- engineImageGetFiles
- engineImageGetFile
- engineImageLinkDFF
- engineImageLinkTXD
- engineImportTXD
- engineLoadCOL
- engineLoadDFF
- engineLoadIMG
- engineLoadIFP
- engineLoadTXD
- engineRemoveImage
- engineRemoveShaderFromWorldTexture
- engineReplaceAnimation
- engineReplaceCOL
- engineReplaceModel
- engineRequestModel
- engineResetModelFlags
- engineResetModelLODDistance
- engineResetSurfaceProperties
- engineRestoreAnimation
- engineRestoreCOL
- engineRestoreDFFImage
- engineRestoreModel
- engineRestoreModelPhysicalPropertiesGroup
- engineRestoreObjectGroupPhysicalProperties
- engineRestoreTXDImage
- engineRestreamWorld
- engineSetAsynchronousLoading
- engineSetModelFlag
- engineSetModelFlags
- engineSetModelLODDistance
- engineSetModelPhysicalPropertiesGroup
- engineSetModelVisibleTime
- engineSetObjectGroupPhysicalProperty
- engineSetSurfaceProperties
- engineStreamingFreeUpMemory
- engineStreamingGetUsedMemory